1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-11 07:29:40 +00:00
gcloud-help/gcloud/container/aws/clusters/update

221 lines
7.3 KiB
Text
Raw Normal View History

2022-03-01 04:29:52 +00:00
NAME
gcloud container aws clusters update - update an Anthos cluster on AWS
SYNOPSIS
gcloud container aws clusters update (CLUSTER : --location=LOCATION)
[--admin-users=USER,[USER,...]] [--async]
[--cluster-version=CLUSTER_VERSION]
[--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN]
2022-06-29 09:00:05 +00:00
[--iam-instance-profile=IAM_INSTANCE_PROFILE]
2022-10-18 11:38:19 +00:00
[--instance-type=INSTANCE_TYPE] [--logging=COMPONENT,[COMPONENT,...]]
[--role-arn=ROLE_ARN] [--role-session-name=ROLE_SESSION_NAME]
2022-03-23 08:27:29 +00:00
[--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]
2022-09-08 09:21:50 +00:00
[--annotations=ANNOTATION,[ANNOTATION,...] | --clear-annotations]
[--clear-description | --description=DESCRIPTION]
2022-03-23 08:27:29 +00:00
[--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,...]]
2022-05-11 08:44:01 +00:00
[--clear-ssh-ec2-key-pair | --ssh-ec2-key-pair=SSH_EC2_KEY_PAIR]
2023-04-26 10:24:37 +00:00
[--clear-tags | --tags=TAG,[TAG,...]]
[--disable-managed-prometheus | --enable-managed-prometheus]
[GCLOUD_WIDE_FLAG ...]
2022-03-01 04:29:52 +00:00
DESCRIPTION
Update an Anthos cluster on AWS.
EXAMPLES
To update a cluster named my-cluster managed in location us-west1, run:
$ gcloud container aws clusters update my-cluster \
--location=us-west1 --cluster-version=CLUSTER_VERSION
POSITIONAL ARGUMENTS
Cluster resource - cluster to update. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes
2023-05-04 10:43:54 +00:00
are not given arguments in this group but can be set in other ways.
To set the project attribute:
2022-03-01 04:29:52 +00:00
◆ provide the argument cluster 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.
CLUSTER
2023-05-04 10:43:54 +00:00
ID of the cluster or fully qualified identifier for the cluster.
To set the cluster attribute:
2022-03-01 04:29:52 +00:00
▸ provide the argument cluster on the command line.
2022-08-10 08:48:58 +00:00
This positional argument must be specified if any of the other
arguments in this group are specified.
2022-03-01 04:29:52 +00:00
--location=LOCATION
2023-05-04 10:43:54 +00:00
Google Cloud location for the cluster.
To set the location attribute:
2022-03-01 04:29:52 +00:00
▸ provide the argument cluster on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
2022-08-31 09:34:57 +00:00
▸ set the property container_aws/location.
2022-03-01 04:29:52 +00:00
FLAGS
--admin-users=USER,[USER,...]
Users that can perform operations as a cluster administrator.
--async
Return immediately, without waiting for the operation in progress to
complete.
--cluster-version=CLUSTER_VERSION
Kubernetes version to use for the cluster.
--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN
Amazon Resource Name (ARN) of the AWS KMS key to encrypt the user data.
2022-06-29 09:00:05 +00:00
--iam-instance-profile=IAM_INSTANCE_PROFILE
Name or ARN of the IAM instance profile associated with the cluster.
2022-03-01 04:29:52 +00:00
--instance-type=INSTANCE_TYPE
2022-06-02 08:41:25 +00:00
AWS EC2 instance type for the control plane's nodes.
2022-03-01 04:29:52 +00:00
2022-10-18 11:38:19 +00:00
--logging=COMPONENT,[COMPONENT,...]
Set the components that have logging enabled.
Examples:
$ gcloud container aws clusters update --logging=SYSTEM
$ gcloud container aws clusters update --logging=SYSTEM,WORKLOAD
COMPONENT must be one of: SYSTEM, WORKLOAD.
2022-03-01 04:29:52 +00:00
--role-arn=ROLE_ARN
Amazon Resource Name (ARN) of the IAM role to assume when managing AWS
resources.
--role-session-name=ROLE_SESSION_NAME
Identifier for the assumed role session.
2022-03-23 08:27:29 +00:00
--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.
2022-03-01 04:29:52 +00:00
--validate-only
Validate the update of the cluster, but don't actually perform it.
2022-09-08 09:21:50 +00:00
Annotations
At most one of these can be specified:
--annotations=ANNOTATION,[ANNOTATION,...]
Annotations for the cluster.
--clear-annotations
Clear the annotations for the cluster.
Description
At most one of these can be specified:
--clear-description
Clear the description for the cluster.
--description=DESCRIPTION
Description for the cluster.
2022-03-23 08:27:29 +00:00
Proxy config
At most one of these can be specified:
--clear-proxy-config
2022-06-02 08:41:25 +00:00
Clear the proxy configuration associated with the control plane.
2022-03-23 08:27:29 +00:00
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 control
2022-06-02 08:41:25 +00:00
plane's nodes. This does not remove the default security groups.
2022-03-23 08:27:29 +00:00
--security-group-ids=[SECURITY_GROUP_ID,...]
2022-06-02 08:41:25 +00:00
IDs of additional security groups to add to the control plane's
nodes.
2022-03-23 08:27:29 +00:00
2022-05-11 08:44:01 +00:00
SSH config
At most one of these can be specified:
--clear-ssh-ec2-key-pair
2022-06-02 08:41:25 +00:00
Clear the EC2 key pair authorized to login to the control plane's
nodes.
2022-05-11 08:44:01 +00:00
--ssh-ec2-key-pair=SSH_EC2_KEY_PAIR
2022-06-02 08:41:25 +00:00
Name of the EC2 key pair authorized to login to the control plane's
2022-05-11 08:44:01 +00:00
nodes.
2022-10-05 10:40:53 +00:00
Tags
At most one of these can be specified:
--clear-tags
Clear any tags associated with the control plane's nodes.
--tags=TAG,[TAG,...]
Applies the given tags (comma separated) on the control plane.
Example:
$ gcloud container aws clusters update EXAMPLE_CONTROL_PLANE \
--tags=tag1=one,tag2=two
2023-04-26 10:24:37 +00:00
Monitoring Config
At most one of these can be specified:
--disable-managed-prometheus
Disable managed collection for Managed Service for Prometheus.
--enable-managed-prometheus
Enable managed collection for Managed Service for Prometheus.
2022-03-01 04:29:52 +00:00
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 variant is also available:
$ gcloud alpha container aws clusters update