Skip to main content

Kubectl wrapper in Python with OAuth token auth

Project description

PyPI Downloads Latest PyPI version License

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

Installation

Requires Python 3.6+.

$ sudo pip3 install --upgrade zalando-kubectl

Usage

You can directly login to a known Kubernetes API server endpoint:

$ zkubectl login https://my-api-server.example.org
$ zkubectl cluster-info

You can also configure a Cluster Registry to look up clusters by ID:

$ zkubectl configure --cluster-registry=https://cluster-registry.example.org
$ zkubectl login my-cluster-id

The Cluster Registry needs to provide the following HTTP API for this to work:

$ curl -H "Authorization: Bearer $(zign tok)" https://cluster-registry.example.org/kubernetes-clusters/my-cluster-id
{
    "api_server_url": "https://my-api-server.example.org"
}

There is an additional convenience command to open the kube-web-view dashboard in the browser:

$ zkubectl dashboard
Opening https://kube-web-view.zalando.net/ ..

Unit Tests

Run unit tests with Tox:

$ sudo pip3 install tox
$ tox

Local Changes

It’s recommended to have a virtualenv for the project. The project uses Black for code formatting, please configure your editor to use it.

Go to the project dir and install dependencies

$ cd <project-path>
$ pip install -r requirements.txt
$ pip install --editable .

Now the code change will just be reflected in the zkubectl binary

$ zkubectl <whatever>

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zalando_kubectl-1.31.1.235.tar.gz (53.3 kB view details)

Uploaded Source

Built Distribution

zalando_kubectl-1.31.1.235-py3-none-any.whl (54.5 kB view details)

Uploaded Python 3

File details

Details for the file zalando_kubectl-1.31.1.235.tar.gz.

File metadata

  • Download URL: zalando_kubectl-1.31.1.235.tar.gz
  • Upload date:
  • Size: 53.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.20

File hashes

Hashes for zalando_kubectl-1.31.1.235.tar.gz
Algorithm Hash digest
SHA256 6edc39e27af9c6478b3948c6a7a26d66ed30ce8b3fb785b504116d423a6b00c4
MD5 2a584064e0da819df152631d07330fc2
BLAKE2b-256 394c7f6c1bf3fdfa2e3ca412bfe9de848584e043f24c46f594293ff16f8273ba

See more details on using hashes here.

Provenance

File details

Details for the file zalando_kubectl-1.31.1.235-py3-none-any.whl.

File metadata

File hashes

Hashes for zalando_kubectl-1.31.1.235-py3-none-any.whl
Algorithm Hash digest
SHA256 4b1a8fb736c1b579a1545670f41ab2a4e369e946bf7a87c34f2c3a9d2c406201
MD5 a741f079370e9629b4565241e9419645
BLAKE2b-256 f14e1eaface84483a36a78adcab5245bd3d43eafdb6c5faee1a38ebb07f37242

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page