delowan.googlecloud.gcp_compute_node_template (1.0.2) — module

Creates a GCP NodeTemplate

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

Represents a NodeTemplate resource. Node templates specify properties for creating sole-tenant nodes, such as node type, vCPU and memory requirements, node affinity labels, and region.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a node template
  google.cloud.gcp_compute_node_template:
    name: test_object
    region: us-central1
    node_type: n1-node-96-624
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Inputs

    
name:
    description:
    - Name of the resource.
    required: false
    type: str

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

region:
    description:
    - Region where nodes using the node template will be created .
    required: true
    type: str

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

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

node_type:
    description:
    - Node type to use for nodes group that are created from this template.
    - Only one of nodeTypeFlexibility and nodeType can be specified.
    required: false
    type: str

description:
    description:
    - An optional textual description of the resource.
    required: false
    type: str

server_binding:
    description:
    - The server binding policy for nodes using this template. Determines where the nodes
      should restart following a maintenance event.
    required: false
    suboptions:
      type:
        description:
        - Type of server binding policy. If `RESTART_NODE_ON_ANY_SERVER`, nodes using
          this template will restart on any physical server following a maintenance event.
        - If `RESTART_NODE_ON_MINIMAL_SERVER`, nodes using this template will restart
          on the same physical server following a maintenance event, instead of being
          live migrated to or restarted on a new physical server. This option may be useful
          if you are using software licenses tied to the underlying server characteristics
          such as physical sockets or cores, to avoid the need for additional licenses
          when maintenance occurs. However, VMs on such nodes will experience outages
          while maintenance is applied.
        - 'Some valid choices include: "RESTART_NODE_ON_ANY_SERVER", "RESTART_NODE_ON_MINIMAL_SERVERS"'
        required: true
        type: str
    type: dict

cpu_overcommit_type:
    default: NONE
    description:
    - CPU overcommit.
    - 'Some valid choices include: "ENABLED", "NONE"'
    required: false
    type: str

node_affinity_labels:
    description:
    - Labels to use for node affinity, which will be used in instance scheduling.
    required: false
    type: dict

service_account_file:
    description:
    - The path of a Service Account JSON file if serviceaccount is selected as type.
    type: path

node_type_flexibility:
    description:
    - Flexible properties for the desired node type. Node groups that use this node template
      will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility
      and nodeType can be specified.
    required: false
    suboptions:
      cpus:
        description:
        - Number of virtual CPUs to use.
        required: false
        type: str
      memory:
        description:
        - Physical memory available to the node, defined in MB.
        required: false
        type: str
    type: dict

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

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

cpuOvercommitType:
  description:
  - CPU overcommit.
  returned: success
  type: str
creationTimestamp:
  description:
  - Creation timestamp in RFC3339 text format.
  returned: success
  type: str
description:
  description:
  - An optional textual description of the resource.
  returned: success
  type: str
name:
  description:
  - Name of the resource.
  returned: success
  type: str
nodeAffinityLabels:
  description:
  - Labels to use for node affinity, which will be used in instance scheduling.
  returned: success
  type: dict
nodeType:
  description:
  - Node type to use for nodes group that are created from this template.
  - Only one of nodeTypeFlexibility and nodeType can be specified.
  returned: success
  type: str
nodeTypeFlexibility:
  contains:
    cpus:
      description:
      - Number of virtual CPUs to use.
      returned: success
      type: str
    localSsd:
      description:
      - Use local SSD .
      returned: success
      type: str
    memory:
      description:
      - Physical memory available to the node, defined in MB.
      returned: success
      type: str
  description:
  - Flexible properties for the desired node type. Node groups that use this node
    template will create nodes of a type that matches these properties. Only one of
    nodeTypeFlexibility and nodeType can be specified.
  returned: success
  type: complex
region:
  description:
  - Region where nodes using the node template will be created .
  returned: success
  type: str
serverBinding:
  contains:
    type:
      description:
      - Type of server binding policy. If `RESTART_NODE_ON_ANY_SERVER`, nodes using
        this template will restart on any physical server following a maintenance
        event.
      - If `RESTART_NODE_ON_MINIMAL_SERVER`, nodes using this template will restart
        on the same physical server following a maintenance event, instead of being
        live migrated to or restarted on a new physical server. This option may be
        useful if you are using software licenses tied to the underlying server characteristics
        such as physical sockets or cores, to avoid the need for additional licenses
        when maintenance occurs. However, VMs on such nodes will experience outages
        while maintenance is applied.
      returned: success
      type: str
  description:
  - The server binding policy for nodes using this template. Determines where the
    nodes should restart following a maintenance event.
  returned: success
  type: complex