From 1d6d19f4007f1872f88d9aea69e18e8bc2a7a6c2 Mon Sep 17 00:00:00 2001 From: The Magician Date: Thu, 13 Jun 2019 12:11:47 -0700 Subject: [PATCH] New Module: gcp_tpu_node_facts (#57730) --- lib/ansible/module_utils/gcp_utils.py | 11 +- .../cloud/google/gcp_tpu_node_facts.py | 211 ++++++++++++++++++ 2 files changed, 216 insertions(+), 6 deletions(-) create mode 100644 lib/ansible/modules/cloud/google/gcp_tpu_node_facts.py diff --git a/lib/ansible/module_utils/gcp_utils.py b/lib/ansible/module_utils/gcp_utils.py index b7a897b58b6..d2f9b01afe9 100644 --- a/lib/ansible/module_utils/gcp_utils.py +++ b/lib/ansible/module_utils/gcp_utils.py @@ -49,6 +49,10 @@ def remove_nones_from_dict(obj): value = obj[key] if value is not None and value != {} and value != []: new_obj[key] = value + + # Blank dictionaries should return None or GCP API may complain. + if not new_obj: + return None return new_obj @@ -76,12 +80,7 @@ class GcpSession(object): def get(self, url, body=None, **kwargs): kwargs.update({'json': body, 'headers': self._headers()}) try: - # Ignore the google-auth library warning for user credentials. More - # details: https://github.com/googleapis/google-auth-library-python/issues/271 - import warnings - with warnings.catch_warnings(): - warnings.filterwarnings("ignore", "Your application has authenticated using end user credentials") - return self.session().get(url, **kwargs) + return self.session().get(url, **kwargs) except getattr(requests.exceptions, 'RequestException') as inst: self.module.fail_json(msg=inst.message) diff --git a/lib/ansible/modules/cloud/google/gcp_tpu_node_facts.py b/lib/ansible/modules/cloud/google/gcp_tpu_node_facts.py new file mode 100644 index 00000000000..f11e6ae1db1 --- /dev/null +++ b/lib/ansible/modules/cloud/google/gcp_tpu_node_facts.py @@ -0,0 +1,211 @@ +#!/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_tpu_node_facts +description: +- Gather facts for GCP Node +short_description: Gather facts for GCP Node +version_added: 2.9 +author: Google Inc. (@googlecloudplatform) +requirements: +- python >= 2.6 +- requests >= 2.18.4 +- google-auth >= 1.3.0 +options: + zone: + description: + - The GCP location for the TPU. + required: true +extends_documentation_fragment: gcp +''' + +EXAMPLES = ''' +- name: " a node facts" + gcp_tpu_node_facts: + zone: us-central1-b + project: test_project + auth_kind: serviceaccount + service_account_file: "/tmp/auth.pem" + state: facts +''' + +RETURN = ''' +resources: + description: List of resources + returned: always + type: complex + contains: + name: + description: + - The immutable name of the TPU. + returned: success + type: str + description: + description: + - The user-supplied description of the TPU. Maximum of 512 characters. + returned: success + type: str + acceleratorType: + description: + - The type of hardware accelerators associated with this node. + returned: success + type: str + tensorflowVersion: + description: + - The version of Tensorflow running in the Node. + returned: success + type: str + network: + description: + - The name of a network to peer the TPU node to. It must be a preexisting Compute + Engine network inside of the project on which this API has been activated. + If none is provided, "default" will be used. + returned: success + type: str + cidrBlock: + description: + - The CIDR block that the TPU node will use when selecting an IP address. This + CIDR block must be a /29 block; the Compute Engine networks API forbids a + smaller block, and using a larger block would be wasteful (a node can only + consume one IP address). + - Errors will occur if the CIDR block has already been used for a currently + existing TPU node, the CIDR block conflicts with any subnetworks in the user's + provided network, or the provided network is peered with another network that + is using that CIDR block. + returned: success + type: str + serviceAccount: + description: + - The service account used to run the tensor flow services within the node. + To share resources, including Google Cloud Storage data, with the Tensorflow + job running in the Node, this account must have permissions to that data. + returned: success + type: str + schedulingConfig: + description: + - Sets the scheduling options for this TPU instance. + returned: success + type: complex + contains: + preemptible: + description: + - Defines whether the TPU instance is preemptible. + returned: success + type: bool + networkEndpoints: + description: + - The network endpoints where TPU workers can be accessed and sent work. + - It is recommended that Tensorflow clients of the node first reach out to the + first (index 0) entry. + returned: success + type: complex + contains: + ipAddress: + description: + - The IP address of this network endpoint. + returned: success + type: str + port: + description: + - The port of this network endpoint. + returned: success + type: int + labels: + description: + - Resource labels to represent user provided metadata. + returned: success + type: dict + zone: + description: + - The GCP location for the TPU. + 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(zone=dict(required=True, type='str'))) + + if not module.params['scopes']: + module.params['scopes'] = ['https://www.googleapis.com/auth/cloud-platform'] + + items = fetch_list(module, collection(module)) + if items.get('nodes'): + items = items.get('nodes') + else: + items = [] + return_value = {'resources': items} + module.exit_json(**return_value) + + +def collection(module): + return "https://tpu.googleapis.com/v1/projects/{project}/locations/{zone}/nodes".format(**module.params) + + +def fetch_list(module, link): + auth = GcpSession(module, 'tpu') + response = auth.get(link) + return return_if_object(module, response) + + +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()