mirror of https://github.com/ansible/ansible.git
New Module: gcp_compute_reservation_info (#64134)
The Magician
5 years ago
committed by
ansibot
parent
1a726d436e
commit
def62163c2
@ -0,0 +1,312 @@
|
|||||||
|
#!/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_reservation_info
|
||||||
|
description:
|
||||||
|
- Gather info for GCP Reservation
|
||||||
|
short_description: Gather info for GCP Reservation
|
||||||
|
version_added: '2.10'
|
||||||
|
author: Google Inc. (@googlecloudplatform)
|
||||||
|
requirements:
|
||||||
|
- python >= 2.6
|
||||||
|
- requests >= 2.18.4
|
||||||
|
- google-auth >= 1.3.0
|
||||||
|
options:
|
||||||
|
filters:
|
||||||
|
description:
|
||||||
|
- A list of filter value pairs. Available filters are listed here U(https://cloud.google.com/sdk/gcloud/reference/topic/filters).
|
||||||
|
- Each additional filter in the list will act be added as an AND condition (filter1
|
||||||
|
and filter2) .
|
||||||
|
type: list
|
||||||
|
zone:
|
||||||
|
description:
|
||||||
|
- The zone where the reservation is made.
|
||||||
|
required: true
|
||||||
|
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:
|
||||||
|
- 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: get info on a reservation
|
||||||
|
gcp_compute_reservation_info:
|
||||||
|
zone: us-central1-a
|
||||||
|
filters:
|
||||||
|
- name = test_object
|
||||||
|
project: test_project
|
||||||
|
auth_kind: serviceaccount
|
||||||
|
service_account_file: "/tmp/auth.pem"
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = '''
|
||||||
|
resources:
|
||||||
|
description: List of resources
|
||||||
|
returned: always
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
creationTimestamp:
|
||||||
|
description:
|
||||||
|
- Creation timestamp in RFC3339 text format.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
description:
|
||||||
|
- An optional description of this resource.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
id:
|
||||||
|
description:
|
||||||
|
- The unique identifier for the resource.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
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
|
||||||
|
commitment:
|
||||||
|
description:
|
||||||
|
- Full or partial URL to a parent commitment. This field displays for reservations
|
||||||
|
that are tied to a commitment.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
specificReservationRequired:
|
||||||
|
description:
|
||||||
|
- When set to true, only VMs that target this reservation by name can consume
|
||||||
|
this reservation. Otherwise, it can be consumed by VMs with affinity for any
|
||||||
|
reservation. Defaults to false.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
status:
|
||||||
|
description:
|
||||||
|
- The status of the reservation.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
specificReservation:
|
||||||
|
description:
|
||||||
|
- Reservation for instances with specific machine shapes.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
count:
|
||||||
|
description:
|
||||||
|
- The number of resources that are allocated.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
inUseCount:
|
||||||
|
description:
|
||||||
|
- How many instances are in use.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
instanceProperties:
|
||||||
|
description:
|
||||||
|
- The instance properties for the reservation.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
machineType:
|
||||||
|
description:
|
||||||
|
- The name of the machine type to reserve.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
minCpuPlatform:
|
||||||
|
description:
|
||||||
|
- The minimum CPU platform for the reservation. For example, `"Intel
|
||||||
|
Skylake"`. See U(https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones)
|
||||||
|
for information on available CPU platforms.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
guestAccelerators:
|
||||||
|
description:
|
||||||
|
- Guest accelerator type and count.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
acceleratorType:
|
||||||
|
description:
|
||||||
|
- 'The full or partial URL of the accelerator type to attach to
|
||||||
|
this instance. For example: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100`
|
||||||
|
If you are creating an instance template, specify only the accelerator
|
||||||
|
name.'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
acceleratorCount:
|
||||||
|
description:
|
||||||
|
- The number of the guest accelerator cards exposed to this instance.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
localSsds:
|
||||||
|
description:
|
||||||
|
- The amount of local ssd to reserve with each instance. This reserves
|
||||||
|
disks of type `local-ssd`.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
interface:
|
||||||
|
description:
|
||||||
|
- The disk interface to use for attaching this disk, one of `SCSI`
|
||||||
|
or `NVME`. The default is `SCSI`.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
diskSizeGb:
|
||||||
|
description:
|
||||||
|
- The size of the disk in base-2 GB.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
zone:
|
||||||
|
description:
|
||||||
|
- The zone where the reservation is made.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
'''
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# Imports
|
||||||
|
################################################################################
|
||||||
|
from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest
|
||||||
|
import json
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# Main
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
module = GcpModule(argument_spec=dict(filters=dict(type='list', elements='str'), zone=dict(required=True, type='str')))
|
||||||
|
|
||||||
|
if not module.params['scopes']:
|
||||||
|
module.params['scopes'] = ['https://www.googleapis.com/auth/compute']
|
||||||
|
|
||||||
|
return_value = {'resources': fetch_list(module, collection(module), query_options(module.params['filters']))}
|
||||||
|
module.exit_json(**return_value)
|
||||||
|
|
||||||
|
|
||||||
|
def collection(module):
|
||||||
|
return "https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/reservations".format(**module.params)
|
||||||
|
|
||||||
|
|
||||||
|
def fetch_list(module, link, query):
|
||||||
|
auth = GcpSession(module, 'compute')
|
||||||
|
return auth.list(link, return_if_object, array_name='items', params={'filter': query})
|
||||||
|
|
||||||
|
|
||||||
|
def query_options(filters):
|
||||||
|
if not filters:
|
||||||
|
return ''
|
||||||
|
|
||||||
|
if len(filters) == 1:
|
||||||
|
return filters[0]
|
||||||
|
else:
|
||||||
|
queries = []
|
||||||
|
for f in filters:
|
||||||
|
# For multiple queries, all queries should have ()
|
||||||
|
if f[0] != '(' and f[-1] != ')':
|
||||||
|
queries.append("(%s)" % ''.join(f))
|
||||||
|
else:
|
||||||
|
queries.append(f)
|
||||||
|
|
||||||
|
return ' '.join(queries)
|
||||||
|
|
||||||
|
|
||||||
|
def return_if_object(module, response):
|
||||||
|
# If not found, return nothing.
|
||||||
|
if 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) as inst:
|
||||||
|
module.fail_json(msg="Invalid JSON response with error: %s" % inst)
|
||||||
|
|
||||||
|
if navigate_hash(result, ['error', 'errors']):
|
||||||
|
module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
Loading…
Reference in New Issue