delowan.googlecloud.gcp_compute_node_group_info (1.0.2) — module

Gather info for 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

Gather info for GCP NodeGroup


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get info on a node group
  gcp_compute_node_group_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Inputs

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

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

filters:
    description:
    - A list of filter value pairs. Available filters are listed here U(https://cloud.google.com/sdk/gcloud/reference/topic/filters).
    - Each additional filter in the list will act be added as an AND condition (filter1
      and filter2) .
    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

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

resources:
  contains:
    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
  description: List of resources
  returned: always
  type: complex