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

Uploaded Source

Built Distribution

zalando_kubectl-1.30.2.222-py3-none-any.whl (54.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for zalando_kubectl-1.30.2.222.tar.gz
Algorithm Hash digest
SHA256 b205d1807517b5751afb4e6169bf6bb44a013dcaebe4345da5af44f71bbdb90b
MD5 b4a3e467c418f14681dbd92999df9774
BLAKE2b-256 5bf6995b668f5dd4454f71e2a212a32a710e78d59206a0139b4cbbcb989d5995

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.30.2.222-py3-none-any.whl
Algorithm Hash digest
SHA256 0020de6a3a58f607b6075b146e8297d1651e1b4d32847636d258f06da5a6def1
MD5 26ed4770c279c867e0e87fac8360c274
BLAKE2b-256 9b16383e88e1ee89d59a40b0f1447b62ae41cadccbb61f571650ea96352b898b

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