Add an ec2_import_snapshot module #62630

bcl · 2019-09-19T23:38:56Z

This uses the boto3 import_snapshot function to import a disk image from
s3 as a snapshot.

SUMMARY

This is a wrapper around the boto3 import_snapshot function. It allows you to import a disk image from an S3 bucket as a snapshot, which can then be registered as an AMI.

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.import_snapshot

It seemed to fit better as its own module instead of adding it to ec2_ami or one of the ec2_snapshot modules.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

ec2_import_snapshot

ADDITIONAL INFORMATION

ansibot · 2019-09-19T23:41:41Z

@bcl, just so you are aware we have a dedicated Working Group for aws.
You can find other people interested in this in #ansible-aws on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

ansibot · 2019-09-19T23:51:50Z

The test ansible-test sanity --test validate-modules [explain] failed with 9 errors:

lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: doc-missing-type: Argument 'description' in argument_spec uses default type ('str') but documentation doesn't define type
lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: doc-missing-type: Argument 'format' in argument_spec uses default type ('str') but documentation doesn't define type
lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: doc-missing-type: Argument 'kms_key_id' in argument_spec uses default type ('str') but documentation doesn't define type
lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: doc-missing-type: Argument 'role_name' in argument_spec uses default type ('str') but documentation doesn't define type
lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: doc-missing-type: Argument 's3_bucket' in argument_spec uses default type ('str') but documentation doesn't define type
lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: doc-missing-type: Argument 's3_key' in argument_spec uses default type ('str') but documentation doesn't define type
lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: doc-missing-type: Argument 'url' in argument_spec uses default type ('str') but documentation doesn't define type
lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: module-incorrect-version-added: version_added should be '2.10'. Currently '2.9'
lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:0:0: parameter-type-not-in-doc: Argument 'wait_timeout' in argument_spec defines type as 'int' but documentation doesn't define type

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2_import_snapshot.py:135:1: E302: expected 2 blank lines, found 1

click here for bot help

flowerysong

I think ec2_snapshot_import might be a better name, to parallel ec2_snapshot_copy.

ec2_snapshot and ec2_snapshot_copy support setting tags on the created snapshot; it would be nice if this module had feature parity.

Since this is a new module it needs integration tests; see https://docs.ansible.com/ansible/devel/dev_guide/platforms/aws_guidelines.html#integration-tests-for-aws-modules

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

bcl · 2019-09-20T20:39:31Z

I think ec2_snapshot_import might be a better name, to parallel ec2_snapshot_copy.

I wondered about that, either way is fine with me -- I was following the function name.

ec2_snapshot and ec2_snapshot_copy support setting tags on the created snapshot; it would be nice if this module had feature parity.

Looks like that's pretty easy to add.

Since this is a new module it needs integration tests; see https://docs.ansible.com/ansible/devel/dev_guide/platforms/aws_guidelines.html#integration-tests-for-aws-modules

This is a hard one, I think. In order to do that you need an ami file in a s3 bucket to import. I'm using this as part of https://weldr.io/lorax/lorax-composer.html so I can make my own images, but I have no idea how to do something like that with the ansible test infrastructure. So suggestions are welcome :)

ansibot · 2019-09-23T13:08:48Z

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2_snapshot_import.py:0:0: parameter-type-not-in-doc: Argument 'tags' in argument_spec defines type as 'dict' but documentation doesn't define type

click here for bot help

ansibot · 2019-09-23T16:29:16Z

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/cloud/amazon/ec2_snapshot_import.py:0:0: invalid-documentation: DOCUMENTATION.options.tags.sample: extra keys not allowed @ data['options']['tags']['sample']. Got {'Name': 'Snapshot-Name'}

click here for bot help

tremble

Please add some integration tests.

[edit] Hmm, just seen the previous comments, ergh, not 100% sure how to test

tremble · 2019-09-27T09:11:38Z

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

+    if not url and not (s3_bucket and s3_key):
+        module.fail_json(msg='url or s3_bucket and s3key are required.')
+    if all([url, s3_bucket, s3_key]):
+        module.fail_json(msg='url or s3_bucket and s3key are required, not all 3.')


These tests are made redundant by mutually_exclusive, required_one_of and required_together below.

This uses the boto3 import_snapshot function to import a disk image from s3 as a snapshot. It also allows setting name:value tags on the new snapshot.

ansibot · 2020-01-27T13:10:25Z

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

ansibot · 2020-03-07T14:03:50Z

@BobBoldin @Constantin007 @Constantin07 @Deepakkothandan @Etherdaemon @Java1Guy @Madhura-CSI @MichaelBaydoun @Sodki @Zeekin @adq @aidan- @akazakov @alachaum @aljazkosir @amir343 @anryko @axc450 @bekelchik @brandond @captainkerk @carchi8py @chenl87 @defunctio @dennisconrad @dkhenry @fiunchinho @fivethreeo @flowerysong @garethr @gobins @gunzy83 @gurumaia @hsingh @hyperized @iiibrad @infectsoldier @j-carl @jarv @jimbydamonk @jmenga @joelthompson @jonhadfield @jonmer85 @jsdalton @jsmartin @kaczynskid @leedm777 @linuxdynasty @loia @lwade @markuman @matt-telstra @michaeljs1990 @miha-plesko @mikedlr @minichate @mjschultz @mmochan @mmoyle @mpechner @nand0p @naslanidis @nathanwebsterdotme @nerzhul @nickball @orthanc @ozbillwang @piontas @pjodouin @prasadkatti @psykotox @ptux @pwnall @raags @rafaeldriutti @rickmendes @roadmapper @rrey @ruimoreira @ryansydnor @sbj-ss @scicoin-project @scottanderson42 @sdubrul @shepdelacreme @silviud @slapula @stefanhorning @steynovich @tastychutney @tdekeyser @tgerla @timmahoney @tomislacker @tremble @tsiganenok @viper233 @waffie1 @whiter @willricardo @wilvk @wimnat @xlab-si @yaakov-github @zacblazic @zbal @zimbatm

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

ansibot · 2020-08-15T17:45:48Z

Thank you very much for your interest in Ansible. Ansible has migrated much of the content into separate repositories to allow for more rapid, independent development. We are closing this issue/PR because this content has been moved to one or more collection repositories.

lib/ansible/modules/cloud/amazon/ec2_snapshot_import.py -> https://galaxy.ansible.com/community/aws

For further information, please see:
https://github.com/ansible/ansibullbot/blob/master/docs/collection_migration.md

ansibot added ci_verified Changes made in this PR are causing tests to fail. 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 Sep 19, 2019

bcl force-pushed the devel-ec2_import_snapshot branch from 387a6f4 to 5081022 Compare September 20, 2019 15:33

flowerysong suggested changes Sep 20, 2019

View reviewed changes

bcl force-pushed the devel-ec2_import_snapshot branch from 5081022 to 9688531 Compare September 20, 2019 22:00

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Sep 23, 2019

bcl force-pushed the devel-ec2_import_snapshot branch from 9688531 to 91ead5c Compare September 23, 2019 16:11

ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Sep 23, 2019

bcl force-pushed the devel-ec2_import_snapshot branch from 91ead5c to 0400a68 Compare September 26, 2019 17:03

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Sep 26, 2019

tremble suggested changes Sep 27, 2019

View reviewed changes

Add an ec2_snapshot_import module

6066484

This uses the boto3 import_snapshot function to import a disk image from s3 as a snapshot. It also allows setting name:value tags on the new snapshot.

bcl force-pushed the devel-ec2_import_snapshot branch from 0400a68 to 6066484 Compare September 27, 2019 22:50

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 Oct 7, 2019

ansibot added the stale_review Updates were made after the last review and the last review is more than 7 days old. label Oct 7, 2019

ansibot removed the needs_triage Needs a first human triage before being processed. label Jan 27, 2020

ansibot added collection Related to Ansible Collections work collection:amazon.aws collection:community.aws needs_collection_redirect https://github.com/ansible/ansibullbot/blob/master/docs/collection_migration.md labels Apr 29, 2020

ansibot removed the collection:amazon.aws label May 16, 2020

ansibot added the bot_closed label Aug 15, 2020

ansibot closed this Aug 15, 2020

ansible locked and limited conversation to collaborators Sep 12, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an ec2_import_snapshot module #62630

Add an ec2_import_snapshot module #62630

bcl commented Sep 19, 2019

ansibot commented Sep 19, 2019

ansibot commented Sep 19, 2019

flowerysong left a comment

bcl commented Sep 20, 2019

ansibot commented Sep 23, 2019

ansibot commented Sep 23, 2019

tremble left a comment •

edited

tremble Sep 27, 2019

ansibot commented Jan 27, 2020

ansibot commented Mar 7, 2020

ansibot commented Aug 15, 2020

Add an ec2_import_snapshot module #62630

Add an ec2_import_snapshot module #62630

Conversation

bcl commented Sep 19, 2019

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibot commented Sep 19, 2019

ansibot commented Sep 19, 2019

flowerysong left a comment

Choose a reason for hiding this comment

bcl commented Sep 20, 2019

ansibot commented Sep 23, 2019

ansibot commented Sep 23, 2019

tremble left a comment • edited

Choose a reason for hiding this comment

tremble Sep 27, 2019

Choose a reason for hiding this comment

ansibot commented Jan 27, 2020

ansibot commented Mar 7, 2020

ansibot commented Aug 15, 2020

tremble left a comment •

edited