diff options
Diffstat (limited to 'lib/ansible/modules/cloud/google/gcp_compute_region_disk.py')
| -rw-r--r-- | lib/ansible/modules/cloud/google/gcp_compute_region_disk.py | 672 |
1 files changed, 0 insertions, 672 deletions
diff --git a/lib/ansible/modules/cloud/google/gcp_compute_region_disk.py b/lib/ansible/modules/cloud/google/gcp_compute_region_disk.py deleted file mode 100644 index 45fd14d526..0000000000 --- a/lib/ansible/modules/cloud/google/gcp_compute_region_disk.py +++ /dev/null @@ -1,672 +0,0 @@ -#!/usr/bin/python -# -*- coding: utf-8 -*- -# -# Copyright (C) 2017 Google -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) -# ---------------------------------------------------------------------------- -# -# *** AUTO GENERATED CODE *** AUTO GENERATED CODE *** -# -# ---------------------------------------------------------------------------- -# -# This file is automatically generated by Magic Modules and manual -# changes will be clobbered when the file is regenerated. -# -# Please read more about how to change this file at -# https://www.github.com/GoogleCloudPlatform/magic-modules -# -# ---------------------------------------------------------------------------- - -from __future__ import absolute_import, division, print_function - -__metaclass__ = type - -################################################################################ -# Documentation -################################################################################ - -ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'} - -DOCUMENTATION = ''' ---- -module: gcp_compute_region_disk -description: -- Persistent disks are durable storage devices that function similarly to the physical - disks in a desktop or a server. Compute Engine manages the hardware behind these - devices to ensure data redundancy and optimize performance for you. Persistent disks - are available as either standard hard disk drives (HDD) or solid-state drives (SSD). -- Persistent disks are located independently from your virtual machine instances, - so you can detach or move persistent disks to keep your data even after you delete - your instances. Persistent disk performance scales automatically with size, so you - can resize your existing persistent disks or add more persistent disks to an instance - to meet your performance and storage space requirements. -- Add a persistent disk to your instance when you need reliable and affordable storage - with consistent performance characteristics. -short_description: Creates a GCP RegionDisk -version_added: '2.8' -author: Google Inc. (@googlecloudplatform) -requirements: -- python >= 2.6 -- requests >= 2.18.4 -- google-auth >= 1.3.0 -options: - state: - description: - - Whether the given object should exist in GCP - choices: - - present - - absent - default: present - type: str - description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - required: false - type: str - labels: - description: - - Labels to apply to this disk. A list of key->value pairs. - required: false - type: dict - licenses: - description: - - Any applicable publicly visible licenses. - required: false - type: list - name: - description: - - Name of the resource. Provided by the client when the resource is created. The - name must be 1-63 characters long, and comply with RFC1035. Specifically, the - name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - required: true - type: str - size_gb: - description: - - Size of the persistent disk, specified in GB. You can specify this field when - creating a persistent disk using the sourceImage or sourceSnapshot parameter, - or specify it alone to create an empty persistent disk. - - If you specify this field along with sourceImage or sourceSnapshot, the value - of sizeGb must not be less than the size of the sourceImage or the size of the - snapshot. - required: false - type: int - physical_block_size_bytes: - description: - - Physical block size of the persistent disk, in bytes. If not present in a request, - a default value is used. Currently supported sizes are 4096 and 16384, other - sizes may be added in the future. - - If an unsupported value is requested, the error message will list the supported - values for the caller's project. - required: false - type: int - replica_zones: - description: - - URLs of the zones where the disk should be replicated to. - required: true - type: list - type: - description: - - URL of the disk type resource describing which disk type to use to create the - disk. Provide this when creating the disk. - required: false - type: str - region: - description: - - A reference to the region where the disk resides. - required: true - type: str - disk_encryption_key: - description: - - Encrypts the disk using a customer-supplied encryption key. - - After you encrypt a disk with a customer-supplied key, you must provide the - same key if you use the disk later (e.g. to create a disk snapshot or an image, - or to attach the disk to a virtual machine). - - Customer-supplied encryption keys do not protect access to metadata of the disk. - - If you do not provide an encryption key when creating the disk, then the disk - will be encrypted using an automatically generated key and you do not need to - provide a key to use the disk later. - required: false - type: dict - suboptions: - raw_key: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - required: false - type: str - source_snapshot: - description: - - The source snapshot used to create this disk. You can provide this as a partial - or full URL to the resource. - - 'This field represents a link to a Snapshot resource in GCP. It can be specified - in two ways. First, you can place a dictionary with key ''selfLink'' and value - of your resource''s selfLink Alternatively, you can add `register: name-of-resource` - to a gcp_compute_snapshot task and then set this source_snapshot field to "{{ - name-of-resource }}"' - required: false - type: dict - source_snapshot_encryption_key: - description: - - The customer-supplied encryption key of the source snapshot. Required if the - source snapshot is protected by a customer-supplied encryption key. - required: false - type: dict - suboptions: - raw_key: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - required: false - type: str - project: - description: - - The Google Cloud Platform project to use. - type: str - auth_kind: - description: - - The type of credential used. - type: str - required: true - choices: - - application - - machineaccount - - serviceaccount - service_account_contents: - description: - - The contents of a Service Account JSON file, either in a dictionary or as a - JSON string that represents it. - type: jsonarg - service_account_file: - description: - - The path of a Service Account JSON file if serviceaccount is selected as type. - type: path - service_account_email: - description: - - An optional service account email address if machineaccount is selected and - the user does not wish to use the default email. - type: str - scopes: - description: - - Array of scopes to be used - type: list - env_type: - description: - - Specifies which Ansible environment you're running this module within. - - This should not be set unless you know what you're doing. - - This only alters the User Agent string for any API requests. - type: str -notes: -- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/beta/regionDisks)' -- 'Adding or Resizing Regional Persistent Disks: U(https://cloud.google.com/compute/docs/disks/regional-persistent-disk)' -- for authentication, you can set service_account_file using the C(gcp_service_account_file) - env variable. -- for authentication, you can set service_account_contents using the C(GCP_SERVICE_ACCOUNT_CONTENTS) - env variable. -- For authentication, you can set service_account_email using the C(GCP_SERVICE_ACCOUNT_EMAIL) - env variable. -- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable. -- For authentication, you can set scopes using the C(GCP_SCOPES) env variable. -- Environment variables values will only be used if the playbook values are not set. -- The I(service_account_email) and I(service_account_file) options are mutually exclusive. -''' - -EXAMPLES = ''' -- name: create a region disk - gcp_compute_region_disk: - name: test_object - size_gb: 500 - disk_encryption_key: - raw_key: SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0= - region: us-central1 - replica_zones: - - https://www.googleapis.com/compute/v1/projects/google.com:graphite-playground/zones/us-central1-a - - https://www.googleapis.com/compute/v1/projects/google.com:graphite-playground/zones/us-central1-b - project: test_project - auth_kind: serviceaccount - service_account_file: "/tmp/auth.pem" - state: present -''' - -RETURN = ''' -labelFingerprint: - description: - - The fingerprint used for optimistic locking of this resource. Used internally - during updates. - returned: success - type: str -creationTimestamp: - description: - - Creation timestamp in RFC3339 text format. - returned: success - type: str -description: - description: - - An optional description of this resource. Provide this property when you create - the resource. - returned: success - type: str -id: - description: - - The unique identifier for the resource. - returned: success - type: int -lastAttachTimestamp: - description: - - Last attach timestamp in RFC3339 text format. - returned: success - type: str -lastDetachTimestamp: - description: - - Last detach timestamp in RFC3339 text format. - returned: success - type: str -labels: - description: - - Labels to apply to this disk. A list of key->value pairs. - returned: success - type: dict -licenses: - description: - - Any applicable publicly visible licenses. - returned: success - type: list -name: - description: - - Name of the resource. Provided by the client when the resource is created. The - name must be 1-63 characters long, and comply with RFC1035. Specifically, the - name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` - which means the first character must be a lowercase letter, and all following - characters must be a dash, lowercase letter, or digit, except the last character, - which cannot be a dash. - returned: success - type: str -sizeGb: - description: - - Size of the persistent disk, specified in GB. You can specify this field when - creating a persistent disk using the sourceImage or sourceSnapshot parameter, - or specify it alone to create an empty persistent disk. - - If you specify this field along with sourceImage or sourceSnapshot, the value - of sizeGb must not be less than the size of the sourceImage or the size of the - snapshot. - returned: success - type: int -users: - description: - - 'Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance - .' - returned: success - type: list -physicalBlockSizeBytes: - description: - - Physical block size of the persistent disk, in bytes. If not present in a request, - a default value is used. Currently supported sizes are 4096 and 16384, other sizes - may be added in the future. - - If an unsupported value is requested, the error message will list the supported - values for the caller's project. - returned: success - type: int -replicaZones: - description: - - URLs of the zones where the disk should be replicated to. - returned: success - type: list -type: - description: - - URL of the disk type resource describing which disk type to use to create the - disk. Provide this when creating the disk. - returned: success - type: str -region: - description: - - A reference to the region where the disk resides. - returned: success - type: str -diskEncryptionKey: - description: - - Encrypts the disk using a customer-supplied encryption key. - - After you encrypt a disk with a customer-supplied key, you must provide the same - key if you use the disk later (e.g. to create a disk snapshot or an image, or - to attach the disk to a virtual machine). - - Customer-supplied encryption keys do not protect access to metadata of the disk. - - If you do not provide an encryption key when creating the disk, then the disk - will be encrypted using an automatically generated key and you do not need to - provide a key to use the disk later. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - key that protects this resource. - returned: success - type: str -sourceSnapshot: - description: - - The source snapshot used to create this disk. You can provide this as a partial - or full URL to the resource. - returned: success - type: dict -sourceSnapshotEncryptionKey: - description: - - The customer-supplied encryption key of the source snapshot. Required if the source - snapshot is protected by a customer-supplied encryption key. - returned: success - type: complex - contains: - rawKey: - description: - - Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 - base64 to either encrypt or decrypt this resource. - returned: success - type: str - sha256: - description: - - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption - key that protects this resource. - returned: success - type: str -sourceSnapshotId: - description: - - The unique ID of the snapshot used to create this disk. This value identifies - the exact snapshot that was used to create this persistent disk. For example, - if you created the persistent disk from a snapshot that was later deleted and - recreated under the same name, the source snapshot ID would identify the exact - version of the snapshot that was used. - returned: success - type: str -''' - -################################################################################ -# Imports -################################################################################ - -from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest, remove_nones_from_dict, replace_resource_dict -import json -import re -import time - -################################################################################ -# Main -################################################################################ - - -def main(): - """Main function""" - - module = GcpModule( - argument_spec=dict( - state=dict(default='present', choices=['present', 'absent'], type='str'), - description=dict(type='str'), - labels=dict(type='dict'), - licenses=dict(type='list', elements='str'), - name=dict(required=True, type='str'), - size_gb=dict(type='int'), - physical_block_size_bytes=dict(type='int'), - replica_zones=dict(required=True, type='list', elements='str'), - type=dict(type='str'), - region=dict(required=True, type='str'), - disk_encryption_key=dict(type='dict', options=dict(raw_key=dict(type='str'))), - source_snapshot=dict(type='dict'), - source_snapshot_encryption_key=dict(type='dict', options=dict(raw_key=dict(type='str'))), - ) - ) - - if not module.params['scopes']: - module.params['scopes'] = ['https://www.googleapis.com/auth/compute'] - - state = module.params['state'] - kind = 'compute#disk' - - fetch = fetch_resource(module, self_link(module), kind) - changed = False - - if fetch: - if state == 'present': - if is_different(module, fetch): - update(module, self_link(module), kind, fetch) - fetch = fetch_resource(module, self_link(module), kind) - changed = True - else: - delete(module, self_link(module), kind) - fetch = {} - changed = True - else: - if state == 'present': - fetch = create(module, collection(module), kind) - changed = True - else: - fetch = {} - - fetch.update({'changed': changed}) - - module.exit_json(**fetch) - - -def create(module, link, kind): - auth = GcpSession(module, 'compute') - return wait_for_operation(module, auth.post(link, resource_to_request(module))) - - -def update(module, link, kind, fetch): - update_fields(module, resource_to_request(module), response_to_hash(module, fetch)) - return fetch_resource(module, self_link(module), kind) - - -def update_fields(module, request, response): - if response.get('labels') != request.get('labels'): - label_fingerprint_update(module, request, response) - if response.get('sizeGb') != request.get('sizeGb'): - size_gb_update(module, request, response) - - -def label_fingerprint_update(module, request, response): - auth = GcpSession(module, 'compute') - auth.post( - ''.join(["https://www.googleapis.com/compute/v1/", "projects/{project}/regions/{region}/disks/{name}/setLabels"]).format(**module.params), - {u'labelFingerprint': response.get('labelFingerprint'), u'labels': module.params.get('labels')}, - ) - - -def size_gb_update(module, request, response): - auth = GcpSession(module, 'compute') - auth.post( - ''.join(["https://www.googleapis.com/compute/v1/", "projects/{project}/regions/{region}/disks/{name}/resize"]).format(**module.params), - {u'sizeGb': module.params.get('size_gb')}, - ) - - -def delete(module, link, kind): - auth = GcpSession(module, 'compute') - return wait_for_operation(module, auth.delete(link)) - - -def resource_to_request(module): - request = { - u'kind': 'compute#disk', - u'diskEncryptionKey': RegionDiskDiskencryptionkey(module.params.get('disk_encryption_key', {}), module).to_request(), - u'sourceSnapshotEncryptionKey': RegionDiskSourcesnapshotencryptionkey(module.params.get('source_snapshot_encryption_key', {}), module).to_request(), - u'description': module.params.get('description'), - u'labels': module.params.get('labels'), - u'licenses': module.params.get('licenses'), - u'name': module.params.get('name'), - u'sizeGb': module.params.get('size_gb'), - u'physicalBlockSizeBytes': module.params.get('physical_block_size_bytes'), - u'replicaZones': module.params.get('replica_zones'), - u'type': region_disk_type_selflink(module.params.get('type'), module.params), - } - return_vals = {} - for k, v in request.items(): - if v or v is False: - return_vals[k] = v - - return return_vals - - -def fetch_resource(module, link, kind, allow_not_found=True): - auth = GcpSession(module, 'compute') - return return_if_object(module, auth.get(link), kind, allow_not_found) - - -def self_link(module): - return "https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{name}".format(**module.params) - - -def collection(module): - return "https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks".format(**module.params) - - -def return_if_object(module, response, kind, allow_not_found=False): - # If not found, return nothing. - if allow_not_found and response.status_code == 404: - return None - - # If no content, return nothing. - if response.status_code == 204: - return None - - try: - module.raise_for_status(response) - result = response.json() - except getattr(json.decoder, 'JSONDecodeError', ValueError): - module.fail_json(msg="Invalid JSON response with error: %s" % response.text) - - if navigate_hash(result, ['error', 'errors']): - module.fail_json(msg=navigate_hash(result, ['error', 'errors'])) - - return result - - -def is_different(module, response): - request = resource_to_request(module) - response = response_to_hash(module, response) - - # Remove all output-only from response. - response_vals = {} - for k, v in response.items(): - if k in request: - response_vals[k] = v - - request_vals = {} - for k, v in request.items(): - if k in response: - request_vals[k] = v - - return GcpRequest(request_vals) != GcpRequest(response_vals) - - -# Remove unnecessary properties from the response. -# This is for doing comparisons with Ansible's current parameters. -def response_to_hash(module, response): - return { - u'labelFingerprint': response.get(u'labelFingerprint'), - u'creationTimestamp': response.get(u'creationTimestamp'), - u'description': response.get(u'description'), - u'id': response.get(u'id'), - u'lastAttachTimestamp': response.get(u'lastAttachTimestamp'), - u'lastDetachTimestamp': response.get(u'lastDetachTimestamp'), - u'labels': response.get(u'labels'), - u'licenses': response.get(u'licenses'), - u'name': module.params.get('name'), - u'sizeGb': response.get(u'sizeGb'), - u'users': response.get(u'users'), - u'physicalBlockSizeBytes': response.get(u'physicalBlockSizeBytes'), - u'replicaZones': response.get(u'replicaZones'), - u'type': response.get(u'type'), - } - - -def zone_selflink(name, params): - if name is None: - return - url = r"https://www.googleapis.com/compute/v1/projects/.*/zones/.*" - if not re.match(url, name): - name = "https://www.googleapis.com/compute/v1/projects/{project}/zones/%s".format(**params) % name - return name - - -def region_disk_type_selflink(name, params): - if name is None: - return - url = r"https://www.googleapis.com/compute/v1/projects/.*/regions/.*/diskTypes/.*" - if not re.match(url, name): - name = "https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/diskTypes/%s".format(**params) % name - return name - - -def async_op_url(module, extra_data=None): - if extra_data is None: - extra_data = {} - url = "https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/operations/{op_id}" - combined = extra_data.copy() - combined.update(module.params) - return url.format(**combined) - - -def wait_for_operation(module, response): - op_result = return_if_object(module, response, 'compute#operation') - if op_result is None: - return {} - status = navigate_hash(op_result, ['status']) - wait_done = wait_for_completion(status, op_result, module) - return fetch_resource(module, navigate_hash(wait_done, ['targetLink']), 'compute#disk') - - -def wait_for_completion(status, op_result, module): - op_id = navigate_hash(op_result, ['name']) - op_uri = async_op_url(module, {'op_id': op_id}) - while status != 'DONE': - raise_if_errors(op_result, ['error', 'errors'], module) - time.sleep(1.0) - op_result = fetch_resource(module, op_uri, 'compute#operation', False) - status = navigate_hash(op_result, ['status']) - return op_result - - -def raise_if_errors(response, err_path, module): - errors = navigate_hash(response, err_path) - if errors is not None: - module.fail_json(msg=errors) - - -class RegionDiskDiskencryptionkey(object): - def __init__(self, request, module): - self.module = module - if request: - self.request = request - else: - self.request = {} - - def to_request(self): - return remove_nones_from_dict({u'rawKey': self.request.get('raw_key')}) - - def from_response(self): - return remove_nones_from_dict({u'rawKey': self.request.get(u'rawKey')}) - - -class RegionDiskSourcesnapshotencryptionkey(object): - def __init__(self, request, module): - self.module = module - if request: - self.request = request - else: - self.request = {} - - def to_request(self): - return remove_nones_from_dict({u'rawKey': self.request.get('raw_key')}) - - def from_response(self): - return remove_nones_from_dict({u'rawKey': self.request.get(u'rawKey')}) - - -if __name__ == '__main__': - main() |