File: //snap/google-cloud-cli/396/help/man/man1/gcloud_container_clusters_get-credentials.1
.TH "GCLOUD_CONTAINER_CLUSTERS_GET\-CREDENTIALS" 1
.SH "NAME"
.HP
gcloud container clusters get\-credentials \- fetch credentials for a running cluster
.SH "SYNOPSIS"
.HP
\f5gcloud container clusters get\-credentials\fR \fINAME\fR [\fB\-\-dns\-endpoint\fR] [\fB\-\-internal\-ip\fR] [\fB\-\-location\fR=\fILOCATION\fR\ |\ \fB\-\-region\fR=\fIREGION\fR\ |\ \fB\-\-zone\fR=\fIZONE\fR,\ \fB\-z\fR\ \fIZONE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
gcloud container clusters get\-credentials updates a \f5kubeconfig\fR file with
appropriate credentials and endpoint information to point \f5kubectl\fR at a
specific cluster in Google Kubernetes Engine.
It takes a project and a zone as parameters, passed through by set defaults or
flags. By default, credentials are written to \f5HOME/.kube/config\fR. You can
provide an alternate path by setting the \f5KUBECONFIG\fR environment variable.
If \f5KUBECONFIG\fR 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.
By default, gcloud container clusters get\-credentials will configure kubectl to
automatically refresh its credentials using the same identity as gcloud. If you
are running kubectl as part of an application, it is recommended to use
application default credentials
(https://cloud.google.com/docs/authentication/production). To configure a
\f5kubeconfig\fR file to use application default credentials, set the
container/use_application_default_credentials Cloud SDK property
(https://cloud.google.com/sdk/docs/properties) to true before running gcloud
container clusters get\-credentials
See
https://cloud.google.com/kubernetes\-engine/docs/how\-to/cluster\-access\-for\-kubectl
for kubectl usage with Google Kubernetes Engine and
https://kubernetes.io/docs/reference/generated/kubectl/kubectl\-commands for
available kubectl commands.
.SH "EXAMPLES"
To switch to working on your cluster 'sample\-cluster', run:
.RS 2m
$ gcloud container clusters get\-credentials sample\-cluster \e
\-\-location=us\-central1\-f
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
\fINAME\fR
Name of the cluster to get credentials for. Overrides the default
\fBcontainer/cluster\fR property value for this command invocation.
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-dns\-endpoint\fR
Whether to use the DNS\-based endpoint for the cluster address.
.TP 2m
\fB\-\-internal\-ip\fR
Whether to use the internal IP address of the cluster endpoint.
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR
Compute zone or region (e.g. us\-central1\-a or us\-central1) for the cluster.
Overrides the default compute/region or compute/zone value for this command
invocation. Prefer using this flag over the \-\-region or \-\-zone flags.
.TP 2m
\fB\-\-region\fR=\fIREGION\fR
Compute region (e.g. us\-central1) for a regional cluster. Overrides the default
compute/region property value for this command invocation.
.TP 2m
\fB\-\-zone\fR=\fIZONE\fR, \fB\-z\fR \fIZONE\fR
Compute zone (e.g. us\-central1\-a) for a zonal cluster. Overrides the default
compute/zone property value for this command invocation.
.RE
.RE
.sp
.SH "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 \fB$ gcloud help\fR for details.
.SH "NOTES"
These variants are also available:
.RS 2m
$ gcloud alpha container clusters get\-credentials
.RE
.RS 2m
$ gcloud beta container clusters get\-credentials
.RE