delowan.googlecloud.gcp_tpu_node (1.0.2) — module

Creates a GCP Node

Authors: Google Inc. (@googlecloudplatform)

preview | supported by community

Install collection

Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2


Add to requirements.yml

  collections:
    - name: delowan.googlecloud
      version: 1.0.2

Description

A Cloud TPU instance.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a node
  google.cloud.gcp_tpu_node:
    name: test_object
    zone: us-central1-b
    accelerator_type: v3-8
    tensorflow_version: '1.11'
    cidr_block: 10.2.0.0/29
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Inputs

    
name:
    description:
    - The immutable name of the TPU.
    required: true
    type: str

zone:
    description:
    - The GCP location for the TPU. If it is not provided, the provider zone is used.
    required: false
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the given object should exist in GCP
    type: str

labels:
    description:
    - Resource labels to represent user provided metadata.
    required: false
    type: dict

scopes:
    description:
    - Array of scopes to be used
    elements: str
    type: list

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.
    required: false
    type: str

project:
    description:
    - The Google Cloud Platform project to use.
    type: 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

auth_kind:
    choices:
    - application
    - machineaccount
    - serviceaccount
    description:
    - The type of credential used.
    required: true
    type: str

cidr_block:
    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.
    required: false
    type: str

description:
    description:
    - The user-supplied description of the TPU. Maximum of 512 characters.
    required: false
    type: str

accelerator_type:
    description:
    - The type of hardware accelerators associated with this node.
    required: true
    type: str

scheduling_config:
    description:
    - Sets the scheduling options for this TPU instance.
    required: false
    suboptions:
      preemptible:
        description:
        - Defines whether the TPU instance is preemptible.
        required: true
        type: bool
    type: dict

tensorflow_version:
    description:
    - The version of Tensorflow running in the Node.
    required: true
    type: str

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

use_service_networking:
    default: 'false'
    description:
    - Whether the VPC peering for the node is set up through Service Networking API.
    - The VPC Peering should be set up before provisioning the node. If this field is
      set, cidr_block field should not be specified. If the network that you want to peer
      the TPU Node to is a Shared VPC network, the node must be created with this this
      field enabled.
    required: false
    type: bool

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

Outputs

acceleratorType:
  description:
  - The type of hardware accelerators associated with this node.
  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
description:
  description:
  - The user-supplied description of the TPU. Maximum of 512 characters.
  returned: success
  type: str
labels:
  description:
  - Resource labels to represent user provided metadata.
  returned: success
  type: dict
name:
  description:
  - The immutable name of the TPU.
  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
networkEndpoints:
  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
  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
schedulingConfig:
  contains:
    preemptible:
      description:
      - Defines whether the TPU instance is preemptible.
      returned: success
      type: bool
  description:
  - Sets the scheduling options for this TPU instance.
  returned: success
  type: complex
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
tensorflowVersion:
  description:
  - The version of Tensorflow running in the Node.
  returned: success
  type: str
useServiceNetworking:
  description:
  - Whether the VPC peering for the node is set up through Service Networking API.
  - The VPC Peering should be set up before provisioning the node. If this field is
    set, cidr_block field should not be specified. If the network that you want to
    peer the TPU Node to is a Shared VPC network, the node must be created with this
    this field enabled.
  returned: success
  type: bool
zone:
  description:
  - The GCP location for the TPU. If it is not provided, the provider zone is used.
  returned: success
  type: str