- NAME
-
- gcloud alpha container attached clusters register - register an Attached cluster
- SYNOPSIS
-
-
gcloud alpha container attached clusters register(CLUSTER:--location=LOCATION)--distribution=DISTRIBUTION--fleet-project=FLEET_PROJECT--platform-version=PLATFORM_VERSION(--context=CONTEXT:--kubeconfig=KUBECONFIG) (--has-private-issuer|--issuer-url=ISSUER_URL) [--admin-groups=[GROUP,…]] [--admin-users=[USER,…]] [--annotations=ANNOTATION,[ANNOTATION,…]] [--binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE] [--description=DESCRIPTION] [--enable-managed-prometheus] [--logging=COMPONENT,[COMPONENT,…]] [--validate-only] [--proxy-secret-name=PROXY_SECRET_NAME--proxy-secret-namespace=PROXY_SECRET_NAMESPACE] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Register an Attached cluster. - EXAMPLES
-
Register a cluster to a fleet.
To register a cluster with a private OIDC issuer, run:
gcloud alpha container attached clusters register my-cluster --location=us-west1 --platform-version=PLATFORM_VERSION --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION --context=CLUSTER_CONTEXT --has-private-issuerTo register a cluster with a public OIDC issuer, run:
gcloud alpha container attached clusters register my-cluster --location=us-west1 --platform-version=PLATFORM_VERSION --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION --context=CLUSTER_CONTEXT --issuer-url=https://ISSUER_URLTo specify a kubeconfig file, run:
gcloud alpha container attached clusters register my-cluster --location=us-west1 --platform-version=PLATFORM_VERSION --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION --context=CLUSTER_CONTEXT --has-private-issuer --kubeconfig=KUBECONFIG_PATHTo register and set cluster admin users, run:
gcloud alpha container attached clusters register my-cluster --location=us-west1 --platform-version=PLATFORM_VERSION --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION --context=CLUSTER_CONTEXT --issuer-url=https://ISSUER_URL --admin-users=USER1,USER2 - POSITIONAL ARGUMENTS
-
-
Cluster resource - cluster to register. 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
projectattribute:-
provide the argument
clusteron the command line with a fully specified name; -
provide the argument
--projecton 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
clusterattribute:-
provide the argument
clusteron the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
Google Cloud location for the cluster.
To set the
locationattribute:-
provide the argument
clusteron the command line with a fully specified name; -
provide the argument
--locationon the command line; -
set the property
container_attached/location.
-
provide the argument
-
provide the argument
-
Cluster resource - cluster to register. 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.
- REQUIRED FLAGS
-
--distribution=DISTRIBUTION-
Set the base platform type of the cluster to attach.
Examples:
gcloud alpha container attached clusters register --distribution=aksgcloud alpha container attached clusters register --distribution=eks --fleet-project=FLEET_PROJECT- ID or number of the Fleet host project where the cluster is registered.
--platform-version=PLATFORM_VERSION-
Platform version to use for the cluster.
To retrieve a list of valid versions, run:
gcloud alpha container attached get-server-config --location=LOCATIONReplace
LOCATION -
kubectl config
This must be specified.
--context=CONTEXT-
Context to use in the kubeconfig.
This flag argument must be specified if any of the other arguments in this group are specified.
--kubeconfig=KUBECONFIG-
Path to the kubeconfig file.
If not provided, the default at ~/.kube/config will be used.
-
OIDC config
Exactly one of these must be specified:
--has-private-issuer-
Indicates no publicly routable OIDC discovery endpoint exists for the Kubernetes
service account token issuer.
If this flag is set, gcloud will read the issuer URL and JWKs from the cluster's api server.
--issuer-url=ISSUER_URL- Issuer url of the cluster to attach.
- OPTIONAL FLAGS
-
--admin-groups=[GROUP,…]- Groups of users that can perform operations as a cluster administrator.
--admin-users=[USER,…]- Users that can perform operations as a cluster administrator.
--annotations=ANNOTATION,[ANNOTATION,…]- Annotations for the cluster.
--binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE-
Set Binary Authorization evaluation mode for this cluster.
BINAUTHZ_EVALUATION_MODEmust be one of:DISABLED,PROJECT_SINGLETON_POLICY_ENFORCE. --description=DESCRIPTION- Description for the cluster.
--enable-managed-prometheus-
Enables managed collection for Managed Service for Prometheus in the cluster.
See https://cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed#enable-mgdcoll-gke for more info.
Enabled by default for cluster versions 1.27 or greater, use --no-enable-managed-prometheus to disable.
--logging=COMPONENT,[COMPONENT,…]-
Set the components that have logging enabled.
Examples:
gcloud alpha container attached clusters register --logging=SYSTEMgcloud alpha container attached clusters register --logging=SYSTEM,WORKLOADgcloud alpha container attached clusters register --logging=NONECOMPONENTmust be one of:NONE,SYSTEM,WORKLOAD. --validate-only- Validate the cluster to create, but don't actually perform it.
-
Proxy config
--proxy-secret-name=PROXY_SECRET_NAME-
Name of the Kubernetes secret that contains the HTTP/HTTPS proxy configuration.
This flag argument must be specified if any of the other arguments in this group are specified.
--proxy-secret-namespace=PROXY_SECRET_NAMESPACE-
Namespace of the Kubernetes secret that contains the HTTP/HTTPS proxy
configuration.
This flag argument must be specified if any of the other arguments in this group are specified.
- 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 helpfor details. - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. This variant is also available:
gcloud container attached clusters register
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]