mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-05 02:10:27 -07:00
231 lines
7.4 KiB
Python
231 lines
7.4 KiB
Python
#!/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 *** Type: MMv1 ***
|
|
#
|
|
# ----------------------------------------------------------------------------
|
|
#
|
|
# 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_bigtable_instance_info
|
|
description:
|
|
- Gather info for GCP Instance
|
|
short_description: Gather info for GCP Instance
|
|
author: Google Inc. (@googlecloudplatform)
|
|
requirements:
|
|
- python >= 2.6
|
|
- requests >= 2.18.4
|
|
- google-auth >= 1.3.0
|
|
options:
|
|
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
|
|
- accesstoken
|
|
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
|
|
access_token:
|
|
description:
|
|
- An OAuth2 access token if credential type is accesstoken.
|
|
type: str
|
|
scopes:
|
|
description:
|
|
- Array of scopes to be used
|
|
type: list
|
|
elements: str
|
|
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 access_token using the C(GCP_ACCESS_TOKEN)
|
|
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 an instance
|
|
gcp_bigtable_instance_info:
|
|
project: test_project
|
|
auth_kind: serviceaccount
|
|
service_account_file: "/tmp/auth.pem"
|
|
'''
|
|
|
|
RETURN = '''
|
|
resources:
|
|
description: List of resources
|
|
returned: always
|
|
type: complex
|
|
contains:
|
|
state:
|
|
description:
|
|
- The current state of the instance.
|
|
returned: success
|
|
type: str
|
|
name:
|
|
description:
|
|
- The unique name of the instance.
|
|
returned: success
|
|
type: str
|
|
displayName:
|
|
description:
|
|
- The descriptive name for this instance as it appears in UIs.
|
|
- Can be changed at any time, but should be kept globally unique to avoid confusion.
|
|
returned: success
|
|
type: str
|
|
type:
|
|
description:
|
|
- The type of the instance. Defaults to `PRODUCTION`.
|
|
returned: success
|
|
type: str
|
|
labels:
|
|
description:
|
|
- Labels are a flexible and lightweight mechanism for organizing cloud resources
|
|
into groups that reflect a customer's organizational needs and deployment
|
|
strategies. They can be used to filter resources and aggregate metrics.
|
|
returned: success
|
|
type: dict
|
|
clusters:
|
|
description:
|
|
- An array of clusters. Maximum 4.
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
name:
|
|
description:
|
|
- The unique name of the cluster.
|
|
returned: success
|
|
type: str
|
|
serveNodes:
|
|
description:
|
|
- The number of nodes allocated to this cluster. More nodes enable higher
|
|
throughput and more consistent performance.
|
|
returned: success
|
|
type: int
|
|
defaultStorageType:
|
|
description:
|
|
- The type of storage used by this cluster to serve its parent instance's
|
|
tables, unless explicitly overridden.
|
|
returned: success
|
|
type: str
|
|
location:
|
|
description:
|
|
- The location where this cluster's nodes and storage reside. For best performance,
|
|
clients should be located as close as possible to this cluster. Currently
|
|
only zones are supported, so values should be of the form `projects/<project>/locations/<zone>`.
|
|
returned: success
|
|
type: str
|
|
state:
|
|
description:
|
|
- The current state of the cluster.
|
|
returned: success
|
|
type: str
|
|
'''
|
|
|
|
################################################################################
|
|
# Imports
|
|
################################################################################
|
|
from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule
|
|
import json
|
|
|
|
################################################################################
|
|
# Main
|
|
################################################################################
|
|
|
|
|
|
def main():
|
|
module = GcpModule(argument_spec=dict(), supports_check_mode=True)
|
|
|
|
if not module.params['scopes']:
|
|
module.params['scopes'] = ['https://www.googleapis.com/auth/cloud-platform']
|
|
|
|
return_value = {'resources': fetch_list(module, collection(module))}
|
|
module.exit_json(**return_value)
|
|
|
|
|
|
def collection(module):
|
|
return "https://bigtableadmin.googleapis.com/v2/projects/{project}/instances".format(**module.params)
|
|
|
|
|
|
def fetch_list(module, link):
|
|
auth = GcpSession(module, 'bigtable')
|
|
return auth.list(link, return_if_object, array_name='instances')
|
|
|
|
|
|
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()
|