https://github.com/devgine/gke-utils
Docker image based on official alpine image and google cloud sdk and necessary tools to manage a kubernetes cluster hosted in GKE (google kubernetes engine). Available tools (gcloud, kubectl, helm, kustomize and kubeseal)
https://github.com/devgine/gke-utils
cloud gcloud gcp gke gke-cluster google-cloud google-cloud-platform helm kubectl kubernetes kubernetes-cluster kubeseal kustomize
Last synced: 9 months ago
JSON representation
Docker image based on official alpine image and google cloud sdk and necessary tools to manage a kubernetes cluster hosted in GKE (google kubernetes engine). Available tools (gcloud, kubectl, helm, kustomize and kubeseal)
- Host: GitHub
- URL: https://github.com/devgine/gke-utils
- Owner: devgine
- License: mit
- Created: 2023-05-11T10:09:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-31T08:38:16.000Z (almost 3 years ago)
- Last Synced: 2025-06-25T02:08:50.772Z (9 months ago)
- Topics: cloud, gcloud, gcp, gke, gke-cluster, google-cloud, google-cloud-platform, helm, kubectl, kubernetes, kubernetes-cluster, kubeseal, kustomize
- Language: Dockerfile
- Homepage: https://github.com/devgine/gke-utils/pkgs/container/gke-utils/versions
- Size: 14.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GKE Utilities
[](https://github.com/devgine/gke-utils/actions/workflows/build.yaml)
[](https://github.com/devgine/gke-utils/blob/main/LICENSE)
[](https://github.com/devgine/gke-utils/actions/workflows/packages-retention-policy.yaml)
## About
This is a docker image based on official alpine image and google cloud sdk and necessary tools to manage a kubernetes cluster hosted in GKE (google kubernetes engine).
Available tools in this image :
* gcloud
* gke-gcloud-auth-plugin
* kubectl
* helm
* kustomize
* kubeseal
## Content
Below is the list of tools with their preinstalled version.
| Image tag | Alpine | gcloud | kubectl | helm | kustomize | kubeseal |
|-------------------------------------------------------------|--------|---------|---------|------|-----------|----------|
| `gke-utils:latest`
`gke-utils:432.0.0-k8s1.27.1-alpine` | 3.17 | 432.0.0 | 1.27 | 3.11 | 5.0 | 0.20 |
| `gke-utils:432.0.0-k8s1.26.3-alpine` | 3.17 | 432.0.0 | 1.26 | 3.11 | 5.0 | 0.20 |
| `gke-utils:432.0.0-k8s1.25.9-alpine` | 3.17 | 432.0.0 | 1.25 | 3.11 | 5.0 | 0.20 |
| `gke-utils:432.0.0-k8s1.24.13-alpine` | 3.17 | 432.0.0 | 1.24 | 3.11 | 5.0 | 0.20 |
## Requirements
### Credentials
To connect to the cluster on GKE you must download the service account or the identity federation pool credentials.
The credentials file should be mounted to `/var/gcloud/credentials.json` in the container.
> More information about creating service account credentials [here](https://support.google.com/a/answer/7378726?hl=en)
### Configuration
You need to do some configuration to connect to the correct cluster in GKE.
The configuration file should be mounted to `/var/gcloud/config.json` in the container.
Bellow is the content of the configuration file :
```json
{
"project_id": "project-id-1234",
"gke": {
"cluster_name": "cluster-name",
"cluster_region": "europe-central2-a"
},
"acr": {
"region": "us-central1"
}
}
```
| Config key | Required | Description |
|--------------------|----------|------------------------------------------------------|
| project_id | true | The GCP project id |
| gke.cluster_name | true | The name of your cluster in GKE |
| gke.cluster_region | true | The region of your cluster in GKE |
| acr.region | false | The region of your artifact or registry (ACR or GCR) |
> The `acr.region` is required only if you use helm to deploy into the cluster.
## Usage
### Use with docker
```shell
docker run --rm -ti \
-v PATH/config.json:/var/gcloud/config.json \
-v PATH/credentials.json:/var/gcloud/credentials.json \
-v MANIFEST_DIRECTORY:/var/gke-utils \
ghcr.io/devgine/gke-utils:latest sh
```
> You can change latest with specific tag
> [Available versions](https://github.com/devgine/gke-utils/pkgs/container/gke-utils/versions)
Connect to the container and check if connection to the cluster is done.
```shell
kubectl config get-contexts
```
### Use with docker-compose
```yaml
version: '3.8'
services:
kubernetes:
image: ghcr.io/devgine/gke-utils:latest
container_name: kubernetes
volumes:
- './manifest/:/var/gke-utils'
- './.gcloud/:/var/gcloud' # .gcloud/ dir contains config.json and credentials.json files
- 'kube_data:/root/.kube'
- 'docker_data:/root/.docker'
- 'config_data:/root/.config'
- 'cache_data:/root/.cache'
volumes:
kube_data:
driver: local
docker_data:
driver: local
config_data:
driver: local
cache_data:
driver: local
```
> `manifest` directory contains the kubernetes manifest
> `.gcloud` directory contains config.json and credentials.json
Connect to the container
```shell
docker-compose up -d && docker-compose exec kubernetes sh
```
Check if connection to the cluster is done.
```shell
kubectl config get-contexts
```
### Use in Dockerfile
```dockerfile
FROM ghcr.io/devgine/gke-utils:latest
# Add your specific instruction here (exp: install terraform)
RUN release=`curl -s https://api.github.com/repos/hashicorp/terraform/releases/latest | grep tag_name | cut -d: -f2 | tr -d \"\,\v | awk '{$1=$1};1'`
RUN wget https://releases.hashicorp.com/terraform/${release}/terraform_${release}_linux_amd64.zip
RUN unzip terraform_${release}_linux_amd64.zip
RUN mv terraform /usr/bin/terraform
```
## References
### GKE releases
https://cloud.google.com/kubernetes-engine/docs/release-notes
### Google cloud SDK
https://hub.docker.com/r/google/cloud-sdk/
### K8S
https://hub.docker.com/r/alpine/k8s