Added cloud/Amazon module for SSM #19868

woznij · 2017-01-04T15:01:54Z

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

ssm_send_command

ANSIBLE VERSION

ansible 2.2.0 (devel 29fda4be1e) last updated 2016/09/16 18:26:39 (GMT +000)
  lib/ansible/modules/core: (detached HEAD 2e1e3562b9) last updated 2016/09/16 18:26:41 (GMT +000)
  lib/ansible/modules/extras: (detached HEAD 9b5c64e240) last updated 2016/09/16 18:26:42 (GMT +000)
  config file =
  configured module search path = Default w/o overrides

SUMMARY

This module allows you to interface with Amazon Simple Systems Manager (SSM) to manage the configuration of your Amazon EC2 instances. Specifically this module allows you to use the Run Command functionality to run system commands against your hosts. E.g. you can run PowerShell commands against Windows hosts or bash commands against a Linux host. The specific advantage is that you do not need to log into those hosts as the SSM service takes care of the execution. For more information see http://docs.aws.amazon.com/ssm/latest/APIReference/Welcome.html

woznij · 2017-01-04T15:01:54Z

Migrated from ansible/ansible-modules-extras#3294

nitzmahone · 2017-01-06T01:07:13Z

Rackspace has been teasing a connection plugin they wrote that uses SSM as well- I've reached out to see if we should expect it anytime soon. I'm not opposed to overlapping functionality here either, but a connection plugin really is the "ansible-y" way to do this sort of thing...

ansibot · 2017-01-31T21:40:30Z

@mmochan @michaeljs1990 @wimnat @erydo @jarv @steynovich @ryansydnor @simplesteph @Java1Guy @rmorlok @pwnall @naslanidis @pjodouin @willthames @RickMendes @amir343 @linuxdynasty @timmahoney @tedder @jsdalton @jmenga @tastychutney @scottanderson42 @mjschultz @bpennypacker @zimbatm @brandond @joelthompson @alachaum @TomBamford @jjshoe @j-carl @fiunchinho @Etherdaemon @bekelchik @minichate @MichaelBaydoun @loia @akazakov @Zeekin @silviud @whiter

As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add shipit if you would like to see it merged.

click here for bot help

willthames · 2017-02-01T01:30:42Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+    sample: Success
+'''
+
+# import base64


remove these if not required

willthames · 2017-02-01T01:31:39Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+    if not HAS_BOTO3:
+        module.fail_json(msg='Python module "boto3" is missing, please install it')
+
+    if not (document_name and instance_ids):


why aren't these required in the argument_spec?

This is still unanswered

These parameters are set to required=True however I found that if you specify the parameter in a playbook but leave it blank, it still gets past that check. I put this in as a more friendly way of handling the exception than letting the exception generated by the the boto call to bubble up. If there is a more "Ansible-y" way of handling this, let me know. Thanks!

Ok, that makes sense, was just curious why it was required.

willthames · 2017-02-01T01:34:01Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+    module.exit_json(changed=True, result=results)
+
+# import module snippets
+from ansible.module_utils.basic import *


Need to use new style module imports

from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.ec2 import boto3_conn, ec2_argument_spec, get_aws_connection_info

preferably at the top of the file to avoid flake8 complaints.

willthames · 2017-02-01T06:45:35Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+short_description: Execute commands through Simple System Manager (SSM) a.k.a. Run Command
+description:
+  - This module allows you to execute commands through SSM/Run Command.
+version_added: "2.2"


This regressed back in your most recent commit

willthames · 2017-02-01T06:46:13Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+    sample: Success
+'''
+
+from ansible.module_utils.basic import *


just import AnsibleModule here

willthames · 2017-02-02T01:41:53Z

!needs_revision

willthames · 2017-02-02T01:42:01Z

shipit

willthames · 2017-02-02T01:43:12Z

@nitzmahone the SSM connection plugin does sound like it might be simpler for some use cases - guess it depends on what else you're doing in the rest of your playbook.

wimnat

needs_revision

wimnat · 2017-02-07T00:24:33Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+      - A comment about this particular invocation.
+    required: false
+    default: NONE
+  instanceIds:


I would change this to ansible preferred snake_case. instance_ids

wimnat · 2017-02-07T00:25:32Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+def main():
+    argument_spec = ec2_argument_spec()
+    argument_spec.update(dict(
+        name                 = dict(required=True),


You should try to follow pep8. Therefore, the spacing here isn't required. Also, applies to the rest of the dict

wimnat · 2017-02-07T00:25:57Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+        supports_check_mode=False
+    )
+
+    document_name = module.params.get('name')  # Needs to be an existing SSM document name


Again, pep8 means no spaces here

wimnat · 2017-02-07T00:28:51Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+                             "the document name is correct and your profile has "
+                             "permissions to execute SSM.",
+                             exception=traceback.format_exc(ce))
+        module.fail_json(msg="Client-side error when invoking SSM, check inputs and specific error",


I would follow the guidelines here for boto3 exception handling https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/amazon/GUIDELINES.md#boto3-2

wimnat · 2017-02-07T00:29:04Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+        module.fail_json(msg="Client-side error when invoking SSM, check inputs and specific error",
+                         exception=traceback.format_exc(ce))
+    except botocore.exceptions.ParamValidationError as ve:
+        module.fail_json(msg="Parameters to `invoke` failed to validate",


And here https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/amazon/GUIDELINES.md#boto3-2

wimnat · 2017-02-07T00:30:05Z

lib/ansible/modules/cloud/amazon/ssm_send_command.py

+            while checking:
+                try:
+                    invoke_response = client.list_command_invocations(**list_params)
+                except Exception as e:


Only capture the specific exception type here and handle appropriately https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/amazon/GUIDELINES.md#boto3-2

nitzmahone · 2017-02-07T01:48:38Z

Discussed offline with the author of the SSM connection plugin, and decided that both would be good to have. Once everyone's happy with implementation on this one, I'm good to merge.

ansibot · 2017-02-16T22:19:13Z

@woznij This PR contains @ mentions in at least one commit message. Those mentions can cause cascading notifications through GitHub and need to be removed. Please squash or amend your commits to remove the mentions.

click here for bot help

ryansb · 2017-05-16T13:51:57Z

@woznij can you please rebase this and change the "version_added" docs property?

ansibot · 2017-05-16T14:03:35Z

The test ansible-test sanity --test pep8 failed with the following errors:

lib/ansible/modules/cloud/amazon/ssm_send_command.py:112:13: E221 multiple spaces before operator
lib/ansible/modules/cloud/amazon/ssm_send_command.py:112:13: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:112:31: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:113:13: E221 multiple spaces before operator
lib/ansible/modules/cloud/amazon/ssm_send_command.py:113:13: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:113:31: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:114:16: E221 multiple spaces before operator
lib/ansible/modules/cloud/amazon/ssm_send_command.py:114:16: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:114:31: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:115:20: E221 multiple spaces before operator
lib/ansible/modules/cloud/amazon/ssm_send_command.py:115:20: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:115:31: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:116:19: E221 multiple spaces before operator
lib/ansible/modules/cloud/amazon/ssm_send_command.py:116:19: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:116:31: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/cloud/amazon/ssm_send_command.py:198:18: E225 missing whitespace around operator
lib/ansible/modules/cloud/amazon/ssm_send_command.py:203:18: E225 missing whitespace around operator

The test ansible-test sanity --test validate-modules failed with the following errors:

lib/ansible/modules/cloud/amazon/ssm_send_command.py:0:0: E307 version_added should be 2.4. Currently 2.3
lib/ansible/modules/cloud/amazon/ssm_send_command.py:0:0: E314 No ANSIBLE_METADATA provided
lib/ansible/modules/cloud/amazon/ssm_send_command.py:0:0: E319 RETURN.status.returned: required key not provided @ data['returned']. Got None
lib/ansible/modules/cloud/amazon/ssm_send_command.py:74:15: E311 EXAMPLES is not valid YAML

click here for bot help

destroy-everything · 2017-09-29T05:39:25Z

what is going on here? it has been a while since there was any progress? what can I do to help?

woznij · 2017-09-29T13:19:55Z

@destroy-everything It HAS been a while! I got pulled away on assignment at work and have not had time to come back to this. It has turned into a bit of a black hole it seems. I fix one thing and another thing is found, lots of small differentiating changes. With my workload as of recent it has made it difficult to keep up. This is really my first contribution to a large public repo so following the rules is a bit of a learning curve too, and it seems the rules have changed a few times since I started this. All that is just an excuse really and I really should just sit down and do it. Other than time, my blockers are reading up on how to "rebase" properly, read up on what "ANSIBLE_METADATA" is, read up on "RETURN.status.returned" should be. The other outstanding things like PEP8 tweaks should be pretty easy. I will note that a good chunk of this code was reused from another approved and merged module so some of the things that were caught must be because of new checks that are being performed.

willthames · 2017-10-09T06:26:53Z

@woznij it is a bit of a moving target I'm afraid but a slow moving one that we're trying to better document. Some of it is that the project's coding standards are improving so we can do more checking of the obvious stuff, some of it is just evolution in action.

We should also just document a 'perfect' module skeleton that people can just copy and paste the relevant sections from into their work.

willthames · 2017-10-09T06:28:29Z

Metadata documentation

RETURN documentation

 E319 RETURN.status.returned: required key not provided @ data['returned']. Got None

just means that in your RETURN section, you have a status block that does not have a setting for returned.

RobReus · 2018-07-25T14:11:10Z

This PR has been inactive for over half a year now. Any activities going on?

I have written the same module for internal use with the same functionality. Should we try to fix this PR or should I open a fresh PR with my changes?

gundalow · 2019-09-19T12:13:22Z

I'll close this and move to #54931

@woznij @RobReus

woznij added 2 commits January 4, 2017 15:01

Updated "version_added" to "2.3" as per suggestion

053e2a2

ansibot added affects_2.3 This issue/PR affects Ansible v2.3 aws cloud module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. new_plugin This PR includes a new plugin. plugin labels Jan 4, 2017

jimi-c removed the plugin label Jan 4, 2017

ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. new_module This PR includes a new module. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 5, 2017

nitzmahone removed the needs_triage Needs a first human triage before being processed. label Jan 5, 2017

ansibot added the community_review In order to be merged, this PR must follow the community review workflow. label Jan 7, 2017

willthames reviewed Feb 1, 2017

View reviewed changes

Made updates as per @willthames suggestions

047738f

willthames suggested changes Feb 1, 2017

View reviewed changes

Updated imports section, fixed regression of version_added string

a582a82

ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels Feb 1, 2017

wimnat reviewed Feb 7, 2017

View reviewed changes

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Apr 11, 2017

ansibot removed the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label May 16, 2017

mattclay added the ci_verified Changes made in this PR are causing tests to fail. label May 16, 2017

ansibot added stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. support:community This issue/PR relates to code supported by the Ansible community. labels Jun 24, 2017

ansibot added the new_contributor This PR is the first contribution by a new community member. label Oct 18, 2017

ansibot removed the new_contributor This PR is the first contribution by a new community member. label Nov 3, 2017

ansibot added the new_contributor This PR is the first contribution by a new community member. label Jan 22, 2018

sosheskaz mentioned this pull request Apr 5, 2019

Add Cloud/Amazon SSM Send-Command Module #54931

Closed

gundalow closed this Sep 19, 2019

ansible locked and limited conversation to collaborators Oct 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added cloud/Amazon module for SSM #19868

Added cloud/Amazon module for SSM #19868

woznij commented Jan 4, 2017

woznij commented Jan 4, 2017

nitzmahone commented Jan 6, 2017 •

edited

Loading

ansibot commented Jan 31, 2017

willthames Feb 1, 2017

willthames Feb 1, 2017

willthames Feb 1, 2017

woznij Feb 1, 2017

willthames Feb 2, 2017

willthames Feb 1, 2017

willthames Feb 1, 2017

willthames Feb 1, 2017

willthames commented Feb 2, 2017

willthames commented Feb 2, 2017

willthames commented Feb 2, 2017

wimnat left a comment

wimnat Feb 7, 2017

wimnat Feb 7, 2017

wimnat Feb 7, 2017

wimnat Feb 7, 2017

wimnat Feb 7, 2017

wimnat Feb 7, 2017

nitzmahone commented Feb 7, 2017

ansibot commented Feb 16, 2017

ryansb commented May 16, 2017

ansibot commented May 16, 2017

destroy-everything commented Sep 29, 2017

woznij commented Sep 29, 2017

willthames commented Oct 9, 2017

willthames commented Oct 9, 2017 •

edited

Loading

RobReus commented Jul 25, 2018

gundalow commented Sep 19, 2019

Added cloud/Amazon module for SSM #19868

Added cloud/Amazon module for SSM #19868

Conversation

woznij commented Jan 4, 2017

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

SUMMARY

woznij commented Jan 4, 2017

nitzmahone commented Jan 6, 2017 • edited Loading

ansibot commented Jan 31, 2017

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willthames commented Feb 2, 2017

willthames commented Feb 2, 2017

willthames commented Feb 2, 2017

wimnat left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nitzmahone commented Feb 7, 2017

ansibot commented Feb 16, 2017

ryansb commented May 16, 2017

ansibot commented May 16, 2017

destroy-everything commented Sep 29, 2017

woznij commented Sep 29, 2017

willthames commented Oct 9, 2017

willthames commented Oct 9, 2017 • edited Loading

RobReus commented Jul 25, 2018

gundalow commented Sep 19, 2019

nitzmahone commented Jan 6, 2017 •

edited

Loading

willthames commented Oct 9, 2017 •

edited

Loading