New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
auth_kind required |
| The type of credential used. | ||
autoscaling | Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. | |||
enabled bool |
| Is autoscaling enabled for this node pool. | ||
min_node_count | Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. | |||
max_node_count | Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. | |||
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. | |||
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. | |||
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. | |||
preemptible bool |
| 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. | ||
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. | |||
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. | |||
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" }. | |||
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_upgrade bool |
| 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. | ||
auto_repair bool |
| 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. | ||
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: None | 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 |
| Whether the given object should exist in GCP | ||
zone required | The zone where the node pool is deployed. |
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- 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
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 bool | success | Is autoscaling enabled for this node pool. | ||
min_node_count int | success | Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. | ||
max_node_count int | success | Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. | ||
cluster dict | success | The cluster this node pool belongs to. | ||
config complex | success | The node configuration of the pool. | ||
disk_size_gb int | 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. | ||
service_account str | 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. | ||
image_type str | success | The image type to use for this node. Note that for a given image type, the latest version of it will be used. | ||
preemptible bool | 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. | ||
labels dict | 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 int | 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. | ||
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. | ||
machine_type str | 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 dict | 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" }. | ||
initial_node_count int | 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_upgrade bool | 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. | ||
auto_repair bool | 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. | ||
upgrade_options complex | success | Specifies the Auto Upgrade knobs for the node pool. | ||
auto_upgrade_start_time str | success | This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format. | ||
description str | success | This field is set when upgrades are about to commence with the description of the upgrade. | ||
name str | success | The name of the node pool. | ||
version str | success | The version of the Kubernetes of this node. | ||
zone str | success | The zone where the node pool is deployed. |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/gcp_container_node_pool_module.html