NAME

gcloud alpha container aws node-pools update - update a node pool in an Anthos cluster on AWS

SYNOPSIS

gcloud alpha container aws node-pools update (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async] [--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN] [--iam-instance-profile=IAM_INSTANCE_PROFILE] [--node-version=NODE_VERSION] [--root-volume-iops=ROOT_VOLUME_IOPS] [--root-volume-kms-key-arn=ROOT_VOLUME_KMS_KEY_ARN] [--root-volume-size=ROOT_VOLUME_SIZE] [--root-volume-type=ROOT_VOLUME_TYPE] [--validate-only] [--annotations=ANNOTATION,[ANNOTATION,...] | --clear-annotations] [--clear-autoscaling-metrics | --autoscaling-metrics=[AUTOSCALING_METRIC,...] --autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY] [--clear-proxy-config | --proxy-secret-arn=PROXY_SECRET_ARN --proxy-secret-version-id=PROXY_SECRET_VERSION_ID] [--clear-security-group-ids | --security-group-ids=[SECURITY_GROUP_ID,...]] [--clear-ssh-ec2-key-pair | --ssh-ec2-key-pair=SSH_EC2_KEY_PAIR] [--clear-tags | --tags=TAG,[TAG,...]] [--max-nodes=MAX_NODES --min-nodes=MIN_NODES] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Update a node pool in an Anthos cluster on AWS.

EXAMPLES

To update a node pool named my-node-pool in a cluster named my-cluster managed in location us-west1, run:

$ gcloud alpha container aws node-pools update my-node-pool \ --cluster=my-cluster --location=us-west1 \ --node-version=NODE_VERSION

POSITIONAL ARGUMENTS

Node pool resource - node pool to update. The arguments in this group can be

used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the project attribute:

provide the argument node_pool on the command line with a fully specified name;

provide the argument --project on the command line;

set the property core/project.

This must be specified.

NODE_POOL

ID of the node_pool or fully qualified identifier for the node_pool. To set the node_pool attribute:

  • provide the argument node_pool on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--cluster=CLUSTER

cluster of the node_pool. To set the cluster attribute:

  • provide the argument node_pool on the command line with a fully specified name;

  • provide the argument --cluster on the command line.

--location=LOCATION

Google Cloud location for the node_pool. To set the location attribute:

  • provide the argument node_pool on the command line with a fully specified name;

  • provide the argument --location on the command line;

  • set the property container_aws/location.

FLAGS

--async

Return immediately, without waiting for the operation in progress to complete.

--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN

Amazon Resource Name (ARN) of the AWS KMS key to encrypt the user data.

--iam-instance-profile=IAM_INSTANCE_PROFILE

Name or ARN of the IAM instance profile associated with the node pool.

--node-version=NODE_VERSION

Kubernetes version to use for the node pool.

--root-volume-iops=ROOT_VOLUME_IOPS

Number of I/O operations per second (IOPS) to provision for the root volume.

--root-volume-kms-key-arn=ROOT_VOLUME_KMS_KEY_ARN

Amazon Resource Name (ARN) of the AWS KMS key to encrypt the root volume.

--root-volume-size=ROOT_VOLUME_SIZE

Size of the root volume. The value must be a whole number followed by a size unit of GB for gigabyte, or TB for terabyte. If no size unit is specified, GB is assumed.

--root-volume-type=ROOT_VOLUME_TYPE

Type of the root volume. ROOT_VOLUME_TYPE must be one of: gp2, gp3.

--validate-only

Validate the node pool to update, but don't actually perform it.

Annotations

At most one of these can be specified:

--annotations=ANNOTATION,[ANNOTATION,...]

Annotations for the node pool.

--clear-annotations

Clear the annotations for the node pool.

Node pool autoscaling metrics collection

At most one of these can be specified:

--clear-autoscaling-metrics

Clear the cloudwatch autoscaling metrics collection associated with the nodepool.

Update existing cloudwatch autoscaling metrics collection parameters
--autoscaling-metrics=[AUTOSCALING_METRIC,...]

Autoscaling metrics to enable. For a list of valid metrics, refer to https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html. If granularity is specified but not any metrics, all metrics are enabled.

--autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY

Frequency at which EC2 Auto Scaling sends aggregated data to AWS CloudWatch. The only valid value is "1Minute".

Proxy config

At most one of these can be specified:

--clear-proxy-config

Clear the proxy configuration associated with the node pool.

Update existing proxy config parameters
--proxy-secret-arn=PROXY_SECRET_ARN

ARN of the AWS Secrets Manager secret that contains a proxy configuration.

--proxy-secret-version-id=PROXY_SECRET_VERSION_ID

Version ID string of the AWS Secrets Manager secret that contains a proxy configuration.

Security groups

At most one of these can be specified:

--clear-security-group-ids

Clear any additional security groups associated with the node pool's nodes. This does not remove the default security groups.

--security-group-ids=[SECURITY_GROUP_ID,...]

IDs of additional security groups to add to the node pool's nodes.

SSH config

At most one of these can be specified:

--clear-ssh-ec2-key-pair

Clear the EC2 key pair authorized to login to the node pool's nodes.

--ssh-ec2-key-pair=SSH_EC2_KEY_PAIR

Name of the EC2 key pair authorized to login to the node pool's nodes.

Tags

At most one of these can be specified:

--clear-tags

Clear any tags associated with the node pool's nodes.

--tags=TAG,[TAG,...]

Applies the given tags (comma separated) on the node pool. Example:

$ gcloud alpha container aws node-pools update EXAMPLE_NODE_POOL \ --tags=tag1=one,tag2=two

Node pool autoscaling
--max-nodes=MAX_NODES

Maximum number of nodes in the node pool.

--min-nodes=MIN_NODES

Minimum number of nodes in the node pool.

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

NOTES

This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. This variant is also available:

$ gcloud container aws node-pools update