zalando-kubectl 1.35.3.386

Kubectl wrapper in Python with OAuth token auth

Zalando Kubectl

Description

Kubernetes CLI (kubectl) wrapper in Python with OAuth token authentication.

This wrapper script zkubectl serves as a drop-in replacement for the kubectl binary:

• it downloads the current kubectl binary from Google
• it generates a new ~/.kube/config with an OAuth Bearer token acquired via zign.
• it passes through commands to the kubectl binary

User Facing documentation

• https://cloud.docs.zalando.net/reference/zkubectl/
• https://cloud.docs.zalando.net/howtos/install-tools/

Contribute

Setup project

• It's recommended to use uv for the project.

Go to the project dir and install dependencies with uv

$ cd <project-path>
$ uv sync

• [Optional] install pre-commit hooks

$ pre-commit install

• [Optional] The project uses ruff for code formatting, configure your editor to use it.

Unit Tests

Run unit tests with Docker:

docker build --build-arg PYTHON_VERSION=3.10 --build-arg PACKAGE_NAME=zalando_kubectl -f Dockerfile.test .
docker build --build-arg PYTHON_VERSION=3.11 --build-arg PACKAGE_NAME=zalando_kubectl -f Dockerfile.test .
docker build --build-arg PYTHON_VERSION=3.12 --build-arg PACKAGE_NAME=zalando_kubectl --build-arg DEBIAN_DISTRO=bullseye -f Dockerfile.test .
docker build --build-arg PYTHON_VERSION=3.13 --build-arg PACKAGE_NAME=zalando_kubectl --build-arg DEBIAN_DISTRO=bullseye -f Dockerfile.test .

Run Locally

via uv

$ uv run zkubectl

Or first activate the virtualenv

$ source .venv/bin/activate
$ zkubectl login playground

Use as kubectl plugin

The project exposes scripts that use the kubectl plugin format

You can see which ones are available in the scripts section of pyproject.toml

In order for kubectl to detect the subcommands provided by the script, they must be in the PATH, so you need first to activate the virtualenv

$ source .venv/bin/activate
$ kubectl login playground