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 Kubernetes Dashboard web UI in the browser:

$ zkubectl dashboard
Waiting for local kubectl proxy.. . . . . . . . . . .Starting to serve on 127.0.0.1:8001 OK

Opening http://localhost:8001/api/v1/namespaces/kube-system/services/kubernetes-dashboard/proxy ..

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

Uploaded Source

Built Distribution

zalando_kubectl-1.25.16.189-py3-none-any.whl (53.0 kB view details)

Uploaded Python 3

File details

Details for the file zalando-kubectl-1.25.16.189.tar.gz.

File metadata

  • Download URL: zalando-kubectl-1.25.16.189.tar.gz
  • Upload date:
  • Size: 51.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for zalando-kubectl-1.25.16.189.tar.gz
Algorithm Hash digest
SHA256 bb85c83bf81c6f66953505b71053517e346aaa074692c8581df6aa17befa8777
MD5 c1dcec37a423e8226b6a2a6b9fbfe937
BLAKE2b-256 694474aec0fa611a4e1fb2f3ab6c8ea17de3da08709e39d1fd5d2de31b55a1a8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.25.16.189-py3-none-any.whl
Algorithm Hash digest
SHA256 1a751bc0e709987738c8fc4278b5885ec7f4360b08fe8e4f0b5e9393ba10cd1a
MD5 0ddb3c7860473ec76692ce7e5d326704
BLAKE2b-256 87f9c37eddf5ea93e82bd720c63b9248476b6abf0b57b7e8a2b812f54878ca87

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