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.30.2.231.tar.gz (53.1 kB view details)

Uploaded Source

Built Distribution

zalando_kubectl-1.30.2.231-py3-none-any.whl (54.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando_kubectl-1.30.2.231.tar.gz
  • Upload date:
  • Size: 53.1 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.30.2.231.tar.gz
Algorithm Hash digest
SHA256 9223e5359f4c8b14dcd79bffdadb5ff158a2b1227a6b9caba2b7a7e977b47974
MD5 7563a0c04209052e44fe16d864f153ec
BLAKE2b-256 24d69dba99addd8e99e29950eeaa3d3608b5f0333423880ba022ef8844a0404c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.30.2.231-py3-none-any.whl
Algorithm Hash digest
SHA256 3af3138889e5168d56cbf6626d7accb0957d44a468acf67aba0309a2516fde3c
MD5 859391520d1224b02339d9aedfd26208
BLAKE2b-256 d31800b196e9b0e89f9e7ca718628ee2564dc7611429b5c22b7857b2fac84993

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