delowan.googlecloud.gcp_compute_node_group (1.0.2) — module

Creates a GCP NodeGroup

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 NodeGroup resource to manage a group of sole-tenant nodes.


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: "{{ resource_name }}"
    region: us-central1
    node_type: n1-node-96-624
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: node_template
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a node group
  google.cloud.gcp_compute_node_group:
    name: test_object
    zone: us-central1-a
    description: example group for ansible
    size: 1
    node_template: "{{ node_template }}"
    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

size:
    description:
    - The total number of nodes in the node group.
    required: true
    type: int

zone:
    description:
    - Zone where this node group is located .
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the given object should exist in GCP
    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

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

node_template:
    description:
    - The URL of the node template to which this node group belongs.
    - 'This field represents a link to a NodeTemplate resource in GCP. It can be specified
      in two ways. First, you can place a dictionary with key ''selfLink'' and value of
      your resource''s selfLink Alternatively, you can add `register: name-of-resource`
      to a gcp_compute_node_template task and then set this node_template field to "{{
      name-of-resource }}"'
    required: true
    type: dict

autoscaling_policy:
    description:
    - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler
      to automatically manage the sizes of your node groups.
    required: false
    suboptions:
      max_nodes:
        description:
        - Maximum size of the node group. Set to a value less than or equal to 100 and
          greater than or equal to min-nodes.
        required: true
        type: int
      min_nodes:
        description:
        - Minimum size of the node group. Must be less than or equal to max-nodes. The
          default value is 0.
        required: false
        type: int
      mode:
        description:
        - 'The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler.'
        - '- ON: Enables scaling in and scaling out.'
        - '- ONLY_SCALE_OUT: Enables only scaling out.'
        - You must use this mode if your node groups are configured to restart their hosted
          VMs on minimal servers.
        - 'Some valid choices include: "OFF", "ON", "ONLY_SCALE_OUT"'
        required: true
        type: str
    type: dict

maintenance_policy:
    default: DEFAULT
    description:
    - 'Specifies how to handle instances when a node in the group undergoes maintenance.
      Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default
      value is DEFAULT.'
    required: false
    type: str

maintenance_window:
    description:
    - contains properties for the timeframe of maintenance .
    required: false
    suboptions:
      start_time:
        description:
        - instances.start time of the window. This must be in UTC format that resolves
          to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5
          and 08:00 are valid.
        required: true
        type: str
    type: dict

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

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

autoscalingPolicy:
  contains:
    maxNodes:
      description:
      - Maximum size of the node group. Set to a value less than or equal to 100 and
        greater than or equal to min-nodes.
      returned: success
      type: int
    minNodes:
      description:
      - Minimum size of the node group. Must be less than or equal to max-nodes. The
        default value is 0.
      returned: success
      type: int
    mode:
      description:
      - 'The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler.'
      - '- ON: Enables scaling in and scaling out.'
      - '- ONLY_SCALE_OUT: Enables only scaling out.'
      - You must use this mode if your node groups are configured to restart their
        hosted VMs on minimal servers.
      returned: success
      type: str
  description:
  - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler
    to automatically manage the sizes of your node groups.
  returned: success
  type: complex
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
maintenancePolicy:
  description:
  - 'Specifies how to handle instances when a node in the group undergoes maintenance.
    Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default
    value is DEFAULT.'
  returned: success
  type: str
maintenanceWindow:
  contains:
    startTime:
      description:
      - instances.start time of the window. This must be in UTC format that resolves
        to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5
        and 08:00 are valid.
      returned: success
      type: str
  description:
  - contains properties for the timeframe of maintenance .
  returned: success
  type: complex
name:
  description:
  - Name of the resource.
  returned: success
  type: str
nodeTemplate:
  description:
  - The URL of the node template to which this node group belongs.
  returned: success
  type: dict
size:
  description:
  - The total number of nodes in the node group.
  returned: success
  type: int
zone:
  description:
  - Zone where this node group is located .
  returned: success
  type: str