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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando_kubectl-1.31.1.234.tar.gz
  • Upload date:
  • Size: 53.4 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.234.tar.gz
Algorithm Hash digest
SHA256 7dd1ef6d992876bfe5314d0ba873aedbf0e08f9ace5686d9a2b64dc6cd23a496
MD5 0494f9ac4715f14f86ae3511a7a0a507
BLAKE2b-256 3afc33c65d682ed8170c1a8452b5b95d492353fe0aa9b26db70b3bc6d5e6689b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.31.1.234-py3-none-any.whl
Algorithm Hash digest
SHA256 b02a84060504a7a7990d02eb0191a0a7e6101b444d720f034eb805f9f6be117b
MD5 ee36a715b0a5f503ce1f135530dc9aa4
BLAKE2b-256 fe767ccf6ca2355b0d00916306d262a55246be20a1f4f5df6bf7e9503ee342f9

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