ec2_metadata_facts: Add support to query instance tags in metadata #1186

mandar242 · 2022-10-20T02:52:41Z

SUMMARY

Fixes #684

Added support to be able to query instance tags using ec2_metadata_facts.

This PR adds a field in returned ansible_facts named ansible_ec2_instance_tags_keys.

Sample

"ansible_ec2_instance_tags_keys": [
        "Name",
        "snake_case_key"
],

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

ec2_metadata_facts

ADDITIONAL INFORMATION

Support to enable instance metadata tags already exists in amazon.aws.ec2_instance

github-actions · 2022-10-20T02:56:52Z

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

ansibullbot · 2022-10-20T03:09:41Z

cc @jillr @roadmapper @s-hertel @silviud @tremble
click here for bot help

softwarefactory-project-zuul · 2022-10-20T18:31:46Z

Build failed.

gravesm

This also needs a changelog fragment.

gravesm · 2022-10-20T18:27:23Z

plugins/modules/ec2_metadata_facts.py

@@ -576,6 +594,10 @@ def run(self):
        data.update(dyndata)
        data = self.fix_invalid_varnames(data)

+        instance_tags_keys = self._fetch(self.uri_instance_tags)
+        instance_tags_keys = instance_tags_keys.split('\n') if '\n' in instance_tags_keys else [instance_tags_keys]


Unless I'm missing something here you can just do:

instance_tag_keys = instance_tags_keys.split("\n")

oh right, fixed.

softwarefactory-project-zuul · 2022-10-20T20:31:24Z

Build failed.

gravesm · 2022-10-24T14:21:45Z

plugins/modules/ec2_metadata_facts.py

@@ -576,6 +594,10 @@ def run(self):
        data.update(dyndata)
        data = self.fix_invalid_varnames(data)

+        instance_tags_keys = self._fetch(self.uri_instance_tags)


My understanding is that tags are not enabled on instance metadata by default. Isn't this going to fail in that case?

This is what I get if tag is disabled (the default):

"ansible_ec2_instance_tags_keys": [ "None" ],

Actually, we just need this to update the cache, the key(s) will be automatically included in the final result:

self.fetch(self.uri_instance_tags)

For the record, this is what I get with an instance and 2 tags:

"ansible_ec2_tags_instance_Name": "test-goneri-tag", "ansible_ec2_tags_instance_foo": "var",

@gravesm , it doesn't fail, it returns str "None" but I wasn't sure how to handle it

in case if the instance metadata tags are enabled, we are returning a list of tag keys like "ansible_ec2_instance_tags_keys": [ "Name", "snake_case_key" ] , so I decided to return None in a list like "ansible_ec2_instance_tags_keys": [ "None" ], to maintain the output data type.

should we want to return ansible_ec2_instance_tags_keys: "None" instead?

For the record, this is what I get with an instance and 2 tags:
"ansible_ec2_tags_instance_Name": "test-goneri-tag",
"ansible_ec2_tags_instance_foo": "var",

@goneri , these keys were being returned before the code change in this PR, but there was no single output param to access all the tag keys earlier
with the code change in this PR, we return new output param ansible_ec2_instance_tags_keys which is a list of str having tag keys

should we want to return ansible_ec2_instance_tags_keys: "None" instead?

I think we should return ansible_ec2_instance_tags_keys: [], which is what the documentation for the return value suggests it will do already.

Fixed @gravesm

Thank you @mandar242 for the clarification, I was far away.

goneri · 2022-10-24T19:25:42Z

tests/integration/targets/ec2_metadata_facts/playbooks/setup.yml

@@ -115,8 +115,11 @@
      network:
        assign_public_ip: true
        delete_on_termination: true
+      metadata_options:


The instance type is wrong since you need Nitro support (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). I personally don't care if there is functional test or not since the code follow the same logic than the rest of the facts (assuming here you just use self.fetch()).

softwarefactory-project-zuul · 2022-10-25T18:21:00Z

Build failed.

mandar242 · 2022-10-25T19:12:22Z

recheck

softwarefactory-project-zuul · 2022-10-25T19:47:13Z

Build failed.

alinabuzachis · 2022-10-25T19:52:02Z

plugins/modules/ec2_metadata_facts.py

+        ansible_ec2_instance_tags_keys:
+            description:
+                - The list of tags keys of the instance.
+                - Returns empty list if access to tags (InstanceMetadataTags) in instance metadata is not enabled.


Please add version_added: 5.1.0

softwarefactory-project-zuul · 2022-10-26T02:48:20Z

Build failed.

mandar242 · 2022-10-27T01:29:24Z

recheck

softwarefactory-project-zuul · 2022-10-27T01:48:55Z

Build succeeded.

softwarefactory-project-zuul · 2022-10-27T22:17:11Z

Build succeeded (gate pipeline).

…ansible-collections#1186) Tagging - remove default empty dict where purge_tags default is False Depends-On: ansible-collections#844 SUMMARY Deprecate purge_tags=False Remove default of empty dict for tags ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_kms.py plugins/modules/cloudfront_distribution.py plugins/modules/ec2_vpc_vpn.py plugins/modules/rds_param_group.py ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis <None> This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections/community.aws@374bcfd

…nsible-collections#1186) ec2_metadata_facts: Add support to query instance tags in metadata SUMMARY Fixes ansible-collections#684 Added support to be able to query instance tags using ec2_metadata_facts. This PR adds a field in returned ansible_facts named ansible_ec2_instance_tags_keys. Sample "ansible_ec2_instance_tags_keys": [ "Name", "snake_case_key" ], ISSUE TYPE Feature Pull Request COMPONENT NAME ec2_metadata_facts ADDITIONAL INFORMATION Support to enable instance metadata tags already exists in amazon.aws.ec2_instance Reviewed-by: Mike Graves <[email protected]> Reviewed-by: Mandar Kulkarni <[email protected]> Reviewed-by: Gonéri Le Bouder <[email protected]> Reviewed-by: Alina Buzachis <None>

…nstance tags in metadata (#1186) (#1488) [manual backport stable-5] ec2_metadata_facts: Add support to query instance tags in metadata (#1186) ec2_metadata_facts: Add support to query instance tags in metadata SUMMARY Fixes #684 Added support to be able to query instance tags using ec2_metadata_facts. This PR adds a field in returned ansible_facts named ansible_ec2_instance_tags_keys. Sample "ansible_ec2_instance_tags_keys": [ "Name", "snake_case_key" ], ISSUE TYPE Feature Pull Request COMPONENT NAME ec2_metadata_facts ADDITIONAL INFORMATION Support to enable instance metadata tags already exists in amazon.aws.ec2_instance Reviewed-by: Mike Graves [email protected] Reviewed-by: Mandar Kulkarni [email protected] Reviewed-by: Gonéri Le Bouder [email protected] Reviewed-by: Alina Buzachis SUMMARY ISSUE TYPE Bugfix Pull Request Docs Pull Request Feature Pull Request New Module Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Mark Chappell

…ansible-collections#1186) Tagging - remove default empty dict where purge_tags default is False Depends-On: ansible-collections#844 SUMMARY Deprecate purge_tags=False Remove default of empty dict for tags ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_kms.py plugins/modules/cloudfront_distribution.py plugins/modules/ec2_vpc_vpn.py plugins/modules/rds_param_group.py ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis <None>

…ansible-collections#1186) Tagging - remove default empty dict where purge_tags default is False Depends-On: ansible-collections#844 SUMMARY Deprecate purge_tags=False Remove default of empty dict for tags ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_kms.py plugins/modules/cloudfront_distribution.py plugins/modules/ec2_vpc_vpn.py plugins/modules/rds_param_group.py ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis <None> This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections/community.aws@374bcfd

Add support to query instance tags in metadata

b331533

ansibullbot added community_review feature This issue/PR relates to a feature request integration tests/integration module module needs_triage plugins plugin (any type) tests tests labels Oct 20, 2022

This comment was marked as outdated.

Sign in to view

Sanity fix

ca5d6c1

gravesm reviewed Oct 20, 2022

View reviewed changes

minor fix

bae65ad

mandar242 requested a review from gravesm October 21, 2022 06:53

gravesm reviewed Oct 24, 2022

View reviewed changes

goneri reviewed Oct 24, 2022

View reviewed changes

mandar242 added 2 commits October 24, 2022 13:34

Return empty list if instance_metadata_tags disabled

d875b4e

Added changelogs fragment

cef2142

This comment was marked as outdated.

Sign in to view

Add required min botocore version to integration tests

c9dc206

This comment was marked as outdated.

Sign in to view

Add required min botocore version to integration tests

7944783

This comment was marked as outdated.

Sign in to view

Add required min botocore version to integration tests

783b934

alinabuzachis reviewed Oct 25, 2022

View reviewed changes

Add version_added

9545aae

mandar242 requested review from alinabuzachis, gravesm and goneri October 27, 2022 04:58

gravesm approved these changes Oct 27, 2022

View reviewed changes

goneri approved these changes Oct 27, 2022

View reviewed changes

alinabuzachis approved these changes Oct 27, 2022

View reviewed changes

mandar242 added the mergeit Merge the PR (SoftwareFactory) label Oct 27, 2022

softwarefactory-project-zuul bot merged commit 91c0eac into ansible-collections:main Oct 27, 2022

tremble mentioned this pull request Feb 10, 2023

Extend ec2_metadata_facts to get instance tags #851

Closed

1 task

mandar242 deleted the ec2_metadata_facts branch May 9, 2023 02:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ec2_metadata_facts: Add support to query instance tags in metadata #1186

ec2_metadata_facts: Add support to query instance tags in metadata #1186

mandar242 commented Oct 20, 2022

github-actions bot commented Oct 20, 2022 •

edited

Loading

ansibullbot commented Oct 20, 2022

This comment was marked as outdated.

softwarefactory-project-zuul bot commented Oct 20, 2022

gravesm left a comment

gravesm Oct 20, 2022

mandar242 Oct 20, 2022

softwarefactory-project-zuul bot commented Oct 20, 2022

gravesm Oct 24, 2022

goneri Oct 24, 2022 •

edited

Loading

goneri Oct 24, 2022

mandar242 Oct 24, 2022

mandar242 Oct 24, 2022

gravesm Oct 24, 2022

mandar242 Oct 24, 2022 •

edited

Loading

goneri Oct 25, 2022

goneri Oct 24, 2022

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

softwarefactory-project-zuul bot commented Oct 25, 2022

mandar242 commented Oct 25, 2022

softwarefactory-project-zuul bot commented Oct 25, 2022

alinabuzachis Oct 25, 2022

mandar242 Oct 26, 2022

softwarefactory-project-zuul bot commented Oct 26, 2022

mandar242 commented Oct 27, 2022

softwarefactory-project-zuul bot commented Oct 27, 2022

softwarefactory-project-zuul bot commented Oct 27, 2022

ec2_metadata_facts: Add support to query instance tags in metadata #1186

ec2_metadata_facts: Add support to query instance tags in metadata #1186

Conversation

mandar242 commented Oct 20, 2022

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

github-actions bot commented Oct 20, 2022 • edited Loading

Docs Build 📝

ansibullbot commented Oct 20, 2022

This comment was marked as outdated.

softwarefactory-project-zuul bot commented Oct 20, 2022

gravesm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Oct 20, 2022

Choose a reason for hiding this comment

goneri Oct 24, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mandar242 Oct 24, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

softwarefactory-project-zuul bot commented Oct 25, 2022

mandar242 commented Oct 25, 2022

softwarefactory-project-zuul bot commented Oct 25, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Oct 26, 2022

mandar242 commented Oct 27, 2022

softwarefactory-project-zuul bot commented Oct 27, 2022

softwarefactory-project-zuul bot commented Oct 27, 2022

github-actions bot commented Oct 20, 2022 •

edited

Loading

goneri Oct 24, 2022 •

edited

Loading

mandar242 Oct 24, 2022 •

edited

Loading