Setup kubeconfigs for all accessible GKE clusters. It is the same as running gcloud container clusters get-credentials
for every cluster in every project but faster.
Note
This tool is in beta. Its behavior and interface may change in the future. If you have any ideas or suggestions, or if you found a bug, please create an issue or a pull request.
Important
Make sure Application Default Credentials (ADC) are set up. You can do this by running gcloud auth application-default login
.
gke-kubeconfiger
can work with kubeconfigs in two modes: single file and multiple files. It also has several flags to
control its behavior.
gke-kubeconfiger discovers GKE clusters and updates the KUBECONFIG file to include them.
Usage:
gke-kubeconfiger [flags]
Flags:
--auth-plugin string Name of the auth plugin to use in kubeconfig (default "gke-gcloud-auth-plugin")
--batch-size int Batch size (default 10)
--config string config file (default is $HOME/.gke-kubeconfiger.yaml)
--dest-dir string Destination directory to write kubeconfig files.
If set, every kubeconfig will be written to a separate file (default ".")
-h, --help help for gke-kubeconfiger
--log-level string Sets logging level: trace, debug, info, warning, error, fatal, panic (default "info")
--projects strings Projects to filter by
--rename Rename kubeconfig contexts
--rename-tpl string Rename template (default "{{ .ProjectID }}/{{ .Location }}/{{ .ClusterName }}")
-v, --version version for gke-kubeconfiger
Note
Because the user
part for every connection to a GKE cluster is the same, gke-kubeconfiger
uses a single user
entry for all contexts that are being added or updated.
Without any flags, gke-kubeconfiger
will discover all GKE clusters in all GCP projects you have access to and update
or add the corresponding kubeconfig entries.
The kubeconfig file is read from the KUBECONFIG
environment variable or the default location ($HOME/.kube/config
).
# Update the current kubeconfig file in-place
gke-kubeconfiger
To write every kubeconfig to a separate file, use the --dest-dir
flag. The kubeconfig files will be named
<project_id>_<region>_<cluster_name>.yaml
and placed in the specified directory.
# Write kubeconfigs to the ~/.kube/gke.clusters/ directory for every GKE cluster
gke-kubeconfiger --dest-dir ~/.kube/gke.clusters/
You can filter the projects by using the --projects
flag. The flag accepts a list of project IDs separated by commas.
Only clusters from the specified projects will be included in the kubeconfig.
# Include only the specified projects
gke-kubeconfiger --projects project-1,project-2
By default, gke-kubeconfiger
names clusters, contexts, and users in the kubeconfig file in the same way as gcloud
does, using the following template:
gke_{{ .ProjectID }}_{{ .Location }}_{{ .ClusterName }}
You can change this behavior by using the --rename
flag. The --rename-tpl
flag allows you to specify a custom
template for the context name. The template is parsed using the text/template
package with the following fields:
.ClusterName
- the cluster name.Location
- the cluster location.ProjectID
- the project ID.Server
- the cluster endpoint with the protocol
Examples of renaming contexts:
# Default context names (gke_{{ .ProjectID }}_{{ .Location }}_{{ .ClusterName }})
gke-kubeconfiger
# Rename using the default template ({{ .ProjectID }}/{{ .Location }}/{{ .ClusterName }})
gke-kubeconfiger --rename
# Rename using a custom template ({{ .ClusterName }})
gke-kubeconfiger --rename --rename-tpl "{{ .ClusterName }}"
By default, gke-kubeconfiger
processes clusters in batches of 10. You can change this value using the --batch-size
By default, gke-kubeconfiger
uses the gke-gcloud-auth-plugin
auth plugin, as gcloud
does. You can use another auth
plugin by specifying the --auth-plugin
flag.
# Use the gke-gcloud-auth-plugin auth plugin
gke-kubeconfiger
# Use the custom-gke-auth-plugin auth plugin
gke-kubeconfiger --auth-plugin custom-gke-auth-plugin
yay -S gke-kubeconfiger-bin
See the container registry page for details.
docker pull ghcr.io/zebradil/gke-kubeconfiger:latest
See the latest release page for the full list of packages.
Download the archive for your OS from the releases page.
Or get the source code and build the binary:
git clone https://github.com/Zebradil/gke-kubeconfiger.git
# OR
curl -sL https://github.com/Zebradil/gke-kubeconfiger/archive/refs/heads/master.tar.gz | tar xz
cd gke-kubeconfiger-master
go build -o gke-kubeconfiger main.go
Now you can run gke-kubeconfiger
manually (see Usage section).
Builds and releases are done with goreleaser.
There are several ways to build the application:
# Build with go for the current platform
go build -o gke-kubeconfiger main.go
# Build with GoReleaser for all configured platforms
task go:build
Check the Taskfile.yml for more details.
.goreleaser.yml
manually, do changes in .goreleaser.ytt.yml
and run
task misc:build:goreleaser-config
instead (requires ytt
installed).