imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-19 07:15:23 +00:00
Code Activity

gcloud: Tue Mar 1 04:29:52 UTC 2022

Browse source
This commit is contained in:
Automated 2022-03-01 04:29:52 +00:00
parent aab53307a8
commit 1456dab6c7
9791 changed files with 814712 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

72
gcloud/container/hub/cloudrun/apply Normal file
View file

@ -0,0 +1,72 @@
NAME
gcloud container hub cloudrun apply - deploy or update the CloudRun feature
SYNOPSIS
gcloud container hub cloudrun apply
(--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI
| [--context=CONTEXT : --kubeconfig=KUBECONFIG]) [--config=CONFIG]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Deploy or update a user-specified config file of the CloudRun custom
resource. The config file should be a YAML file.
EXAMPLES
To apply the CloudRun YAML file, run:
$ gcloud container hub cloudrun apply \
--kubeconfig=/path/to/kubeconfig \
--config=/path/to/cloud-run-cr.yaml
REQUIRED FLAGS
Cluster identifier.
Exactly one of these must be specified:
--gke-cluster=LOCATION/CLUSTER_NAME
The location/name of the GKE cluster. The location can be a zone or a
region for e.g us-central1-a/my-cluster.
--gke-uri=GKE_URI
The URI of a GKE cluster that you want to register to Hub; for
example,
'https://container.googleapis.com/v1/projects/my-project/locations/us-central1-a/clusters/my-cluster'.
To obtain the URI, you can run 'gcloud container clusters list
--uri'. Note that this should only be provided if the cluster being
registered is a GKE cluster. The service will validate the provided
URI to confirm that it maps to a valid GKE cluster."
Non-GKE cluster identifier.
--context=CONTEXT
The cluster context as it appears in the kubeconfig file. You can
get this value from the command line by running command: kubectl
config current-context.
This flag must be specified if any of the other arguments in this
group are specified.
--kubeconfig=KUBECONFIG
The kubeconfig file containing an entry for the cluster. Defaults
to $KUBECONFIG if it is set in the environment, otherwise defaults
to $HOME/.kube/config.
OPTIONAL FLAGS
--config=CONFIG
The path to CloudRun custom resource config file.
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
These variants are also available:
$ gcloud alpha container hub cloudrun apply
$ gcloud beta container hub cloudrun apply

28
gcloud/container/hub/cloudrun/describe Normal file
View file

@ -0,0 +1,28 @@
NAME
gcloud container hub cloudrun describe - describe the status of the
CloudRun feature
SYNOPSIS
gcloud container hub cloudrun describe [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To get the detailed current status of the CloudRun Feature in Anthos
clusters, run:
$ gcloud container hub cloudrun describe
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
These variants are also available:
$ gcloud alpha container hub cloudrun describe
$ gcloud beta container hub cloudrun describe

34
gcloud/container/hub/cloudrun/disable Normal file
View file

@ -0,0 +1,34 @@
NAME
gcloud container hub cloudrun disable - disable the CloudRun feature
SYNOPSIS
gcloud container hub cloudrun disable [--force] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command disables the CloudRun feature in Anthos clusters.
EXAMPLES
To disable the CloudRun Feature, run:
$ gcloud container hub cloudrun disable
FLAGS
--force
Disable this feature, even if it is currently in use. Force disablement
may result in unexpected behavior.
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
These variants are also available:
$ gcloud alpha container hub cloudrun disable
$ gcloud beta container hub cloudrun disable

29
gcloud/container/hub/cloudrun/enable Normal file
View file

@ -0,0 +1,29 @@
NAME
gcloud container hub cloudrun enable - enable the CloudRun feature
SYNOPSIS
gcloud container hub cloudrun enable [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command enables the CloudRun feature in Anthos clusters.
EXAMPLES
To enable the CloudRun Feature, run:
$ gcloud container hub cloudrun enable
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
These variants are also available:
$ gcloud alpha container hub cloudrun enable
$ gcloud beta container hub cloudrun enable

36
gcloud/container/hub/cloudrun/help Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud container hub cloudrun - manage the CloudRun feature
SYNOPSIS
gcloud container hub cloudrun COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage the CloudRun feature.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
apply
Deploy or update the CloudRun feature.
describe
Describe the status of the CloudRun feature.
disable
Disable the CloudRun feature.
enable
Enable the CloudRun feature.
NOTES
These variants are also available:
$ gcloud alpha container hub cloudrun
$ gcloud beta container hub cloudrun

29
gcloud/container/hub/features/help Normal file
View file

@ -0,0 +1,29 @@
NAME
gcloud container hub features - manage Hub Feature resources
SYNOPSIS
gcloud container hub features COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
These commands manage Features generically. Most Features offer specialized
commands under dedicated sub-groups that may be more effective for that
specific Feature.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
list
List enabled features.
NOTES
These variants are also available:
$ gcloud alpha container hub features
$ gcloud beta container hub features

86
gcloud/container/hub/features/list Normal file
View file

@ -0,0 +1,86 @@
NAME
gcloud container hub features list - list enabled features
SYNOPSIS
gcloud container hub features list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List enabled Hub features in a project.
EXAMPLES
To list all enabled Hub features in a project, run:
$ gcloud container hub features list
FLAGS
Location resource - The location to list Features under.
'global' is the only supported value. 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;
◆ global is the only supported 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;
▸ global is the only supported 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 gkehub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster
NOTES
These variants are also available:
$ gcloud alpha container hub features list
$ gcloud beta container hub features list

72
gcloud/container/hub/help Normal file
View file

@ -0,0 +1,72 @@
NAME
gcloud container hub - centrally manage features and services on all your
Kubernetes clusters with Hub
SYNOPSIS
gcloud container hub GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
The command group to register GKE or other Kubernetes clusters running in a
variety of environments, including Google cloud, on premises in customer
datacenters, or other third party clouds with Hub. Hub provides a
centralized control-plane to managed features and services on all
registered clusters.
A registered cluster is always associated with a Membership, a resource
within Hub.
EXAMPLES
Manage memberships of all your GKE and other Kubernetes clusters with Hub:
$ gcloud container hub memberships --help
Manage Config Management feature on all memberships:
$ gcloud container hub config-management --help
Manage Multi-cluster Ingress feature on all memberships:
$ gcloud container hub ingress --help
Manage Multi-cluster Services feature on all memberships:
$ gcloud container hub multi-cluster-services --help
Manage CloudRun feature on all memberships:
$ gcloud container hub cloudrun --help
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
cloudrun
Manage the CloudRun feature.
features
Manage Hub Feature resources.
ingress
Manage Multi-cluster Ingress Feature.
memberships
Manage memberships of all your GKE and other Kubernetes cluster with
Fleet.
mesh
Manage Service Mesh Feature.
multi-cluster-services
Manage Multi-cluster Services Feature.
NOTES
These variants are also available:
$ gcloud alpha container hub
$ gcloud beta container hub

31
gcloud/container/hub/ingress/describe Normal file
View file

@ -0,0 +1,31 @@
NAME
gcloud container hub ingress describe - describe the status of
Multi-cluster Ingress Feature resource
SYNOPSIS
gcloud container hub ingress describe [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command describes the status of Multi-cluster Ingress Feature resource
in Hub.
EXAMPLES
To describe the Ingress Feature, run:
$ gcloud container hub ingress describe
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
These variants are also available:
$ gcloud alpha container hub ingress describe
$ gcloud beta container hub ingress describe

35
gcloud/container/hub/ingress/disable Normal file
View file

@ -0,0 +1,35 @@
NAME
gcloud container hub ingress disable - disable Multi-cluster Ingress
Feature
SYNOPSIS
gcloud container hub ingress disable [--force] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command disables Multi-cluster Ingress Feature in Hub.
EXAMPLES
To disable the Ingress Feature, run:
$ gcloud container hub ingress disable
FLAGS
--force
Disable this feature, even if it is currently in use. Force disablement
may result in unexpected behavior.
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
These variants are also available:
$ gcloud alpha container hub ingress disable
$ gcloud beta container hub ingress disable

36
gcloud/container/hub/ingress/enable Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud container hub ingress enable - enable Multi-cluster Ingress Feature
SYNOPSIS
gcloud container hub ingress enable [--config-membership=CONFIG_MEMBERSHIP]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command enables Multi-cluster Ingress Feature in Hub.
EXAMPLES
To enable the Ingress Feature, run:
$ gcloud container hub ingress enable \
--config-membership=CONFIG_MEMBERSHIP
FLAGS
--config-membership=CONFIG_MEMBERSHIP
Membership resource representing the cluster which hosts the
MultiClusterIngress and MultiClusterService CustomResourceDefinitions.
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
These variants are also available:
$ gcloud alpha container hub ingress enable
$ gcloud beta container hub ingress enable

36
gcloud/container/hub/ingress/help Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud container hub ingress - manage Multi-cluster Ingress Feature
SYNOPSIS
gcloud container hub ingress COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Multi-cluster Ingress Feature.
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 the status of Multi-cluster Ingress Feature resource.
disable
Disable Multi-cluster Ingress Feature.
enable
Enable Multi-cluster Ingress Feature.
update
Update Multi-cluster Ingress Feature.
NOTES
These variants are also available:
$ gcloud alpha container hub ingress
$ gcloud beta container hub ingress

36
gcloud/container/hub/ingress/update Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud container hub ingress update - update Multi-cluster Ingress Feature
SYNOPSIS
gcloud container hub ingress update [--config-membership=CONFIG_MEMBERSHIP]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command updates Multi-cluster Ingress Feature in Hub.
EXAMPLES
To update the Ingress Feature, run:
$ gcloud container hub ingress update \
--config-membership=CONFIG_MEMBERSHIP
FLAGS
--config-membership=CONFIG_MEMBERSHIP
Membership resource representing the cluster which hosts the
MultiClusterIngress and MultiClusterService CustomResourceDefinitions.
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
These variants are also available:
$ gcloud alpha container hub ingress update
$ gcloud beta container hub ingress update

74
gcloud/container/hub/memberships/delete Normal file
View file

@ -0,0 +1,74 @@
NAME
gcloud container hub memberships delete - delete a membership
SYNOPSIS
gcloud container hub memberships delete (MEMBERSHIP : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command deletes the Fleet membership resource corresponding to the
cluster.
This command is intended to delete stale Fleet Membership resources as
doing so on a fully registered cluster will skip uninstalling the Connect
Agent and and orphan in-cluster resources and agent connections to Google.
To completely unregister the cluster, consider using the command: gcloud
container hub memberships unregister.
EXAMPLES
Delete a membership from Fleet:
$ gcloud container hub memberships delete a-membership
POSITIONAL ARGUMENTS
Membership resource - The cluster membership 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 membership 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.
MEMBERSHIP
ID of the membership or fully qualified identifier for the
membership. To set the membership attribute:
▸ provide the argument membership on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location name. To set the location attribute:
▸ provide the argument membership on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ global is the only supported 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 gkehub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster
NOTES
These variants are also available:
$ gcloud alpha container hub memberships delete
$ gcloud beta container hub memberships delete

62
gcloud/container/hub/memberships/describe Normal file
View file

@ -0,0 +1,62 @@
NAME
gcloud container hub memberships describe - describe a membership
SYNOPSIS
gcloud container hub memberships describe
(MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe a membership in Fleet.
EXAMPLES
Describe a membership in Fleet:
$ gcloud container hub memberships describe a-membership
POSITIONAL ARGUMENTS
Membership resource - The cluster membership 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 membership 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.
MEMBERSHIP
ID of the membership or fully qualified identifier for the
membership. To set the membership attribute:
▸ provide the argument membership on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location name. To set the location attribute:
▸ provide the argument membership on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ global is the only supported 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 gkehub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster
NOTES
These variants are also available:
$ gcloud alpha container hub memberships describe
$ gcloud beta container hub memberships describe

46
gcloud/container/hub/memberships/get-credentials Normal file
View file

@ -0,0 +1,46 @@
NAME
gcloud container hub memberships get-credentials - fetch credentials for a
Fleet-registered cluster to be used in Connect Gateway
SYNOPSIS
gcloud container hub memberships get-credentials MEMBERSHIP
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud container hub memberships get-credentials updates the kubeconfig
file with the appropriate credentials and endpoint information to send
kubectl commands to a Fleet-registered and connected cluster through
Connect Gateway Service.
It takes a project, passed through by set defaults or flags. 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.
Upon success, this command will switch current context to the target
cluster, when working with multiple clusters.
EXAMPLES
Get gateway kubeconfig for a registered cluster:
$ gcloud container hub memberships get-credentials my-cluster
POSITIONAL ARGUMENTS
MEMBERSHIP
The membership name used to locate a cluster in your project.
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
These variants are also available:
$ gcloud alpha container hub memberships get-credentials
$ gcloud beta container hub memberships get-credentials

47
gcloud/container/hub/memberships/help Normal file
View file

@ -0,0 +1,47 @@
NAME
gcloud container hub memberships - manage memberships of all your GKE and
other Kubernetes cluster with Fleet
SYNOPSIS
gcloud container hub memberships COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage memberships of all your GKE and other Kubernetes cluster with Fleet.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
delete
Delete a membership.
describe
Describe a membership.
get-credentials
Fetch credentials for a Fleet-registered cluster to be used in Connect
Gateway.
list
List memberships.
register
Register a cluster with Fleet.
unregister
Unregister a cluster from Fleet.
update
Update a membership.
NOTES
These variants are also available:
$ gcloud alpha container hub memberships
$ gcloud beta container hub memberships

68
gcloud/container/hub/memberships/list Normal file
View file

@ -0,0 +1,68 @@
NAME
gcloud container hub memberships list - list memberships
SYNOPSIS
gcloud container hub memberships list [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List memberships in Fleet.
EXAMPLES
List memberships in Fleet:
$ gcloud container hub memberships 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 gkehub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster
NOTES
These variants are also available:
$ gcloud alpha container hub memberships list
$ gcloud beta container hub memberships list

243
gcloud/container/hub/memberships/register Normal file
View file

@ -0,0 +1,243 @@
NAME
gcloud container hub memberships register - register a cluster with Fleet
SYNOPSIS
gcloud container hub memberships register CLUSTER_NAME
(--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI
| [--context=CONTEXT : --kubeconfig=KUBECONFIG])
(--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE
| [--enable-workload-identity : --has-private-issuer
| --public-issuer-url=PUBLIC_ISSUER_URL]) [--internal-ip]
[--manifest-output-file=MANIFEST_OUTPUT_FILE] [--proxy=PROXY]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command registers a cluster with the Fleet by:
1. Creating a Fleet Membership resource corresponding to the cluster.
2. Adding in-cluster Kubernetes Resources that make the cluster exclusive
to one Fleet.
3. Installing the Connect Agent into this cluster.
A successful registration implies that the cluster is now exclusive to a
single Fleet.
For more information about Connect Agent, go to:
https://cloud.google.com/anthos/multicluster-management/connect/overview/
To register a non-GKE or GKE On-Prem cluster use --context flag (with an
optional --kubeconfig flag).
To register a GKE cluster use --gke-cluster or --gke-uri flag (no
--kubeconfig flag is required).
In all cases, the Connect Agent that is installed in the target cluster
must authenticate to Google using a --service-account-key-file that
corresponds to a service account that has been granted gkehub.connect
permissions.
If the cluster is already registered to another Fleet, the registration is
not successful.
Rerunning this command against the same cluster with the same CLUSTER_NAME
and target GKEFleet is successful and upgrades the Connect Agent if a new
agent is available.
EXAMPLES
Register a non-GKE or GKE On-Prem cluster referenced from a specific
kubeconfig file, and install the Connect Agent:
$ gcloud container hub memberships register my-cluster \
--context=my-cluster-context \
--kubeconfig=/home/user/custom_kubeconfig \
--service-account-key-file=/tmp/keyfile.json
Register a non-GKE or GKE On-Prem cluster referenced from the default
kubeconfig file, and install the Connect Agent:
$ gcloud container hub memberships register my-cluster \
--context=my-cluster-context \
--service-account-key-file=/tmp/keyfile.json
Register a non-GKE or GKE On-Prem cluster, and install a specific version
of the Connect Agent:
$ gcloud container hub memberships register my-cluster \
--context=my-cluster-context \
--version=gkeconnect_20190802_02_00 \
--service-account-key-file=/tmp/keyfile.json
Register a non-GKE or GKE On-Prem cluster and output a manifest that can be
used to install the Connect Agent:
$ gcloud container hub memberships register my-cluster \
--context=my-cluster-context \
--manifest-output-file=/tmp/manifest.yaml \
--service-account-key-file=/tmp/keyfile.json
Register a GKE cluster referenced from a GKE URI, and install the Connect
Agent:
$ gcloud container hub memberships register my-cluster \
--gke-uri=my-cluster-gke-uri \
--service-account-key-file=/tmp/keyfile.json
Register a GKE cluster referenced from a GKE Cluster location and name, and
install the Connect Agent:
$ gcloud container hub memberships register my-cluster \
--gke-cluster=my-cluster-region-or-zone/my-cluster \
--service-account-key-file=/tmp/keyfile.json
Register a GKE cluster, and install a specific version of the Connect
Agent:
$ gcloud container hub memberships register my-cluster \
--gke-uri=my-cluster-gke-uri \
--version=gkeconnect_20190802_02_00 \
--service-account-key-file=/tmp/keyfile.json
$ gcloud container hub memberships register my-cluster \
--gke-cluster=my-cluster-region-or-zone/my-cluster \
--version=gkeconnect_20190802_02_00 \
--service-account-key-file=/tmp/keyfile.json
Register a GKE cluster and output a manifest that can be used to install
the Connect Agent:
$ gcloud container hub memberships register my-cluster \
--gke-uri=my-cluster-gke-uri \
--manifest-output-file=/tmp/manifest.yaml \
--service-account-key-file=/tmp/keyfile.json
$ gcloud container hub memberships register my-cluster \
--gke-cluster=my-cluster-region-or-zone/my-cluster \
--manifest-output-file=/tmp/manifest.yaml \
--service-account-key-file=/tmp/keyfile.json
POSITIONAL ARGUMENTS
CLUSTER_NAME
The membership name that you choose to uniquely represents the cluster
being registered on the Fleet.
REQUIRED FLAGS
Cluster identifier.
Exactly one of these must be specified:
--gke-cluster=LOCATION/CLUSTER_NAME
The location/name of the GKE cluster. The location can be a zone or a
region for e.g us-central1-a/my-cluster.
--gke-uri=GKE_URI
The URI of a GKE cluster that you want to register to Hub; for
example,
'https://container.googleapis.com/v1/projects/my-project/locations/us-central1-a/clusters/my-cluster'.
To obtain the URI, you can run 'gcloud container clusters list
--uri'. Note that this should only be provided if the cluster being
registered is a GKE cluster. The service will validate the provided
URI to confirm that it maps to a valid GKE cluster."
Non-GKE cluster identifier.
--context=CONTEXT
The cluster context as it appears in the kubeconfig file. You can
get this value from the command line by running command: kubectl
config current-context.
This flag must be specified if any of the other arguments in this
group are specified.
--kubeconfig=KUBECONFIG
The kubeconfig file containing an entry for the cluster. Defaults
to $KUBECONFIG if it is set in the environment, otherwise defaults
to $HOME/.kube/config.
Exactly one of these must be specified:
--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE
The JSON file of a Google Cloud service account private key. This
service account key is stored as a secret named creds-gcp in
gke-connect namespace. To update the creds-gcp secret in gke-connect
namespace with a new service account key file, run the following
command:
kubectl delete secret creds-gcp -n gke-connect
kubectl create secret generic creds-gcp -n gke-connect
--from-file=creds-gcp.json=/path/to/file
Workload Identity
--enable-workload-identity
Enable Workload Identity when registering the cluster with Fleet.
Ensure that GKE Workload Identity is enabled on your GKE cluster,
it is a requirement for using Workload Identity with memberships.
Refer to the Registering a cluster using Workload Identity section
in
https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster#register_cluster
--service_account_key_file flag should not be set if this is set.
This flag must be specified if any of the other arguments in this
group are specified.
At most one of these can be specified:
--has-private-issuer
Set to true for clusters where no publicly-routable OIDC
discovery endpoint for the Kubernetes service account token
issuer exists.
When set to true, the gcloud command-line tool will read the
private issuer URL and JSON Web Key Set (JWKS) (public keys) for
validating service account tokens from the cluster's API server
and upload both when creating the Membership. Google Cloud
Platform will then use the JWKS, instead of a public OIDC
endpoint, to validate service account tokens issued by this
cluster. Note the JWKS establishes the uniqueness of issuers in
this configuration, but issuer claims in tokens are still
compared to the issuer URL associated with the Membership when
validating tokens.
Note the cluster's OIDC discovery endpoints (KUBE-API-ADDRESS
(https://)/.well-known/openid-configuration and KUBE-API-ADDRESS
(https://)/openid/v1/jwks) must still be network-accessible to
the gcloud client running this command.
--public-issuer-url=PUBLIC_ISSUER_URL
Skip auto-discovery and register the cluster with this issuer
URL. Use this option when the OpenID Provider Configuration and
associated JSON Web Key Set for validating the cluster's service
account JWTs are served at a public endpoint different from the
cluster API server. Requires --enable-workload-identity.
OPTIONAL FLAGS
--internal-ip
Whether to use the internal IP address of the cluster endpoint.
--manifest-output-file=MANIFEST_OUTPUT_FILE
The full path of the file into which the Connect Agent installation
manifest should be stored. If this option is provided, then the
manifest will be written to this file and will not be deployed into the
cluster by gcloud, and it will need to be deployed manually.
--proxy=PROXY
The proxy address in the format of http[s]://{hostname}. The proxy must
support the HTTP CONNECT method in order for this connection to
succeed.
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
These variants are also available:
$ gcloud alpha container hub memberships register
$ gcloud beta container hub memberships register

113
gcloud/container/hub/memberships/unregister Normal file
View file

@ -0,0 +1,113 @@
NAME
gcloud container hub memberships unregister - unregister a cluster from
Fleet
SYNOPSIS
gcloud container hub memberships unregister CLUSTER_NAME
(--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI
| [--context=CONTEXT : --kubeconfig=KUBECONFIG])
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command unregisters a cluster with the Fleet by:
1. Deleting the Fleet Membership resource for this cluster (a.k.a
`gcloud container hub memberships delete`).
2. Removing the corresponding in-cluster Kubernetes Resources that make the
cluster exclusive to one Fleet (a.k.a `kubectl delete memberships
membership`).
3. Uninstalling the Connect Agent from this cluster (a.k.a
`kubectl delete on the gke-connect namespace`).
The unregister command makes additional internal checks to ensure that all
three steps can be safely done to properly clean-up in-Fleet and in-cluster
resources.
To register a non-GKE cluster use --context flag (with an optional
--kubeconfig flag).
To register a GKE cluster use --gke-cluster or --gke-uri flag (no
--kubeconfig flag is required).
To only delete the Fleet membership resource, consider using the command:
gcloud container hub memberships delete. This command is intended to delete
stale Fleet Membership resources as doing so on a fully registered cluster
will skip some of the steps above and orphan in-cluster resources and agent
connections to Google.
EXAMPLES
Unregister a non-GKE cluster referenced from a specific kubeconfig file:
$ gcloud container hub memberships unregister my-membership \
--context=my-cluster-context \
--kubeconfig=/home/user/custom_kubeconfig
Unregister a non-GKE cluster referenced from the default kubeconfig file:
$ gcloud container hub memberships unregister my-membership \
--context=my-cluster-context
Unregister a GKE cluster referenced from a GKE URI:
$ gcloud container hub memberships unregister my-membership \
--gke-uri=my-cluster-gke-uri
Unregister a GKE cluster referenced from a GKE Cluster location and name:
$ gcloud container hub memberships unregister my-membership \
--gke-cluster=my-cluster-region-or-zone/my-cluster
POSITIONAL ARGUMENTS
CLUSTER_NAME
The membership name that corresponds to the cluster being unregistered.
To get list of all the memberships on the Fleet, consider using the
command: gcloud container hub memberships list.
REQUIRED FLAGS
Cluster identifier.
Exactly one of these must be specified:
--gke-cluster=LOCATION/CLUSTER_NAME
The location/name of the GKE cluster. The location can be a zone or a
region for e.g us-central1-a/my-cluster.
--gke-uri=GKE_URI
The URI of a GKE cluster that you want to register to Hub; for
example,
'https://container.googleapis.com/v1/projects/my-project/locations/us-central1-a/clusters/my-cluster'.
To obtain the URI, you can run 'gcloud container clusters list
--uri'. Note that this should only be provided if the cluster being
registered is a GKE cluster. The service will validate the provided
URI to confirm that it maps to a valid GKE cluster."
Non-GKE cluster identifier.
--context=CONTEXT
The cluster context as it appears in the kubeconfig file. You can
get this value from the command line by running command: kubectl
config current-context.
This flag must be specified if any of the other arguments in this
group are specified.
--kubeconfig=KUBECONFIG
The kubeconfig file containing an entry for the cluster. Defaults
to $KUBECONFIG if it is set in the environment, otherwise defaults
to $HOME/.kube/config.
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
These variants are also available:
$ gcloud alpha container hub memberships unregister
$ gcloud beta container hub memberships unregister

97
gcloud/container/hub/memberships/update Normal file
View file

@ -0,0 +1,97 @@
NAME
gcloud container hub memberships update - update a membership
SYNOPSIS
gcloud container hub memberships update (MEMBERSHIP : --location=LOCATION)
[--async] [--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update an existing membership in Fleet.
EXAMPLES
Update a membership for a cluster:
$ gcloud container hub memberships update a-membership
POSITIONAL ARGUMENTS
Membership resource - membership resource representing a cluster in Fleet.
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 membership 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.
MEMBERSHIP
ID of the membership or fully qualified identifier for the
membership. To set the membership attribute:
▸ provide the argument membership on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location name. To set the location attribute:
▸ provide the argument membership on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ global is the only supported location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--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 container hub memberships update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud container hub memberships 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 gkehub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster
NOTES
These variants are also available:
$ gcloud alpha container hub memberships update
$ gcloud beta container hub memberships update

30
gcloud/container/hub/mesh/describe Normal file
View file

@ -0,0 +1,30 @@
NAME
gcloud container hub mesh describe - describe the status of Service Mesh
Feature resource
SYNOPSIS
gcloud container hub mesh describe [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe the status of Service Mesh Feature resource in Hub.
EXAMPLES
To describe the Service Mesh Feature, run:
$ gcloud container hub mesh describe
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
These variants are also available:
$ gcloud alpha container hub mesh describe
$ gcloud beta container hub mesh describe

34
gcloud/container/hub/mesh/disable Normal file
View file

@ -0,0 +1,34 @@
NAME
gcloud container hub mesh disable - disable Service Mesh Feature
SYNOPSIS
gcloud container hub mesh disable [--force] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Disable the Service Mesh Feature in Hub.
EXAMPLES
To disable the Service Mesh Feature, run:
$ gcloud container hub mesh disable
FLAGS
--force
Disable this feature, even if it is currently in use. Force disablement
may result in unexpected behavior.
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
These variants are also available:
$ gcloud alpha container hub mesh disable
$ gcloud beta container hub mesh disable

29
gcloud/container/hub/mesh/enable Normal file
View file

@ -0,0 +1,29 @@
NAME
gcloud container hub mesh enable - enable Service Mesh Feature
SYNOPSIS
gcloud container hub mesh enable [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Enable the Service Mesh Feature in Hub.
EXAMPLES
To enable the Service Mesh Feature, run:
$ gcloud container hub mesh enable
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
These variants are also available:
$ gcloud alpha container hub mesh enable
$ gcloud beta container hub mesh enable

33
gcloud/container/hub/mesh/help Normal file
View file

@ -0,0 +1,33 @@
NAME
gcloud container hub mesh - manage Service Mesh Feature
SYNOPSIS
gcloud container hub mesh COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Service Mesh Feature.
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 the status of Service Mesh Feature resource.
disable
Disable Service Mesh Feature.
enable
Enable Service Mesh Feature.
NOTES
These variants are also available:
$ gcloud alpha container hub mesh
$ gcloud beta container hub mesh

31
gcloud/container/hub/multi-cluster-services/describe Normal file
View file

@ -0,0 +1,31 @@
NAME
gcloud container hub multi-cluster-services describe - describe the status
of the Multi-cluster Services Feature resource
SYNOPSIS
gcloud container hub multi-cluster-services describe [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command gets the detailed status of the Multi-cluster Services Feature
in Hub.
EXAMPLES
To describe the Multi-cluster Services Feature, run:
$ gcloud container hub multi-cluster-services describe
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
These variants are also available:
$ gcloud alpha container hub multi-cluster-services describe
$ gcloud beta container hub multi-cluster-services describe

36
gcloud/container/hub/multi-cluster-services/disable Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud container hub multi-cluster-services disable - disable the
Multi-cluster Services Feature
SYNOPSIS
gcloud container hub multi-cluster-services disable [--force]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command disables the Multi-cluster Services Feature in Hub.
EXAMPLES
To disable the Multi-cluster Services Feature, run:
$ gcloud container hub multi-cluster-services disable
FLAGS
--force
Disable this feature, even if it is currently in use. Force disablement
may result in unexpected behavior.
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
These variants are also available:
$ gcloud alpha container hub multi-cluster-services disable
$ gcloud beta container hub multi-cluster-services disable

30
gcloud/container/hub/multi-cluster-services/enable Normal file
View file

@ -0,0 +1,30 @@
NAME
gcloud container hub multi-cluster-services enable - enable the
Multi-cluster Services Feature
SYNOPSIS
gcloud container hub multi-cluster-services enable [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command enables the Multi-cluster Services Feature in Hub.
EXAMPLES
To enable the Multi-cluster Services Feature, run:
$ gcloud container hub multi-cluster-services enable
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
These variants are also available:
$ gcloud alpha container hub multi-cluster-services enable
$ gcloud beta container hub multi-cluster-services enable

34
gcloud/container/hub/multi-cluster-services/help Normal file
View file

@ -0,0 +1,34 @@
NAME
gcloud container hub multi-cluster-services - manage Multi-cluster Services
Feature
SYNOPSIS
gcloud container hub multi-cluster-services COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Multi-cluster Services Feature.
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 the status of the Multi-cluster Services Feature resource.
disable
Disable the Multi-cluster Services Feature.
enable
Enable the Multi-cluster Services Feature.
NOTES
These variants are also available:
$ gcloud alpha container hub multi-cluster-services
$ gcloud beta container hub multi-cluster-services