From 2f7cc7a7fde3a62c317a97444f78f862c5be943e Mon Sep 17 00:00:00 2001
From: vlobzakov <39057925+vlobzakov@users.noreply.github.com>
Date: Thu, 21 Jan 2021 16:27:40 +0200
Subject: [PATCH] JE-54435. Placeholder ${event.params.auto} added
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Placeholder ${event.params.auto} allows to detect whether autoscaling is enabled("auto":"true") or not"auto":"false".
It is defined for events:
▪ onBeforeChangeTopology
▪ onAfterChangeTopology
▪ onBeforeScaleOut
▪ onAfterScaleOut
▪ onBeforeScaleIn
▪ onAfterScaleIn
▪ onBeforeServiceScaleOut
▪ onAfterServiceScaleOut
---
docs/creating-manifest/events.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/docs/creating-manifest/events.md b/docs/creating-manifest/events.md
index d3edb498..bb0c0979 100644
--- a/docs/creating-manifest/events.md
+++ b/docs/creating-manifest/events.md
@@ -114,6 +114,7 @@ The event is executed before changing environment topology via the Jelastic dash
- `appid` - environment unique appid
- `nodes` - nodes array with detailed info about the topology change
- `env` - environment settings, e.g. *engine, ssl, ha, region* etc
+ - `auto` *[boolean]* - detects whether autoscaling is enabled or not
- `${event.response.}` parameters are absent
### onAfterChangeTopology
@@ -127,6 +128,7 @@ The event is executed once the *changeTopology* action is finished.
- `appid` - environment unique appid
- `nodes` - nodes array with detailed info about the topology change
- `env` - environment settings, e.g. *engine, ssl, ha, region* etc
+ - `auto` *[boolean]* - detects whether autoscaling is enabled or not
- `${event.response.}`:
- `result` - result code. The successful action result is *'0"*
- `envGroups` - environment groups array
@@ -150,6 +152,7 @@ The event is executed before adding new node(s) (i.e. scaling *out*) to the exis
- `${event.params.}`:
- `count` - number of nodes that are added
- `nodeGroup` - node group that is scaled out
+ - `auto` *[boolean]* - detects whether autoscaling is enabled or not
- `${event.response.}` parameters are absent
### onAfterScaleOut
@@ -161,6 +164,7 @@ The event is executed after adding new node(s) to the existing node group. The *
- `${event.params.}`:
- `count` - number of nodes that are added
- `nodeGroup` - node group that is scaled out
+ - `auto` *[boolean]* - detects whether autoscaling is enabled or not
- `${event.response.}`:
- `nodes` - nodes array with detailed info about topology. Explore the full list of available node placeholders.
@@ -173,6 +177,7 @@ The event is executed before removing node(s) (i.e. scaling *in*) from the targe
- `${event.params.}`:
- `count` - number of nodes that are removed
- `nodeGroup` - node group that is scaled in
+ - `auto` *[boolean]* - detects whether autoscaling is enabled or not
- `${event.response.}`:
- `nodes` - nodes array with detailed info about topology. Explore the full list of available node placeholders.
@@ -185,6 +190,7 @@ The event is executed after scaling *in* the corresponding node group. The *onAf
- `${event.params.}`:
- `count` - number of nodes that are removed
- `nodeGroup` - node group that is scaled in
+ - `auto` *[boolean]* - detects whether autoscaling is enabled or not
- `${event.response.}`:
- `nodes` - nodes array with detailed info about topology. Explore the full list of available node placeholders.
@@ -197,6 +203,7 @@ The event is executed before adding new Docker container(s) to the existing node
- `${event.params.}`:
- `count` - nodes count which have been added
- `nodeGroup` - node layer where event is executed
+ - `auto` *[boolean]* - detects whether autoscaling is enabled or not
- `${event.response.}`:
- `nodes` - nodes array which will be added to the environment. All parameters from that array can be used in a same action as placeholders value. For example, placeholder *{event.response.nodes[0].url}* will be an address of first added node.
@@ -209,6 +216,7 @@ The event is executed after adding new container(s) to the existing node group.
- `${event.params.}`:
- `nodeGroup` - node layer where event is executed
- `count` - nodes count which have been added
+ - `auto` *[boolean]* - detects whether autoscaling is enabled or not
- `${event.response.}`
- `nodes` - nodes array which was added to the environment. All parameters from that array can be used in a same action as placeholders value. For example, placeholder *{event.response.nodes[0].url}* will be an address of first added node