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

Uploaded Source

Built Distribution

zalando_kubectl-1.29.4.211-py3-none-any.whl (53.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for zalando_kubectl-1.29.4.211.tar.gz
Algorithm Hash digest
SHA256 8046c27d977cd9dd1d1495c97e535c4bdf011ffe03e619cf02b0006d854d621a
MD5 67b7d2c259fadebe9da4bca40a8533b8
BLAKE2b-256 b617b6b5d0d87609a6a2a88412eee440e0556d3765e3143f4685828ad1f4d9fc

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.29.4.211-py3-none-any.whl
Algorithm Hash digest
SHA256 669737520af5e817dd5e738362b03cf79c80dfacd0cfef489b26ac63728caa14
MD5 7892363a23e185bd85cebf27d1f9fe84
BLAKE2b-256 095fcafb6fe575d8d7b36db4df57d6d467d23cb4b358614e390ee26c104a89d2

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