mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
228 lines
6.8 KiB
Python
228 lines
6.8 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: ec2_ami_copy
|
|
short_description: copies AMI between AWS regions, return new image id
|
|
description:
|
|
- Copies AMI from a source region to a destination region. B(Since version 2.3 this module depends on boto3.)
|
|
version_added: "2.0"
|
|
options:
|
|
source_region:
|
|
description:
|
|
- The source region the AMI should be copied from.
|
|
required: true
|
|
source_image_id:
|
|
description:
|
|
- The ID of the AMI in source region that should be copied.
|
|
required: true
|
|
name:
|
|
description:
|
|
- The name of the new AMI to copy. (As of 2.3 the default is 'default', in prior versions it was 'null'.)
|
|
required: false
|
|
default: "default"
|
|
description:
|
|
description:
|
|
- An optional human-readable string describing the contents and purpose of the new AMI.
|
|
required: false
|
|
default: null
|
|
encrypted:
|
|
description:
|
|
- Whether or not the destination snapshots of the copied AMI should be encrypted.
|
|
required: false
|
|
default: null
|
|
version_added: "2.2"
|
|
kms_key_id:
|
|
description:
|
|
- KMS key id used to encrypt image. If not specified, uses default EBS Customer Master Key (CMK) for your account.
|
|
required: false
|
|
default: null
|
|
version_added: "2.2"
|
|
wait:
|
|
description:
|
|
- Wait for the copied AMI to be in state 'available' before returning.
|
|
required: false
|
|
default: "no"
|
|
choices: [ "yes", "no" ]
|
|
wait_timeout:
|
|
description:
|
|
- How long before wait gives up, in seconds. (As of 2.3 this option is deprecated. See boto3 Waiters)
|
|
required: false
|
|
default: 1200
|
|
tags:
|
|
description:
|
|
- A hash/dictionary of tags to add to the new copied AMI; '{"key":"value"}' and '{"key":"value","key":"value"}'
|
|
required: false
|
|
default: null
|
|
author: "Amir Moulavi <amir.moulavi@gmail.com>, Tim C <defunct@defunct.io>"
|
|
extends_documentation_fragment:
|
|
- aws
|
|
- ec2
|
|
requirements:
|
|
- boto3
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Basic AMI Copy
|
|
- ec2_ami_copy:
|
|
source_region: us-east-1
|
|
region: eu-west-1
|
|
source_image_id: ami-xxxxxxx
|
|
|
|
# AMI copy wait until available
|
|
- ec2_ami_copy:
|
|
source_region: us-east-1
|
|
region: eu-west-1
|
|
source_image_id: ami-xxxxxxx
|
|
wait: yes
|
|
register: image_id
|
|
|
|
# Named AMI copy
|
|
- ec2_ami_copy:
|
|
source_region: us-east-1
|
|
region: eu-west-1
|
|
source_image_id: ami-xxxxxxx
|
|
name: My-Awesome-AMI
|
|
description: latest patch
|
|
|
|
# Tagged AMI copy
|
|
- ec2_ami_copy:
|
|
source_region: us-east-1
|
|
region: eu-west-1
|
|
source_image_id: ami-xxxxxxx
|
|
tags:
|
|
Name: My-Super-AMI
|
|
Patch: 1.2.3
|
|
|
|
# Encrypted AMI copy
|
|
- ec2_ami_copy:
|
|
source_region: us-east-1
|
|
region: eu-west-1
|
|
source_image_id: ami-xxxxxxx
|
|
encrypted: yes
|
|
|
|
# Encrypted AMI copy with specified key
|
|
- ec2_ami_copy:
|
|
source_region: us-east-1
|
|
region: eu-west-1
|
|
source_image_id: ami-xxxxxxx
|
|
encrypted: yes
|
|
kms_key_id: arn:aws:kms:us-east-1:XXXXXXXXXXXX:key/746de6ea-50a4-4bcb-8fbc-e3b29f2d367b
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.ec2 import (boto3_conn, ec2_argument_spec, get_aws_connection_info)
|
|
|
|
import traceback
|
|
|
|
try:
|
|
import boto
|
|
import boto.ec2
|
|
HAS_BOTO = True
|
|
except ImportError:
|
|
HAS_BOTO = False
|
|
|
|
try:
|
|
import boto3
|
|
from botocore.exceptions import ClientError, NoCredentialsError, NoRegionError, WaiterError
|
|
HAS_BOTO3 = True
|
|
except ImportError:
|
|
HAS_BOTO3 = False
|
|
|
|
|
|
|
|
def copy_image(module, ec2):
|
|
"""
|
|
Copies an AMI
|
|
|
|
module : AnsibleModule object
|
|
ec2: ec2 connection object
|
|
"""
|
|
|
|
tags = module.params.get('tags')
|
|
|
|
params = {'SourceRegion': module.params.get('source_region'),
|
|
'SourceImageId': module.params.get('source_image_id'),
|
|
'Name': module.params.get('name'),
|
|
'Description': module.params.get('description'),
|
|
'Encrypted': module.params.get('encrypted'),
|
|
}
|
|
if module.params.get('kms_key_id'):
|
|
params['KmsKeyId'] = module.params.get('kms_key_id')
|
|
|
|
try:
|
|
image_id = ec2.copy_image(**params)['ImageId']
|
|
if module.params.get('wait'):
|
|
ec2.get_waiter('image_available').wait(ImageIds=[image_id])
|
|
if module.params.get('tags'):
|
|
ec2.create_tags(
|
|
Resources=[image_id],
|
|
Tags=[{'Key' : k, 'Value': v} for k,v in module.params.get('tags').items()]
|
|
)
|
|
|
|
module.exit_json(changed=True, image_id=image_id)
|
|
except WaiterError as we:
|
|
module.fail_json(msg='An error occurred waiting for the image to become available. (%s)' % str(we), exception=traceback.format_exc())
|
|
except ClientError as ce:
|
|
module.fail_json(msg=ce.message)
|
|
except NoCredentialsError:
|
|
module.fail_json(msg='Unable to authenticate, AWS credentials are invalid.')
|
|
except Exception as e:
|
|
module.fail_json(msg='Unhandled exception. (%s)' % str(e))
|
|
|
|
|
|
def main():
|
|
argument_spec = ec2_argument_spec()
|
|
argument_spec.update(dict(
|
|
source_region=dict(required=True),
|
|
source_image_id=dict(required=True),
|
|
name=dict(default='default'),
|
|
description=dict(default=''),
|
|
encrypted=dict(type='bool', default=False, required=False),
|
|
kms_key_id=dict(type='str', required=False),
|
|
wait=dict(type='bool', default=False),
|
|
wait_timeout=dict(default=1200),
|
|
tags=dict(type='dict')))
|
|
|
|
module = AnsibleModule(argument_spec=argument_spec)
|
|
|
|
if not HAS_BOTO:
|
|
module.fail_json(msg='boto required for this module')
|
|
# TODO: Check botocore version
|
|
region, ec2_url, aws_connect_params = get_aws_connection_info(module, boto3=True)
|
|
|
|
if HAS_BOTO3:
|
|
|
|
try:
|
|
ec2 = boto3_conn(module, conn_type='client', resource='ec2', region=region, endpoint=ec2_url,
|
|
**aws_connect_params)
|
|
except NoRegionError:
|
|
module.fail_json(msg='AWS Region is required')
|
|
else:
|
|
module.fail_json(msg='boto3 required for this module')
|
|
|
|
copy_image(module, ec2)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|