[RUN-4615] Document attribute substitution and presence operator for Attribute Match node enhancer - #1833
Merged
Merged
Conversation
…atch node enhancer Add a Match Operators table (including the new ~~ "is present" operator), document the Enable Attribute Substitution property, and add examples for building attributes and tags from existing node attributes.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Rundeck documentation for the Attribute Match node enhancer to cover newly added match behavior and configuration options, aligning the docs with the upstream plugin feature set.
Changes:
- Expands Attribute Matches guidance to document the
key<operator>valueinput format and link to operator details. - Adds documentation for Enable Attribute Substitution (
${attribute}) including behavior for missing attributes. - Introduces a Match Operators section (including
~~presence) plus examples for deriving tags/attributes from existing node attributes.
|
|
||
| - **Attribute Matches** | ||
| : This is where you specify the attribute that you want to search for. By doing so, you can add new attributes to the nodes that match based off of what you input this section. | ||
| : This is where you specify the attribute that you want to search for. By doing so, you can add new attributes to the nodes that match based off of what you input this section. Each match is entered on its own line using the format `key<operator>value`, where `key` is the attribute name. All matches must succeed for a node to be enhanced. See [Match Operators](#match-operators) for the supported operators. |
fdevans
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release Notes
Documentation for the Attribute Match node enhancer now covers the full set of match operators (including the new
~~"is present" operator) and the new Enable Attribute Substitution option, which lets you build new attributes and tags from a node's existing attributes using${attribute}syntax.PR Details
Documents the new features from rundeck-plugins/attribute-match-node-enhancer#24.
Changes to
docs/manual/node-enhancers.md:==,!=,=~,!~,~~,!!), noting which require a value and which only check for presence.${attribute}syntax and empty-string resolution for unknown references.image-${ec2.imageId}).Note: the upstream plugin PR is not yet merged, so timing of this doc merge may want to align with that release.