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

Uploaded Source

Built Distribution

zalando_kubectl-1.30.2.216-py3-none-any.whl (53.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando_kubectl-1.30.2.216.tar.gz
  • Upload date:
  • Size: 52.2 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.216.tar.gz
Algorithm Hash digest
SHA256 b6ceea2e72b05fcc16fb0dca1d8624d7a25f2d757596dc1dbb4288078520fe74
MD5 185a8e25077224f9e02f52c813f230a4
BLAKE2b-256 f0dadf56eac5f5632eead12629ee4103a33c9cffcc6a77990543648ccf9c8b07

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.30.2.216-py3-none-any.whl
Algorithm Hash digest
SHA256 bfede9fe0cd5acbf6bcbdba8f42b84493aa927aabe9971821612d4fab1875446
MD5 6c42dee40b3dfe016266924f91e1f4ff
BLAKE2b-256 92aca925656c84f6a22107cee2207b4c5f027cf17c0933ac10d49f381bac032c

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