Initial commit

plugins/modules/cloud/google/gce_img.py

@@ -0,0 +1,206 @@
+#!/usr/bin/python
+# Copyright 2015 Google Inc. All Rights Reserved.
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+"""An Ansible module to utilize GCE image resources."""
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = '''
+---
+module: gce_img
+short_description: utilize GCE image resources
+description:
+    - This module can create and delete GCE private images from gzipped
+      compressed tarball containing raw disk data or from existing detached
+      disks in any zone. U(https://cloud.google.com/compute/docs/images)
+options:
+  name:
+    description:
+      - the name of the image to create or delete
+    required: true
+  description:
+    description:
+      - an optional description
+  family:
+    description:
+      - an optional family name
+  source:
+    description:
+      - the source disk or the Google Cloud Storage URI to create the image from
+  state:
+    description:
+      - desired state of the image
+    default: "present"
+    choices: ["present", "absent"]
+  zone:
+    description:
+      - the zone of the disk specified by source
+    default: "us-central1-a"
+  timeout:
+    description:
+      - timeout for the operation
+    default: 180
+  service_account_email:
+    description:
+      - service account email
+  pem_file:
+    description:
+      - path to the pem file associated with the service account email
+  project_id:
+    description:
+      - your GCE project ID
+requirements:
+    - "python >= 2.6"
+    - "apache-libcloud"
+author: "Tom Melendez (@supertom)"
+'''
+
+EXAMPLES = '''
+# Create an image named test-image from the disk 'test-disk' in zone us-central1-a.
+- gce_img:
+    name: test-image
+    source: test-disk
+    zone: us-central1-a
+    state: present
+
+# Create an image named test-image from a tarball in Google Cloud Storage.
+- gce_img:
+    name: test-image
+    source: https://storage.googleapis.com/bucket/path/to/image.tgz
+
+# Alternatively use the gs scheme
+- gce_img:
+    name: test-image
+    source: gs://bucket/path/to/image.tgz
+
+# Delete an image named test-image.
+- gce_img:
+    name: test-image
+    state: absent
+'''
+
+
+try:
+    import libcloud
+    from libcloud.compute.types import Provider
+    from libcloud.compute.providers import get_driver
+    from libcloud.common.google import GoogleBaseError
+    from libcloud.common.google import ResourceExistsError
+    from libcloud.common.google import ResourceNotFoundError
+    _ = Provider.GCE
+    has_libcloud = True
+except ImportError:
+    has_libcloud = False
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.gce import gce_connect
+
+
+GCS_URI = 'https://storage.googleapis.com/'
+
+
+def create_image(gce, name, module):
+    """Create an image with the specified name."""
+    source = module.params.get('source')
+    zone = module.params.get('zone')
+    desc = module.params.get('description')
+    timeout = module.params.get('timeout')
+    family = module.params.get('family')
+
+    if not source:
+        module.fail_json(msg='Must supply a source', changed=False)
+
+    if source.startswith(GCS_URI):
+        # source is a Google Cloud Storage URI
+        volume = source
+    elif source.startswith('gs://'):
+        # libcloud only accepts https URI.
+        volume = source.replace('gs://', GCS_URI)
+    else:
+        try:
+            volume = gce.ex_get_volume(source, zone)
+        except ResourceNotFoundError:
+            module.fail_json(msg='Disk %s not found in zone %s' % (source, zone),
+                             changed=False)
+        except GoogleBaseError as e:
+            module.fail_json(msg=str(e), changed=False)
+
+    gce_extra_args = {}
+    if family is not None:
+        gce_extra_args['family'] = family
+
+    old_timeout = gce.connection.timeout
+    try:
+        gce.connection.timeout = timeout
+        gce.ex_create_image(name, volume, desc, use_existing=False, **gce_extra_args)
+        return True
+    except ResourceExistsError:
+        return False
+    except GoogleBaseError as e:
+        module.fail_json(msg=str(e), changed=False)
+    finally:
+        gce.connection.timeout = old_timeout
+
+
+def delete_image(gce, name, module):
+    """Delete a specific image resource by name."""
+    try:
+        gce.ex_delete_image(name)
+        return True
+    except ResourceNotFoundError:
+        return False
+    except GoogleBaseError as e:
+        module.fail_json(msg=str(e), changed=False)
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            name=dict(required=True),
+            family=dict(),
+            description=dict(),
+            source=dict(),
+            state=dict(default='present', choices=['present', 'absent']),
+            zone=dict(default='us-central1-a'),
+            service_account_email=dict(),
+            pem_file=dict(type='path'),
+            project_id=dict(),
+            timeout=dict(type='int', default=180)
+        )
+    )
+
+    if not has_libcloud:
+        module.fail_json(msg='libcloud with GCE support is required.')
+
+    gce = gce_connect(module)
+
+    name = module.params.get('name')
+    state = module.params.get('state')
+    family = module.params.get('family')
+    changed = False
+
+    if family is not None and hasattr(libcloud, '__version__') and libcloud.__version__ <= '0.20.1':
+        module.fail_json(msg="Apache Libcloud 1.0.0+ is required to use 'family' option",
+                         changed=False)
+
+    # user wants to create an image.
+    if state == 'present':
+        changed = create_image(gce, name, module)
+
+    # user wants to delete the image.
+    if state == 'absent':
+        changed = delete_image(gce, name, module)
+
+    module.exit_json(changed=changed, name=name)
+
+
+if __name__ == '__main__':
+    main()