This is an automated email from the ASF dual-hosted git repository. heneveld pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/brooklyn-docs.git
commit 610f0d4486e31b1293aacf604dc820b6c127cf8e Author: Alex Heneveld <[email protected]> AuthorDate: Mon May 1 13:16:10 2023 +0100 add docs for recent workflow improvements set-entity-name, replace transform, log level, and entity.children/members --- guide/blueprints/workflow/steps/steps.yaml | 11 +++++++++++ guide/blueprints/workflow/variables.md | 2 ++ 2 files changed, 13 insertions(+) diff --git a/guide/blueprints/workflow/steps/steps.yaml b/guide/blueprints/workflow/steps/steps.yaml index 7b62de05..516d9bac 100644 --- a/guide/blueprints/workflow/steps/steps.yaml +++ b/guide/blueprints/workflow/steps/steps.yaml @@ -52,6 +52,7 @@ * `value`: the value to set, with some limited evaluation as described [here](../variables.html) * `transform`: a string indicating a transform, or multiple transforms separated by `|`, where a transform can be * `trim` to remove leading and trailing whitespace on strings, null values from lists or sets, and any entry with a null key or null value in a map + * `replace MODE PATTERN REPLACEMENT` to replace a pattern in a string with a replacement, supporting mode `regex`, `glob`, or `literal` * `merge [list|set|map] [deep] [wait] [lax]` to treat the words in the value as expressions to be combined; indicates the value will be a space-separated list of values, with quotes significant, usually including `$(vars)`; if a type is specified, all values must be compatible with that type, otherwise collection v map merge is inferred from the types; @@ -418,6 +419,14 @@ * `parent`: the entity or entity ID of the new parent output: the output from the previous step, or null if this is the first step + - name: set-entity-name + summary: Sets the display name of an entity + shorthand: '`set-entity-name VALUE`' + input: | + * `value`: the new name + * `entity`: the entity on which to set (default as the entity where the workflow is running) + output: the output from the previous step, or null if this is the first step + - name: apply-initializer summary: Moves an entity to be under a new parent shorthand: '`apply-initializer [TYPE [at ENTITY]]`' @@ -461,6 +470,8 @@ shorthand: '`log MESSAGE`' input: | * `message`: the message to be logged + * `level`: the log level (default `info`) + * `category`: the log category (default `o.a.b.core.workflow.steps.flow.LogWorkflowStep`) output: the output from the previous step, or null if this is the first step - name: no-op diff --git a/guide/blueprints/workflow/variables.md b/guide/blueprints/workflow/variables.md index 328b6636..868bca50 100644 --- a/guide/blueprints/workflow/variables.md +++ b/guide/blueprints/workflow/variables.md @@ -81,6 +81,8 @@ workflow is running, where `<KEY>` can be: * `config.<KEY>` - returns the value of the config key `<KEY>` * `sensor.<KEY>` - returns the value of the sensor key `<KEY>` * `attributeWhenReady.<KEY>` - returns the value of the sensor key `<KEY>` once it is ready (available and truthy), for use with the `wait` step +* `children` - returns the list of children; these can be further identified either by index or by ID using square-bracket notation +* `members` - returns the list of members (for a group); these can be further identified either by index or by ID using square-bracket notation * `parent.<KEY>` - returns the value of `<KEY>` per any of the above in the context of the application * `application.<KEY>` - returns the value of `<KEY>` per any of the above in the context of the application
