Fix support envvars for lookup aws ssm #837

alinabuzachis · 2022-05-25T10:11:58Z

SUMMARY

Took over from #623 to apply reviewer's comments and add a changelog fragment.

Working on support in lookup plugin amazon.aws.aws_ssm for endpoint parameters, as well of tradional environment variable for client configuration (AWS_PROFILE, AWS_ACCESS_KEY_ID, ...).

This should fixes #519

Depends-On: #728

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

aws_ssm

ADDITIONAL INFORMATION

It seems LookupModule cannot benefit from AnsibleAWSModule (it expect several methods/params, I am not familiar enough with Python and Ansible to sort it out) ; so this PR uses boto3_conn and get_aws_connection_info defined in utils.ec2.

This is a simple snippet how it can be used:

- name: Load env
  collections:
  - amazon.aws
  gather_facts: no
  hosts: localhost
  connection: local
  vars:
    my_env: "{{ lookup('amazon.aws.aws_ssm', 'status', endpoint='http://localhost:4566') }}"
  tasks:
    - name: show the env
      debug:
        msg: "{{ my_env }}"

Command line test:

ANSIBLE_COLLECTIONS_PATHS=${ANSIBLE_HOME}/collections ansible-playbook test.yml

Output:

PLAY [Load env] *************************************************************************************************************************************************************************************************************************************************************

TASK [show the env] *********************************************************************************************************************************************************************************************************************************************************
ok: [localhost] => {
    "msg": "INIT"
}

PLAY RECAP ******************************************************************************************************************************************************************************************************************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

Another test with envars:

AWS_ACCESS_KEY_ID='foo' AWS_ACCESS_SECRET_KEY='bar' AWS_URL='http://localhost:4566' ANSIBLE_COLLECTIONS_PATHS=${ANSIBLE_HOME}/collections ansible-playbook test.yml

where we remove the endpoint from lookup:

- name: Load env
  collections:
  - amazon.aws
  gather_facts: no
  hosts: localhost
  connection: local
  vars:
    my_env: "{{ lookup('amazon.aws.aws_ssm', 'status') }}"
  tasks:
    - name: show the env
      debug:
        msg: "{{ my_env }}"

(provides same output)

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

tremble · 2022-05-25T10:16:04Z

Many thanks to @Cicatrice for their original work on this. We've split this off so we can try to get the minor fixes in and the PR merged in time for the next release.

github-actions · 2022-05-25T10:20:21Z

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 · 2022-05-25T10:48:29Z

Build failed.

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

softwarefactory-project-zuul · 2022-05-25T11:52:09Z

Build succeeded.

softwarefactory-project-zuul · 2022-05-25T12:43:18Z

Build succeeded (gate pipeline).

patchback · 2022-05-25T12:43:23Z

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

❌ Failed to cleanly apply 9639325 on top of patchback/backports/stable-3/9639325e7a550a8e35ed4dc103848642b14c8d11/pr-837

Backporting merged PR #837 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-3/9639325e7a550a8e35ed4dc103848642b14c8d11/pr-837 upstream/stable-3

Now, cherry-pick PR Fix support envvars for lookup aws ssm #837 contents into that branch:
```
$ git cherry-pick -x 9639325e7a550a8e35ed4dc103848642b14c8d11
```
If it'll yell at you with something like fatal: Commit 9639325e7a550a8e35ed4dc103848642b14c8d11 is a merge but no -m option was given., add -m 1 as follows intead:
```
$ git cherry-pick -m1 -x 9639325e7a550a8e35ed4dc103848642b14c8d11
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Fix support envvars for lookup aws ssm #837 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/stable-3/9639325e7a550a8e35ed4dc103848642b14c8d11/pr-837

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.

Fix support envvars for lookup aws ssm SUMMARY Took over from ansible-collections#623 to apply reviewer's comments and add a changelog fragment. Working on support in lookup plugin amazon.aws.aws_ssm for endpoint parameters, as well of tradional environment variable for client configuration (AWS_PROFILE, AWS_ACCESS_KEY_ID, ...). This should fixes ansible-collections#519 Depends-On: ansible-collections#728 ISSUE TYPE Feature Pull Request COMPONENT NAME aws_ssm ADDITIONAL INFORMATION It seems LookupModule cannot benefit from AnsibleAWSModule (it expect several methods/params, I am not familiar enough with Python and Ansible to sort it out) ; so this PR uses boto3_conn and get_aws_connection_info defined in utils.ec2. This is a simple snippet how it can be used: - name: Load env collections: - amazon.aws gather_facts: no hosts: localhost connection: local vars: my_env: "{{ lookup('amazon.aws.aws_ssm', 'status', endpoint='http://localhost:4566') }}" tasks: - name: show the env debug: msg: "{{ my_env }}" Command line test: ANSIBLE_COLLECTIONS_PATHS=${ANSIBLE_HOME}/collections ansible-playbook test.yml Output: PLAY [Load env] ************************************************************************************************************************************************************************************************************************************************************* TASK [show the env] ********************************************************************************************************************************************************************************************************************************************************* ok: [localhost] => { "msg": "INIT" } PLAY RECAP ****************************************************************************************************************************************************************************************************************************************************************** localhost : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 Another test with envars: AWS_ACCESS_KEY_ID='foo' AWS_ACCESS_SECRET_KEY='bar' AWS_URL='http://localhost:4566' ANSIBLE_COLLECTIONS_PATHS=${ANSIBLE_HOME}/collections ansible-playbook test.yml where we remove the endpoint from lookup: - name: Load env collections: - amazon.aws gather_facts: no hosts: localhost connection: local vars: my_env: "{{ lookup('amazon.aws.aws_ssm', 'status') }}" tasks: - name: show the env debug: msg: "{{ my_env }}" (provides same output) Reviewed-by: Mark Chappell <None> (cherry picked from commit 9639325)

Fix support envvars for lookup aws ssm (#837) This is a manual backport to stable-3 because #837 failed to be automatically backported. Fix support envvars for lookup aws ssm SUMMARY Took over from #623 to apply reviewer's comments and add a changelog fragment. Working on support in lookup plugin amazon.aws.aws_ssm for endpoint parameters, as well of tradional environment variable for client configuration (AWS_PROFILE, AWS_ACCESS_KEY_ID, ...). This should fixes #519 Depends-On: #728 ISSUE TYPE Feature Pull Request COMPONENT NAME aws_ssm ADDITIONAL INFORMATION It seems LookupModule cannot benefit from AnsibleAWSModule (it expect several methods/params, I am not familiar enough with Python and Ansible to sort it out) ; so this PR uses boto3_conn and get_aws_connection_info defined in utils.ec2. This is a simple snippet how it can be used: name: Load env collections: amazon.aws gather_facts: no hosts: localhost connection: local vars: my_env: "{{ lookup('amazon.aws.aws_ssm', 'status', endpoint='http://localhost:4566') }}" tasks: name: show the env debug: msg: "{{ my_env }}" Command line test: ANSIBLE_COLLECTIONS_PATHS=${ANSIBLE_HOME}/collections ansible-playbook test.yml Output: PLAY [Load env] ************************************************************************************************************************************************************************************************************************************************************* TASK [show the env] ********************************************************************************************************************************************************************************************************************************************************* ok: [localhost] => { "msg": "INIT" } PLAY RECAP ****************************************************************************************************************************************************************************************************************************************************************** localhost : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 Another test with envars: AWS_ACCESS_KEY_ID='foo' AWS_ACCESS_SECRET_KEY='bar' AWS_URL='http://localhost:4566' ANSIBLE_COLLECTIONS_PATHS=${ANSIBLE_HOME}/collections ansible-playbook test.yml where we remove the endpoint from lookup: name: Load env collections: amazon.aws gather_facts: no hosts: localhost connection: local vars: my_env: "{{ lookup('amazon.aws.aws_ssm', 'status') }}" tasks: name: show the env debug: msg: "{{ my_env }}" (provides same output) Reviewed-by: Mark Chappell (cherry picked from commit 9639325) SUMMARY ISSUE TYPE Bugfix Pull Request Docs Pull Request Feature Pull Request New Module Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Joseph Torcasso <None> Reviewed-by: Mark Chappell <None>

…ctions#837) Make deprecated updates in dynamodbo_table module fail SUMMARY Make deprecated primary key updates and all type index includes update fail in dynamodb_table module for 3.0.0 ISSUE TYPE Feature Pull Request COMPONENT NAME dynamodb_table ADDITIONAL INFORMATION Both parts were previously deprecated and are currently ignored, this PR actually makes those ignore updates fail on attempts to pass the bad config. Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis <None> Reviewed-by: None <None>

Cicatrice added 7 commits May 19, 2022 17:47

[aws_ssm]fix: support for envvars and endpoint ; rework client

29b0116

[aws_ssm]fix: support for envvars and endpoint ; rework client

8fb3ad1

fix: reflect change to test

c9b6011

fix: sanitize code

c06cbba

[aws_ssm]chore: add version for endpoint parameter

15f7c4d

[aws_ssm]chore: remove whitespace for lint

1f05097

[aws_ssm]chore: fix indentation for lint

5bd5042

alinabuzachis force-pushed the c-support_envvars_for_lookup_aws_ssm branch from c7825cb to ba41e81 Compare May 25, 2022 10:13

tremble approved these changes May 25, 2022

View reviewed changes

alinabuzachis force-pushed the c-support_envvars_for_lookup_aws_ssm branch from ba41e81 to ac378e9 Compare May 25, 2022 10:13

tremble added the backport-3 PR should be backported to the stable-3 branch label May 25, 2022

Add changelog fragment and address reviewer's comments

9783b7e

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

alinabuzachis force-pushed the c-support_envvars_for_lookup_aws_ssm branch from ac378e9 to 9783b7e Compare May 25, 2022 10:15

ansibullbot added community_review feature This issue/PR relates to a feature request lookup lookup plugin plugins plugin (any type) tests tests labels May 25, 2022

Fix changelog

afd16a5

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

alinabuzachis added the mergeit Merge the PR (SoftwareFactory) label May 25, 2022

alinabuzachis mentioned this pull request May 25, 2022

Fix/support envvars for lookup aws ssm #623

Closed

softwarefactory-project-zuul bot merged commit 9639325 into ansible-collections:main May 25, 2022

alinabuzachis mentioned this pull request May 25, 2022

Fix support envvars for lookup aws ssm (#837) #838

Merged

renovate bot mentioned this pull request Jul 13, 2022

Update dependency amazon.aws to v3.5.1 - autoclosed platan/metrics-shields-io-config#98

Closed

1 task

renovate bot mentioned this pull request Sep 18, 2022

Update dependency amazon.aws to v4 - autoclosed platan/metrics-shields-io-config#104

Closed

1 task

renovate bot mentioned this pull request Oct 4, 2022

Update dependency amazon.aws to v5 - autoclosed platan/metrics-shields-io-config#109

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix support envvars for lookup aws ssm #837

Fix support envvars for lookup aws ssm #837

alinabuzachis commented May 25, 2022

tremble commented May 25, 2022

github-actions bot commented May 25, 2022 •

edited

Loading

softwarefactory-project-zuul bot commented May 25, 2022

softwarefactory-project-zuul bot commented May 25, 2022

softwarefactory-project-zuul bot commented May 25, 2022

patchback bot commented May 25, 2022 •

edited

Loading

Fix support envvars for lookup aws ssm #837

Fix support envvars for lookup aws ssm #837

Conversation

alinabuzachis commented May 25, 2022

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

tremble commented May 25, 2022

github-actions bot commented May 25, 2022 • edited Loading

Docs Build 📝

softwarefactory-project-zuul bot commented May 25, 2022

softwarefactory-project-zuul bot commented May 25, 2022

softwarefactory-project-zuul bot commented May 25, 2022

patchback bot commented May 25, 2022 • edited Loading

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

Backporting merged PR #837 into main

github-actions bot commented May 25, 2022 •

edited

Loading

patchback bot commented May 25, 2022 •

edited

Loading