imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 06:47:12 +00:00
Code Activity

gcloud: Wed Apr 6 08:36:53 UTC 2022

Browse source
This commit is contained in:
Automated 2022-04-06 08:36:53 +00:00
parent 9bf28f1efe
commit f88a614da8
221 changed files with 7174 additions and 449 deletions
Download patch file Download diff file Expand all files Collapse all files

117
gcloud/edge-cloud/container/clusters/create Normal file
View file

@ -0,0 +1,117 @@
NAME
gcloud edge-cloud container clusters create - create an Edge Container
cluster
SYNOPSIS
gcloud edge-cloud container clusters create (CLUSTER : --location=LOCATION)
[--admin-users=ADMIN_USERS] [--async]
[--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR; default="10.0.0.0/17"]
[--default-max-pods-per-node=DEFAULT_MAX_PODS_PER_NODE]
[--fleet-project=FLEET_PROJECT] [--labels=[KEY=VALUE,...]]
[--maintenance-window-end=MAINTENANCE_WINDOW_END]
[--maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE]
[--maintenance-window-start=MAINTENANCE_WINDOW_START]
[--services-ipv4-cidr=SERVICES_IPV4_CIDR; default="10.96.0.0/12"]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create an Edge Container cluster.
EXAMPLES
To create a cluster called 'my-cluster' in region us-central1, run:
$ gcloud edge-cloud container clusters create my-cluster \
--location=us-central1
POSITIONAL ARGUMENTS
Cluster resource - Edge Container cluster to create. 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 cluster on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
CLUSTER
ID of the cluster or fully qualified identifier for the cluster. To
set the cluster attribute:
▸ provide the argument cluster on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument cluster on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
FLAGS
--admin-users=ADMIN_USERS
Username (Google email address) of the user who should be granted
cluster-admin initially. This currently supports exactly one admin. If
not set, the account issuing the creation request will be used by
default.
--async
Return immediately, without waiting for the operation in progress to
complete.
--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR; default="10.0.0.0/17"
All pods in the cluster are assigned an RFC1918 IPv4 address from this
block. This field cannot be changed after creation.
--default-max-pods-per-node=DEFAULT_MAX_PODS_PER_NODE
The default maximum number of pods per node.
--fleet-project=FLEET_PROJECT
Name of the Fleet host project where the cluster is registered.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--maintenance-window-end=MAINTENANCE_WINDOW_END
End time of the recurring cluster maintenance window in the RFC 3339
(https://www.ietf.org/rfc/rfc3339.txt) format. E.g.
"2021-01-01T00:00:00Z" or "2021-01-01T00:00:00-05:00"
--maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE
An RFC 5545 (https://tools.ietf.org/html/rfc5545#section-3.8.5.3)
recurrence rule for how the cluster maintenance window recurs. They go
on for the span of time between the start and the end time.
--maintenance-window-start=MAINTENANCE_WINDOW_START
Start time of the recurring cluster maintenance window in the RFC 3339
(https://www.ietf.org/rfc/rfc3339.txt) format. E.g.
"2021-01-01T00:00:00Z" or "2021-01-01T00:00:00-05:00"
--services-ipv4-cidr=SERVICES_IPV4_CIDR; default="10.96.0.0/12"
All services in the cluster are assigned an RFC1918 IPv4 address from
this block. This field cannot be changed after creation.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters create

66
gcloud/edge-cloud/container/clusters/delete Normal file
View file

@ -0,0 +1,66 @@
NAME
gcloud edge-cloud container clusters delete - delete an Edge Container
cluster
SYNOPSIS
gcloud edge-cloud container clusters delete (CLUSTER : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete an Edge Container cluster.
EXAMPLES
To delete a cluster called 'my-cluster' in region us-central1, run:
$ gcloud edge-cloud container clusters delete my-cluster \
--location=us-central1
POSITIONAL ARGUMENTS
Cluster resource - Edge Container cluster to delete. 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 cluster on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
CLUSTER
ID of the cluster or fully qualified identifier for the cluster. To
set the cluster attribute:
▸ provide the argument cluster on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument cluster on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters delete

62
gcloud/edge-cloud/container/clusters/describe Normal file
View file

@ -0,0 +1,62 @@
NAME
gcloud edge-cloud container clusters describe - show details about the
cluster
SYNOPSIS
gcloud edge-cloud container clusters describe
(CLUSTER : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Show details about the cluster.
EXAMPLES
To show details about a cluster called 'my-cluster' in region us-central1,
run:
$ gcloud edge-cloud container clusters describe my-cluster \
--location=us-central1
POSITIONAL ARGUMENTS
Cluster resource - The cluster you want to describe. 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 cluster on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
CLUSTER
ID of the cluster or fully qualified identifier for the cluster. To
set the cluster attribute:
▸ provide the argument cluster on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument cluster on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters describe

73
gcloud/edge-cloud/container/clusters/get-credentials Normal file
View file

@ -0,0 +1,73 @@
NAME
gcloud edge-cloud container clusters get-credentials - get credentials of
an edge-container cluster
SYNOPSIS
gcloud edge-cloud container clusters get-credentials
(CLUSTER : --location=LOCATION)
[--auth-provider-cmd-path=AUTH_PROVIDER_CMD_PATH]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Fetch credentials for a running Edge Container cluster. This command
updates a kubeconfig file with appropriate credentials and endpoint
information to point kubectl at a specific Edge Container cluster. By
default, credentials are written to HOME/.kube/config. You can provide an
alternate path by setting the KUBECONFIG environment variable. If
KUBECONFIG contains multiple paths, the first one is used. This command
enables switching to a specific cluster, when working with multiple
clusters. It can also be used to access a previously created cluster from a
new workstation. The command will configure kubectl to automatically
refresh its credentials using the same identity as the gcloud command-line
tool. See https://cloud.google.com/kubernetes-engine/docs/kubectl for
kubectl documentation.
EXAMPLES
To get credentials of a cluster named my-cluster managed in location
us-west1, run: $ gcloud edge-cloud container clusters get-credentials my-cluster \
--location=us-west1
POSITIONAL ARGUMENTS
Cluster resource - edge-cloud container cluster to get credentials. 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 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
ID of the cluster or fully qualified identifier for the cluster. To
set the cluster attribute:
▸ provide the argument cluster on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
Google Cloud location for the cluster. To set the location attribute:
▸ provide the argument cluster on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
FLAGS
--auth-provider-cmd-path=AUTH_PROVIDER_CMD_PATH
Path to the gcloud executable for the auth provider field in
kubeconfig.
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 edge-cloud container clusters get-credentials

46
gcloud/edge-cloud/container/clusters/help Normal file
View file

@ -0,0 +1,46 @@
NAME
gcloud edge-cloud container clusters - manage Kubernetes Edge clusters
SYNOPSIS
gcloud edge-cloud container clusters GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Kubernetes Edge clusters.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
node-pools
Manage Kubernetes Edge node pools.
COMMANDS
COMMAND is one of the following:
create
Create an Edge Container cluster.
delete
Delete an Edge Container cluster.
describe
Show details about the cluster.
get-credentials
Get credentials of an edge-container cluster.
list
List Edge Container clusters.
update
Update an Edge Container cluster.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters

82
gcloud/edge-cloud/container/clusters/list Normal file
View file

@ -0,0 +1,82 @@
NAME
gcloud edge-cloud container clusters list - list Edge Container clusters
SYNOPSIS
gcloud edge-cloud container clusters list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List Edge Container clusters.
EXAMPLES
To list the clusters in region us-central1, run:
$ gcloud edge-cloud container clusters list --location=us-central1
FLAGS
Location resource - Parent Edge Container location to list all contained
Edge Container clusters. This represents a Cloud 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 --location on the command line with a fully
specified name;
◆ set the property edge_container/location with a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
--location=LOCATION
ID of the location or fully qualified identifier for the location. To
set the location attribute:
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters list

120
gcloud/edge-cloud/container/clusters/node-pools/create Normal file
View file

@ -0,0 +1,120 @@
NAME
gcloud edge-cloud container clusters node-pools create - create an Edge
Container node pool
SYNOPSIS
gcloud edge-cloud container clusters node-pools create
(NODE_POOL : --cluster=CLUSTER --location=LOCATION)
--node-count=NODE_COUNT --node-location=NODE_LOCATION [--async]
[--labels=[KEY=VALUE,...]] [--local-disk-kms-key=LOCAL_DISK_KMS_KEY]
[--machine-filter=MACHINE_FILTER] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a new Edge Container nodePool.
EXAMPLES
To create a node pool called 'my-nodePool', containing 3 nodes in region
us-central1, run:
$ gcloud edge-cloud container clusters node-pools create \
my-nodePool --cluster=<my-cluster> --location=us-central1 \
--node-location=<my-node-location> --node-count=3
To create a node pool called 'my-nodePool', containing 3 nodes in region
us-central1, using only machine names matching a specific pattern, run:
$ gcloud edge-cloud container clusters node-pools create \
my-nodePool --cluster=<my-cluster> --location=us-central1 \
--node-location=<my-node-location> --node-count=3 \
--machine-filter="name:<name>"
To create a node pool called 'my-nodePool', containing 3 nodes in region
us-central1, using only machine names NOT matching a specific pattern, run:
$ gcloud edge-cloud container clusters node-pools create \
my-nodePool --cluster=<my-cluster> --location=us-central1 \
--node-location=<my-node-location> --node-count=3 \
--machine-filter="NOT name:<name>"
POSITIONAL ARGUMENTS
Node pool resource - Edge Container node pool to create. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
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 must be specified if any of the other arguments in
this group are specified.
--cluster=CLUSTER
Kubernetes cluster. 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
The global location name. 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 edge_container/location.
REQUIRED FLAGS
--node-count=NODE_COUNT
Default nodeCount used by this node pool.
--node-location=NODE_LOCATION
Google Edge Cloud zone where nodes in this node pool will be created.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--local-disk-kms-key=LOCAL_DISK_KMS_KEY
Google Cloud KMS key that will be used to secure local disks on nodes
in this node pool. The Edge Container service account for this project
must have roles/cloudkms.cryptoKeyEncrypterDecrypter on the key.
If not provided, a Google-managed key will be used instead.
--machine-filter=MACHINE_FILTER
Only machines matching this filter will be allowed to join the node
pool. The filtering language accepts strings like "name=<name>", and is
documented in more detail at https://google.aip.dev/160.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters node-pools create

73
gcloud/edge-cloud/container/clusters/node-pools/delete Normal file
View file

@ -0,0 +1,73 @@
NAME
gcloud edge-cloud container clusters node-pools delete - delete an Edge
Container nodePool
SYNOPSIS
gcloud edge-cloud container clusters node-pools delete
(NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete an Edge Container nodePool.
EXAMPLES
To delete a nodePool called 'my-nodePool' in region us-central1, run:
$ gcloud edge-cloud container clusters node-pools delete \
my-nodePool --cluster=<my-cluster> --location=us-central1
POSITIONAL ARGUMENTS
Node pool resource - Edge Container nodePool to delete. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
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 must be specified if any of the other arguments in
this group are specified.
--cluster=CLUSTER
Kubernetes cluster. 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
The global location name. 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 edge_container/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters node-pools delete

69
gcloud/edge-cloud/container/clusters/node-pools/describe Normal file
View file

@ -0,0 +1,69 @@
NAME
gcloud edge-cloud container clusters node-pools describe - show details
about the nodePool
SYNOPSIS
gcloud edge-cloud container clusters node-pools describe
(NODE_POOL : --cluster=CLUSTER --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Show details about the nodePool.
EXAMPLES
To show details about a node pool called 'my-nodePool' in region
us-central1, run:
$ gcloud edge-cloud container clusters node-pools describe \
my-nodePool --location=us-central1 --cluster=<my-cluster>
POSITIONAL ARGUMENTS
Node pool resource - The nodePool you want to describe. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
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 must be specified if any of the other arguments in
this group are specified.
--cluster=CLUSTER
Kubernetes cluster. 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
The global location name. 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 edge_container/location.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters node-pools describe

39
gcloud/edge-cloud/container/clusters/node-pools/help Normal file
View file

@ -0,0 +1,39 @@
NAME
gcloud edge-cloud container clusters node-pools - manage Kubernetes Edge
node pools
SYNOPSIS
gcloud edge-cloud container clusters node-pools COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Kubernetes Edge node pools.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create an Edge Container node pool.
delete
Delete an Edge Container nodePool.
describe
Show details about the nodePool.
list
List Edge Container nodePools.
update
Updates an Edge Container node pool.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters node-pools

96
gcloud/edge-cloud/container/clusters/node-pools/list Normal file
View file

@ -0,0 +1,96 @@
NAME
gcloud edge-cloud container clusters node-pools list - list Edge Container
nodePools
SYNOPSIS
gcloud edge-cloud container clusters node-pools list
(--cluster=CLUSTER : --location=LOCATION) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List Edge Container nodePools.
EXAMPLES
To list the nodePools in region us-central1, run:
$ gcloud edge-cloud container clusters node-pools list \
--location=us-central1 --cluster=<my-cluster>
REQUIRED FLAGS
Cluster resource - Parent Edge Container location to list all contained
Edge Container nodePools. 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 --cluster on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
--cluster=CLUSTER
ID of the cluster or fully qualified identifier for the cluster. To
set the cluster attribute:
▸ provide the argument --cluster on the command line.
This flag must be specified if any of the other arguments in this
group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument --cluster on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters node-pools list

115
gcloud/edge-cloud/container/clusters/node-pools/update Normal file
View file

@ -0,0 +1,115 @@
NAME
gcloud edge-cloud container clusters node-pools update - updates an Edge
Container node pool
SYNOPSIS
gcloud edge-cloud container clusters node-pools update
(NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async]
[--machine-filter=MACHINE_FILTER] [--node-count=NODE_COUNT]
[--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Updates an Edge Container node pool.
EXAMPLES
To update the number of nodes in a node pool called 'my-node-pool' in
region us-central1, run:
$ gcloud edge-cloud container clusters node-pools update \
my-node-pool --location=us-central1 --cluster=<my-cluster> \
--node-count=<new-count>
POSITIONAL ARGUMENTS
Node pool resource - Edge Container 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
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 must be specified if any of the other arguments in
this group are specified.
--cluster=CLUSTER
Kubernetes cluster. 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
The global location name. 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 edge_container/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--machine-filter=MACHINE_FILTER
Only machines matching this filter will be allowed to join the node
pool. The filtering language accepts strings like "name=<name>", and is
documented in more detail at https://google.aip.dev/160.
--node-count=NODE_COUNT
Default nodeCount used by this node pool.
--update-labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to update. If a label exists, its value
is modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
At most one of these can be specified:
--clear-labels
Remove all labels. If --update-labels is also specified then
--clear-labels is applied first.
For example, to remove all labels:
$ gcloud edge-cloud container clusters node-pools update \
--clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud edge-cloud container clusters node-pools update \
--clear-labels --update-labels foo=bar,baz=qux
--remove-labels=[KEY,...]
List of label keys to remove. If a label does not exist it is
silently ignored. If --update-labels is also specified then
--update-labels is applied first.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters node-pools update

86
gcloud/edge-cloud/container/clusters/update Normal file
View file

@ -0,0 +1,86 @@
NAME
gcloud edge-cloud container clusters update - update an Edge Container
cluster
SYNOPSIS
gcloud edge-cloud container clusters update (CLUSTER : --location=LOCATION)
[--async] [--maintenance-window-end=MAINTENANCE_WINDOW_END]
[--maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE]
[--maintenance-window-start=MAINTENANCE_WINDOW_START]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update an Edge Container cluster.
EXAMPLES
To update the maintenance window recurrence rule of a cluster called
'my-cluster' in region us-central1, run:
$ gcloud edge-cloud container clusters update my-cluster \
--location=us-central1 \
--maintenance-window-recurrence="FREQ=WEEKLY"
POSITIONAL ARGUMENTS
Cluster resource - Edge Container cluster 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 cluster on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
CLUSTER
ID of the cluster or fully qualified identifier for the cluster. To
set the cluster attribute:
▸ provide the argument cluster on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument cluster on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--maintenance-window-end=MAINTENANCE_WINDOW_END
End time of the recurring cluster maintenance window in the RFC 3339
(https://www.ietf.org/rfc/rfc3339.txt) format. E.g.
"2021-01-01T00:00:00Z" or "2021-01-01T00:00:00-05:00"
--maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE
An RFC 5545 (https://tools.ietf.org/html/rfc5545#section-3.8.5.3)
recurrence rule for how the cluster maintenance window recurs. They go
on for the span of time between the start and the end time.
--maintenance-window-start=MAINTENANCE_WINDOW_START
Start time of the recurring cluster maintenance window in the RFC 3339
(https://www.ietf.org/rfc/rfc3339.txt) format. E.g.
"2021-01-01T00:00:00Z" or "2021-01-01T00:00:00-05: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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container clusters update

41
gcloud/edge-cloud/container/help Normal file
View file

@ -0,0 +1,41 @@
NAME
gcloud edge-cloud container - manage Edge Container resources
SYNOPSIS
gcloud edge-cloud container GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Edge Container resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
clusters
Manage Kubernetes Edge clusters.
machines
Manage Kubernetes Edge machines.
operations
Command group for working with Kubernetes Edge operations.
regions
Manages Edge Container regions.
vpn-connections
Manage Edge VPN connections between an Edge Container cluster and a VPC
network.
zones
Inspect Edge Container zones.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container

62
gcloud/edge-cloud/container/machines/describe Normal file
View file

@ -0,0 +1,62 @@
NAME
gcloud edge-cloud container machines describe - show details about the
machine
SYNOPSIS
gcloud edge-cloud container machines describe
(MACHINE : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Show details about the machine.
EXAMPLES
To show details about a machine called 'my-machine' in region us-central1,
run:
$ gcloud edge-cloud container machines describe my-machine \
--location=us-central1
POSITIONAL ARGUMENTS
Machine resource - The machine you want to describe. 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 machine on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
MACHINE
ID of the machine or fully qualified identifier for the machine. To
set the machine attribute:
▸ provide the argument machine on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument machine on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container machines describe

28
gcloud/edge-cloud/container/machines/help Normal file
View file

@ -0,0 +1,28 @@
NAME
gcloud edge-cloud container machines - manage Kubernetes Edge machines
SYNOPSIS
gcloud edge-cloud container machines COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Kubernetes Edge machines.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
Show details about the machine.
list
List Edge Container machines.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container machines

82
gcloud/edge-cloud/container/machines/list Normal file
View file

@ -0,0 +1,82 @@
NAME
gcloud edge-cloud container machines list - list Edge Container machines
SYNOPSIS
gcloud edge-cloud container machines list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List Edge Container machines.
EXAMPLES
To list the machines in region us-central1, run:
$ gcloud edge-cloud container machines list --location=us-central1
FLAGS
Location resource - Parent Edge Container location to list all contained
Edge Container machines. This represents a Cloud 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 --location on the command line with a fully
specified name;
◆ set the property edge_container/location with a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
--location=LOCATION
ID of the location or fully qualified identifier for the location. To
set the location attribute:
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container machines list

63
gcloud/edge-cloud/container/operations/describe Normal file
View file

@ -0,0 +1,63 @@
NAME
gcloud edge-cloud container operations describe - get description of a
long-running edge container operation
SYNOPSIS
gcloud edge-cloud container operations describe
(OPERATION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Get information about a long-running edge container operation.
EXAMPLES
To get information about a long-running operation with name
'projects/my-project/locations/us-east1/operations/123', run the following
command:
$ gcloud edge-cloud container operations describe \
projects/my-project/locations/us-east1/operations/123
POSITIONAL ARGUMENTS
Operation resource - The ID of the operation to describe. 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 operation on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
OPERATION
ID of the operation or fully qualified identifier for the operation.
To set the operation attribute:
▸ provide the argument operation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument operation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container operations describe

29
gcloud/edge-cloud/container/operations/help Normal file
View file

@ -0,0 +1,29 @@
NAME
gcloud edge-cloud container operations - command group for working with
Kubernetes Edge operations
SYNOPSIS
gcloud edge-cloud container operations COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Command group for working with Kubernetes Edge operations.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
Get description of a long-running edge container operation.
wait
Poll long-running edge container operation until it completes.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container operations

65
gcloud/edge-cloud/container/operations/wait Normal file
View file

@ -0,0 +1,65 @@
NAME
gcloud edge-cloud container operations wait - poll long-running edge
container operation until it completes
SYNOPSIS
gcloud edge-cloud container operations wait
(OPERATION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Poll a long-running edge container operation until it completes. When the
operation is complete, this command will display the results of the
analysis.
EXAMPLES
To poll a long-running edge container operation named
'projects/my-project/locations/us-east1/operations/123' until it completes,
run the following:
$ gcloud edge-cloud container operations wait \
projects/my-project/locations/us-east1/operations/123
POSITIONAL ARGUMENTS
Operation resource - ID for the operation to poll until complete. 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 operation on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
OPERATION
ID of the operation or fully qualified identifier for the operation.
To set the operation attribute:
▸ provide the argument operation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument operation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container operations wait

49
gcloud/edge-cloud/container/regions/describe Normal file
View file

@ -0,0 +1,49 @@
NAME
gcloud edge-cloud container regions describe - describe an Edge Container
region (location)
SYNOPSIS
gcloud edge-cloud container regions describe [LOCATION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe an Edge Container region (location).
EXAMPLES
To display the metadata for the region us-central1, run:
$ gcloud edge-cloud container regions describe us-central1
POSITIONAL ARGUMENTS
Location resource - The region to describe. This represents a Cloud
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 location on the command line with a fully
specified name;
◆ set the property edge_container/location with a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
[LOCATION]
ID of the location or fully qualified identifier for the location. To
set the location attribute:
▸ provide the argument location on the command line;
▸ set the property edge_container/location.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container regions describe

28
gcloud/edge-cloud/container/regions/help Normal file
View file

@ -0,0 +1,28 @@
NAME
gcloud edge-cloud container regions - manages Edge Container regions
SYNOPSIS
gcloud edge-cloud container regions COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manages Edge Container regions.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
Describe an Edge Container region (location).
list
List Edge Container regions.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container regions

66
gcloud/edge-cloud/container/regions/list Normal file
View file

@ -0,0 +1,66 @@
NAME
gcloud edge-cloud container regions list - list Edge Container regions
SYNOPSIS
gcloud edge-cloud container regions list [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List all regions (locations) where Edge Container clusters can be created.
EXAMPLES
To list all the regions (locations) where Edge Container clusters can be
created, run:
$ gcloud edge-cloud container regions list
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container regions list

98
gcloud/edge-cloud/container/vpn-connections/create Normal file
View file

@ -0,0 +1,98 @@
NAME
gcloud edge-cloud container vpn-connections create - create a VPN
connection between an Edge Container cluster and a VPC network
SYNOPSIS
gcloud edge-cloud container vpn-connections create
(VPN_CONNECTION : --location=LOCATION) --cluster=CLUSTER
--vpc-network=VPC_NETWORK [--async] [--high-availability]
[--labels=[KEY=VALUE,...]] [--nat-gateway-ip=NAT_GATEWAY_IP]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Creates a new VPN connection.
EXAMPLES
To create a connection called 'my-vpn-connection' between the VPC network
'my-vpc' and the Edge Container cluster 'my-cluster' which is at region
us-central1, run:
$ gcloud edge-cloud container vpn-connections create \
my-vpn-connection --location=us-central1 \
--vpc-network='my-vpc' --cluster='my-cluster'
Here VPC network and cluster should be under the same project.
POSITIONAL ARGUMENTS
Vpn connection resource - VPN connection to create. 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 vpn_connection on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
VPN_CONNECTION
ID of the vpn connection or fully qualified identifier for the vpn
connection. To set the vpn_connection attribute:
▸ provide the argument vpn_connection on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument vpn_connection on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
REQUIRED FLAGS
--cluster=CLUSTER
The name of the cluster to be connected under current project.
--vpc-network=VPC_NETWORK
The name of the {vpc_name_short} to be connected under current project.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--high-availability
Enables high availability on cluster side. This creates an additional
VPN endpoint in cluster. Multiple Nodes/NodePools are required to
enable this feature.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--nat-gateway-ip=NAT_GATEWAY_IP
The NAT gateway IP for the gateway floating IPs. Do not specify this if
no NAT is used.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container vpn-connections create

67
gcloud/edge-cloud/container/vpn-connections/delete Normal file
View file

@ -0,0 +1,67 @@
NAME
gcloud edge-cloud container vpn-connections delete - delete a VPN
connection between an Edge Container cluster and a VPC network
SYNOPSIS
gcloud edge-cloud container vpn-connections delete
(VPN_CONNECTION : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete a VPN connection.
EXAMPLES
To delete a VPN connection called 'test-vpn-connection' at region
'us-central1', run:
$ gcloud edge-cloud container vpn-connections delete \
test-vpn-connection --location=us-central1
POSITIONAL ARGUMENTS
Vpn connection resource - VPN connection to delete. 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 vpn_connection on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
VPN_CONNECTION
ID of the vpn connection or fully qualified identifier for the vpn
connection. To set the vpn_connection attribute:
▸ provide the argument vpn_connection on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument vpn_connection on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container vpn-connections delete

62
gcloud/edge-cloud/container/vpn-connections/describe Normal file
View file

@ -0,0 +1,62 @@
NAME
gcloud edge-cloud container vpn-connections describe - show details about a
VPN connection
SYNOPSIS
gcloud edge-cloud container vpn-connections describe
(VPN_CONNECTION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Show details about a VPN connection.
EXAMPLES
To show details about the VPN connection 'test-vpn-connection' at region
us-central1, run:
$ gcloud edge-cloud container vpn-connections describe \
test-vpn-connection --location=us-central1
POSITIONAL ARGUMENTS
Vpn connection resource - VPN connection you want to describe. 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 vpn_connection on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
VPN_CONNECTION
ID of the vpn connection or fully qualified identifier for the vpn
connection. To set the vpn_connection attribute:
▸ provide the argument vpn_connection on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The global location name. To set the location attribute:
▸ provide the argument vpn_connection on the command line with a
fully specified name;
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container vpn-connections describe

38
gcloud/edge-cloud/container/vpn-connections/help Normal file
View file

@ -0,0 +1,38 @@
NAME
gcloud edge-cloud container vpn-connections - manage Edge VPN connections
between an Edge Container cluster and a VPC network
SYNOPSIS
gcloud edge-cloud container vpn-connections COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Edge VPN connections between an Edge Container cluster and a VPC
network.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create a VPN connection between an Edge Container cluster and a VPC
network.
delete
Delete a VPN connection between an Edge Container cluster and a VPC
network.
describe
Show details about a VPN connection.
list
List VPN connections.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container vpn-connections

83
gcloud/edge-cloud/container/vpn-connections/list Normal file
View file

@ -0,0 +1,83 @@
NAME
gcloud edge-cloud container vpn-connections list - list VPN connections
SYNOPSIS
gcloud edge-cloud container vpn-connections list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List VPN connections.
EXAMPLES
To list the VPN connections at region us-central1, run:
$ gcloud edge-cloud container vpn-connections list \
--location=us-central
FLAGS
Location resource - Parent location to list all contained VPN connections.
This represents a Cloud 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 --location on the command line with a fully
specified name;
◆ set the property edge_container/location with a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
--location=LOCATION
ID of the location or fully qualified identifier for the location. To
set the location attribute:
▸ provide the argument --location on the command line;
▸ set the property edge_container/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container vpn-connections list

49
gcloud/edge-cloud/container/zones/describe Normal file
View file

@ -0,0 +1,49 @@
NAME
gcloud edge-cloud container zones describe - describe an Edge Container
zone
SYNOPSIS
gcloud edge-cloud container zones describe ZONE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe an Edge Container zone.
EXAMPLES
To display the metadata for the zone us-central1-edge-operator-a, run:
$ gcloud edge-cloud container zones describe \
us-central1-edge-operator-a
POSITIONAL ARGUMENTS
Zone resource - The zone name. This represents a Cloud 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 zone on the command line with a fully specified
name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
ZONE
ID of the zone or fully qualified identifier for the zone. To set the
zone attribute:
▸ provide the argument zone on the command line.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container zones describe

28
gcloud/edge-cloud/container/zones/help Normal file
View file

@ -0,0 +1,28 @@
NAME
gcloud edge-cloud container zones - inspect Edge Container zones
SYNOPSIS
gcloud edge-cloud container zones COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Inspect Edge Container zones.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
Describe an Edge Container zone.
list
List Edge Container zones.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container zones

59
gcloud/edge-cloud/container/zones/list Normal file
View file

@ -0,0 +1,59 @@
NAME
gcloud edge-cloud container zones list - list Edge Container zones
SYNOPSIS
gcloud edge-cloud container zones list [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List all zones where Edge Container node pools can be created.
EXAMPLES
To list all the zones where Edge Container node pools can be created, run:
$ gcloud edge-cloud container zones list
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
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.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container zones list

25
gcloud/edge-cloud/help Normal file
View file

@ -0,0 +1,25 @@
NAME
gcloud edge-cloud - manage edge-cloud resources
SYNOPSIS
gcloud edge-cloud GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage edge-cloud resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
container
Manage Edge Container resources.
NOTES
This variant is also available:
$ gcloud alpha edge-cloud