Documentation

gcp_container_node_pool – Creates a GCP NodePool

New in version 2.6.

Synopsis

  • NodePool contains the name and configuration for a cluster’s node pool.
  • Node pools are a set of nodes (i.e. VM’s), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
auth_kind
- / required
    Choices:
  • machineaccount
  • serviceaccount
  • application
The type of credential used.
autoscaling
-
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
enabled
boolean
    Choices:
  • no
  • yes
Is autoscaling enabled for this node pool.
max_node_count
-
Maximum number of nodes in the NodePool. Must be >= minNodeCount.
There has to enough quota to scale up the cluster.
min_node_count
-
Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount.
cluster
- / required
The cluster this node pool belongs to.
config
-
The node configuration of the pool.
disk_size_gb
-
Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
image_type
-
The image type to use for this node. Note that for a given image type, the latest version of it will be used.
labels
-
The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: http://kubernetes.io/v1.1/docs/user-guide/labels.html An object containing a list of "key": value pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
local_ssd_count
-
The number of local SSD disks to be attached to the node.
The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information.
machine_type
-
The name of a Google Compute Engine machine type (e.g.
n1-standard-1). If unspecified, the default machine type is n1-standard-1.
metadata
-
The metadata key/value pairs assigned to instances in the cluster.
Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB.
The total size of all keys and values must be less than 512 KB.
An object containing a list of "key": value pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
oauth_scopes
-
The set of Google API scopes to be made available on all of the node VMs under the "default" service account.
The following scopes are recommended, but not required, and by default are not included: https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes.
https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry).
If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
preemptible
boolean
    Choices:
  • no
  • yes
Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.
service_account
-
The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.
tags
-
The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
initial_node_count
- / required
The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
management
-
Management configuration for this NodePool.
auto_repair
boolean
    Choices:
  • no
  • yes
A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
auto_upgrade
boolean
    Choices:
  • no
  • yes
A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
upgrade_options
-
Specifies the Auto Upgrade knobs for the node pool.
auto_upgrade_start_time
-
This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format.
description
-
This field is set when upgrades are about to commence with the description of the upgrade.
name
-
The name of the node pool.
project
-
Default:
null
The Google Cloud Platform project to use.
scopes
-
Array of scopes to be used.
service_account_email
-
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
-
The path of a Service Account JSON file if serviceaccount is selected as type.
state
-
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
zone
- / required
The zone where the node pool is deployed.

Notes

Note

  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
  • For authentication, you can set scopes using the GCP_SCOPES env variable.
  • Environment variables values will only be used if the playbook values are not set.
  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: create a cluster
  gcp_container_cluster:
      name: "cluster-nodepool"
      initial_node_count: 4
      zone: us-central1-a
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: cluster

- name: create a node pool
  gcp_container_node_pool:
      name: "test_object"
      initial_node_count: 4
      cluster: "{{ cluster }}"
      zone: us-central1-a
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
autoscaling
complex
success
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

  enabled
boolean
success
Is autoscaling enabled for this node pool.

  max_node_count
integer
success
Maximum number of nodes in the NodePool. Must be >= minNodeCount.
There has to enough quota to scale up the cluster.

  min_node_count
integer
success
Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount.

cluster
dictionary
success
The cluster this node pool belongs to.

config
complex
success
The node configuration of the pool.

  disk_size_gb
integer
success
Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

  image_type
string
success
The image type to use for this node. Note that for a given image type, the latest version of it will be used.

  labels
dictionary
success
The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: http://kubernetes.io/v1.1/docs/user-guide/labels.html An object containing a list of "key": value pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

  local_ssd_count
integer
success
The number of local SSD disks to be attached to the node.
The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information.

  machine_type
string
success
The name of a Google Compute Engine machine type (e.g.
n1-standard-1). If unspecified, the default machine type is n1-standard-1.

  metadata
dictionary
success
The metadata key/value pairs assigned to instances in the cluster.
Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB.
The total size of all keys and values must be less than 512 KB.
An object containing a list of "key": value pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

  oauth_scopes
list
success
The set of Google API scopes to be made available on all of the node VMs under the "default" service account.
The following scopes are recommended, but not required, and by default are not included: https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes.
https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry).
If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

  preemptible
boolean
success
Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.

  service_account
string
success
The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.

  tags
list
success
The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

initial_node_count
integer
success
The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

management
complex
success
Management configuration for this NodePool.

  auto_repair
boolean
success
A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

  auto_upgrade
boolean
success
A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

  upgrade_options
complex
success
Specifies the Auto Upgrade knobs for the node pool.

    auto_upgrade_start_time
string
success
This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format.

    description
string
success
This field is set when upgrades are about to commence with the description of the upgrade.

name
string
success
The name of the node pool.

version
string
success
The version of the Kubernetes of this node.

zone
string
success
The zone where the node pool is deployed.



Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.