1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-14 17:05:28 +00:00
gcloud-help/gcloud/container/aws/clusters/create

230 lines
8.5 KiB
Text
Raw Normal View History

2022-03-01 04:29:52 +00:00
NAME
gcloud container aws clusters create - create an Anthos cluster on AWS
SYNOPSIS
gcloud container aws clusters create (CLUSTER : --location=LOCATION)
--aws-region=AWS_REGION --cluster-version=CLUSTER_VERSION
--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN
--database-encryption-kms-key-arn=DATABASE_ENCRYPTION_KMS_KEY_ARN
--fleet-project=FLEET_PROJECT
--iam-instance-profile=IAM_INSTANCE_PROFILE
--pod-address-cidr-blocks=POD_ADDRESS_CIDR_BLOCKS --role-arn=ROLE_ARN
--service-address-cidr-blocks=SERVICE_ADDRESS_CIDR_BLOCKS
--subnet-ids=[SUBNET_ID,...] --vpc-id=VPC_ID
2022-08-31 09:34:57 +00:00
[--admin-users=USER,[USER,...]]
[--annotations=ANNOTATION,[ANNOTATION,...]] [--async]
2023-04-26 10:24:37 +00:00
[--description=DESCRIPTION] [--enable-managed-prometheus]
[--instance-type=INSTANCE_TYPE] [--logging=COMPONENT,[COMPONENT,...]]
2022-08-31 09:34:57 +00:00
[--main-volume-iops=MAIN_VOLUME_IOPS]
2022-03-01 04:29:52 +00:00
[--main-volume-kms-key-arn=MAIN_VOLUME_KMS_KEY_ARN]
[--main-volume-size=MAIN_VOLUME_SIZE]
[--main-volume-type=MAIN_VOLUME_TYPE]
[--role-session-name=ROLE_SESSION_NAME]
[--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]
[--security-group-ids=[SECURITY_GROUP_ID,...]]
[--ssh-ec2-key-pair=SSH_EC2_KEY_PAIR] [--tags=TAG,[TAG,...]]
[--validate-only]
[--proxy-secret-arn=PROXY_SECRET_ARN
--proxy-secret-version-id=PROXY_SECRET_VERSION_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create an Anthos cluster on AWS.
EXAMPLES
To create a cluster named my-cluster managed in location us-west1, run:
$ gcloud container aws clusters create my-cluster \
--location=us-west1 --aws-region=AWS_REGION \
--cluster-version=CLUSTER_VERSION \
--database-encryption-kms-key-arn=KMS_KEY_ARN \
--iam-instance-profile=IAM_INSTANCE_PROFILE \
--pod-address-cidr-blocks=POD_ADDRESS_CIDR_BLOCKS \
--role-arn=ROLE_ARN \
--service-address-cidr-blocks=SERVICE_ADDRESS_CIDR_BLOCKS \
--subnet-ids=SUBNET_ID --vpc-id=VPC_ID
POSITIONAL ARGUMENTS
Cluster resource - cluster to create. 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
REQUIRED FLAGS
--aws-region=AWS_REGION
AWS region to deploy the cluster.
--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.
--database-encryption-kms-key-arn=DATABASE_ENCRYPTION_KMS_KEY_ARN
Amazon Resource Name (ARN) of the AWS KMS key to encrypt the cluster
secrets.
--fleet-project=FLEET_PROJECT
ID or number of the Fleet host project where the cluster is registered.
--iam-instance-profile=IAM_INSTANCE_PROFILE
2022-06-02 08:41:25 +00:00
Name or ARN of the IAM instance profile associated with the cluster.
2022-03-01 04:29:52 +00:00
--pod-address-cidr-blocks=POD_ADDRESS_CIDR_BLOCKS
IP address range for the pods in this cluster in CIDR notation (e.g.
2022-04-27 09:13:09 +00:00
10.0.0.0/8).
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.
--service-address-cidr-blocks=SERVICE_ADDRESS_CIDR_BLOCKS
IP address range for the services IPs in CIDR notation (e.g.
2022-04-27 09:13:09 +00:00
10.0.0.0/8).
2022-03-01 04:29:52 +00:00
--subnet-ids=[SUBNET_ID,...]
Subnet ID of an existing VNET to use for the cluster control plane.
--vpc-id=VPC_ID
VPC associated with the cluster.
OPTIONAL FLAGS
--admin-users=USER,[USER,...]
Users that can perform operations as a cluster administrator. If not
specified, the value of property core/account is used.
2022-08-31 09:34:57 +00:00
--annotations=ANNOTATION,[ANNOTATION,...]
Annotations for the cluster.
2022-03-01 04:29:52 +00:00
--async
Return immediately, without waiting for the operation in progress to
complete.
2022-08-31 09:34:57 +00:00
--description=DESCRIPTION
Description for the cluster.
2023-04-26 10:24:37 +00:00
--enable-managed-prometheus
Enable managed collection for Managed Service for Prometheus.
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 create --logging=SYSTEM
$ gcloud container aws clusters create --logging=SYSTEM,WORKLOAD
COMPONENT must be one of: SYSTEM, WORKLOAD.
2022-03-01 04:29:52 +00:00
--main-volume-iops=MAIN_VOLUME_IOPS
Number of I/O operations per second (IOPS) to provision for the main
volume.
--main-volume-kms-key-arn=MAIN_VOLUME_KMS_KEY_ARN
Amazon Resource Name (ARN) of the AWS KMS key to encrypt the main
volume.
--main-volume-size=MAIN_VOLUME_SIZE
Size of the main 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.
--main-volume-type=MAIN_VOLUME_TYPE
Type of the main volume. MAIN_VOLUME_TYPE must be one of: gp2, gp3.
--role-session-name=ROLE_SESSION_NAME
Identifier for the assumed role session.
--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
2022-03-23 08:27:29 +00:00
volume.
2022-03-01 04:29:52 +00:00
--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.
--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-01 04:29:52 +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-03-01 04:29:52 +00:00
--tags=TAG,[TAG,...]
Applies the given tags (comma separated) on the cluster. Example:
$ gcloud container aws clusters create EXAMPLE_CLUSTER \
--tags=tag1=one,tag2=two
--validate-only
Validate the cluster to create, but don't actually perform it.
Proxy config
--proxy-secret-arn=PROXY_SECRET_ARN
ARN of the AWS Secrets Manager secret that contains a proxy
configuration.
2022-08-10 08:48:58 +00:00
This flag argument must be specified if any of the other arguments in
this group are specified.
2022-03-01 04:29:52 +00:00
--proxy-secret-version-id=PROXY_SECRET_VERSION_ID
Version ID string of the AWS Secrets Manager secret that contains a
proxy configuration.
2022-08-10 08:48:58 +00:00
This flag argument must be specified if any of the other arguments in
this group are specified.
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 create