Document use of tags in target_mapping #19
Merged
Conversation
This file contains 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
|
|
lucywyman
reviewed
Jun 8, 2021
| @@ -24,7 +24,7 @@ The AWS Inventory plugin supports looking up running AWS EC2 instances. It suppo | |||
| - `aws_access_key_id`: The AWS access key id to use. (optional) | |||
| - `aws_secret_access_key`: The AWS secret access key to use. (optional) | |||
| - `filters`: The [filter request parameters](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) used to filter the EC2 instances by. Filters are name-values pairs, where the name is a request parameter and the values are an array of values to filter by. (optional) | |||
| - `target_mapping`: A hash of target attributes to populate with resource values. The following attributes are available. | |||
| - `target_mapping`: A hash of target attributes to populate with resource values. Tags can referenced with tag.\<key\> (e.g. tag.Name). The following attributes are available. | |||
There was a problem hiding this comment.
If you have time, this seems like it might be worth adding to the example at the bottom of this document as well, for visibility. Agreed that this is incredibly useful and not documented at all! I think just adding a new configuration option would be good, so something like changing the example to be:
target_mapping:
name: public_dns_name
uri: public_ip_address
config:
ssh:
host: public_dns_name
user: tag.User
|
I think we can just merge this as-is and add the example as a separate PR. Thanks again! |
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.
While using tags in target_mapping is trivial, it was not documented at all afaics. I actually had to look into the code and do some ad hoc debugging before I realized how to do it.
Being able to refer to targets using a human-readable name (e.g. "Name" tag of the EC2 instance) is a big usability feature so better document it.