Update aws_ec2 documentation for the use_ssm_inventory option #1586

alinabuzachis · 2023-05-31T15:09:15Z

SUMMARY

Update aws_ec2 documentation for the use_ssm_inventory option

Might fix #1461

ISSUE TYPE

Docs Pull Request

COMPONENT NAME

aws_ec2

github-actions · 2023-05-31T15:22:51Z

Docs Build 📝

Thank you for contribution!✨

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

softwarefactory-project-zuul · 2023-05-31T15:39:14Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/9b190ea96eb24b21b2ac2cc24fdbe4f9

✔️ ansible-galaxy-importer SUCCESS in 3m 42s
✔️ build-ansible-collection SUCCESS in 12m 28s
✔️ ansible-test-splitter SUCCESS in 4m 56s
✔️ integration-amazon.aws-1 SUCCESS in 16m 09s
Skipped 43 jobs

Signed-off-by: Alina Buzachis <[email protected]>

softwarefactory-project-zuul · 2023-05-31T16:21:39Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/ac3566d1b106473295045b9ff6fe67c6

✔️ ansible-galaxy-importer SUCCESS in 4m 54s
✔️ build-ansible-collection SUCCESS in 12m 37s
✔️ ansible-test-splitter SUCCESS in 4m 47s
✔️ integration-amazon.aws-1 SUCCESS in 20m 36s
Skipped 43 jobs

tremble · 2023-06-01T06:25:36Z

plugins/inventory/aws_ec2.py

@@ -137,7 +137,10 @@
    version_added: 3.1.0
  use_ssm_inventory:
    description:
-      - Add SSM inventory information into hostvars.
+      - Allows to fetch EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars.


Suggested change

- Allows to fetch EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars.

- Enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars.

tremble · 2023-06-01T06:26:09Z

docs/docsite/rst/aws_ec2_guide.rst

@@ -484,7 +484,9 @@ Now the output of ``ansible-inventory -i demo.aws_ec2.yml --list``:
 ``use_ssm_inventory``
 ---------------------

-``use_ssm_inventory: True`` will include SSM inventory variables into hostvars for ssm-configured instances.
+``use_ssm_inventory: True`` will allow to fetch EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars. By leveraging the SSM inventory data, the ``use_ssm_inventory`` option provides additional details and attributes about the EC2 instances in your inventory.


Suggested change

``use_ssm_inventory: True`` will allow to fetch EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars. By leveraging the SSM inventory data, the ``use_ssm_inventory`` option provides additional details and attributes about the EC2 instances in your inventory.

``use_ssm_inventory: True`` enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars. By leveraging the SSM inventory data, the ``use_ssm_inventory`` option provides additional details and attributes about the EC2 instances in your inventory.

Signed-off-by: Alina Buzachis <[email protected]>

softwarefactory-project-zuul · 2023-06-01T08:58:40Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/42becce98a4f46a6a6070cd2a462b82f

✔️ ansible-galaxy-importer SUCCESS in 3m 50s
✔️ build-ansible-collection SUCCESS in 12m 37s
✔️ ansible-test-splitter SUCCESS in 4m 53s
✔️ integration-amazon.aws-1 SUCCESS in 16m 46s
Skipped 43 jobs

softwarefactory-project-zuul · 2023-06-01T21:44:16Z

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/0ada251baaaf474a9104dacc3de3d2a1

✔️ ansible-galaxy-importer SUCCESS in 3m 39s
✔️ build-ansible-collection SUCCESS in 12m 46s
✔️ ansible-test-splitter SUCCESS in 5m 06s
✔️ integration-amazon.aws-1 SUCCESS in 16m 51s
Skipped 43 jobs

patchback · 2023-06-01T21:44:21Z

Backport to stable-5: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 463d588 on top of patchback/backports/stable-5/463d58802ebc1d8d40703baa96fa1c8b42ac13f8/pr-1586

Backporting merged PR #1586 into main

Ensure you have a local repo clone of your fork. Unless you cloned it
from the upstream, this would be your origin remote.
Make sure you have an upstream repo added as a remote too. In these
instructions you'll refer to it by the name upstream. If you don't
have it, here's how you can add it:
```
$ git remote add upstream https://github.com/ansible-collections/amazon.aws.git
```

Ensure you have the latest copy of upstream and prepare a branch
that will hold the backported code:

$ git fetch upstream
$ git checkout -b patchback/backports/stable-5/463d58802ebc1d8d40703baa96fa1c8b42ac13f8/pr-1586 upstream/stable-5

Now, cherry-pick PR Update aws_ec2 documentation for the use_ssm_inventory option #1586 contents into that branch:
```
$ git cherry-pick -x 463d58802ebc1d8d40703baa96fa1c8b42ac13f8
```
If it'll yell at you with something like fatal: Commit 463d58802ebc1d8d40703baa96fa1c8b42ac13f8 is a merge but no -m option was given., add -m 1 as follows instead:
```
$ git cherry-pick -m1 -x 463d58802ebc1d8d40703baa96fa1c8b42ac13f8
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Update aws_ec2 documentation for the use_ssm_inventory option #1586 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/stable-5/463d58802ebc1d8d40703baa96fa1c8b42ac13f8/pr-1586

Create a PR, ensure that the CI is green. If it's not — update it so that
the tests and any other checks pass. This is it!
Now relax and wait for the maintainers to process your pull request
when they have some cycles to do reviews. Don't worry — they'll tell you if
any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback · 2023-06-01T21:44:27Z

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/463d58802ebc1d8d40703baa96fa1c8b42ac13f8/pr-1586

Backported as #1590

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Update aws_ec2 documentation for the use_ssm_inventory option SUMMARY Update aws_ec2 documentation for the use_ssm_inventory option Might fix #1461 ISSUE TYPE Docs Pull Request COMPONENT NAME aws_ec2 Reviewed-by: Mark Chappell Reviewed-by: Jill R (cherry picked from commit 463d588)

…#1590) [PR #1586/463d5880 backport][stable-6] Update aws_ec2 documentation for the use_ssm_inventory option This is a backport of PR #1586 as merged into main (463d588). SUMMARY Update aws_ec2 documentation for the use_ssm_inventory option Might fix #1461 ISSUE TYPE Docs Pull Request COMPONENT NAME aws_ec2 Reviewed-by: Alina Buzachis

alinabuzachis mentioned this pull request May 31, 2023

Explain what use_ssm_inventory in ec2 inventory plugin does #1461

Closed

1 task

alinabuzachis force-pushed the aws_ec2_documentation_fix branch from 6c12f32 to 5f99aee Compare May 31, 2023 15:41

Update aws_ec2 documentation for the use_ssm_inventory option

092990a

Signed-off-by: Alina Buzachis <[email protected]>

alinabuzachis force-pushed the aws_ec2_documentation_fix branch from 5f99aee to 092990a Compare May 31, 2023 15:47

tremble approved these changes Jun 1, 2023

View reviewed changes

Re-word sentences

5eff601

Signed-off-by: Alina Buzachis <[email protected]>

alinabuzachis added backport-5 PR should be backported to the stable-5 branch backport-6 PR should be backported to the stable-6 branch labels Jun 1, 2023

jillr approved these changes Jun 1, 2023

View reviewed changes

jillr added the mergeit Merge the PR (SoftwareFactory) label Jun 1, 2023

softwarefactory-project-zuul bot merged commit 463d588 into ansible-collections:main Jun 1, 2023

patchback bot mentioned this pull request Jun 1, 2023

[PR #1586/463d5880 backport][stable-6] Update aws_ec2 documentation for the use_ssm_inventory option #1590

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update aws_ec2 documentation for the use_ssm_inventory option #1586

Update aws_ec2 documentation for the use_ssm_inventory option #1586

alinabuzachis commented May 31, 2023

github-actions bot commented May 31, 2023 •

edited

Loading

softwarefactory-project-zuul bot commented May 31, 2023

softwarefactory-project-zuul bot commented May 31, 2023

tremble Jun 1, 2023 •

edited

Loading

tremble Jun 1, 2023 •

edited

Loading

softwarefactory-project-zuul bot commented Jun 1, 2023

softwarefactory-project-zuul bot commented Jun 1, 2023

patchback bot commented Jun 1, 2023 •

edited

Loading

patchback bot commented Jun 1, 2023 •

edited

Loading

	- Allows to fetch EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars.
	- Enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars.

	``use_ssm_inventory: True`` will allow to fetch EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars. By leveraging the SSM inventory data, the ``use_ssm_inventory`` option provides additional details and attributes about the EC2 instances in your inventory.
	``use_ssm_inventory: True`` enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars. By leveraging the SSM inventory data, the ``use_ssm_inventory`` option provides additional details and attributes about the EC2 instances in your inventory.

Update aws_ec2 documentation for the use_ssm_inventory option #1586

Update aws_ec2 documentation for the use_ssm_inventory option #1586

Conversation

alinabuzachis commented May 31, 2023

SUMMARY

ISSUE TYPE

COMPONENT NAME

github-actions bot commented May 31, 2023 • edited Loading

Docs Build 📝

softwarefactory-project-zuul bot commented May 31, 2023

softwarefactory-project-zuul bot commented May 31, 2023

tremble Jun 1, 2023 • edited Loading

Choose a reason for hiding this comment

tremble Jun 1, 2023 • edited Loading

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Jun 1, 2023

softwarefactory-project-zuul bot commented Jun 1, 2023

patchback bot commented Jun 1, 2023 • edited Loading

Backport to stable-5: 💔 cherry-picking failed — conflicts found

Backporting merged PR #1586 into main

patchback bot commented Jun 1, 2023 • edited Loading

Backport to stable-6: 💚 backport PR created

github-actions bot commented May 31, 2023 •

edited

Loading

tremble Jun 1, 2023 •

edited

Loading

tremble Jun 1, 2023 •

edited

Loading

patchback bot commented Jun 1, 2023 •

edited

Loading

patchback bot commented Jun 1, 2023 •

edited

Loading