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 <wahatever>

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

Uploaded Source

Built Distribution

zalando_kubectl-1.18.8.126-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando-kubectl-1.18.8.126.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6

File hashes

Hashes for zalando-kubectl-1.18.8.126.tar.gz
Algorithm Hash digest
SHA256 efd60ba82a3d16f5becfab95b0bc80c93819881313004a6137386933dd3d6d81
MD5 953b8353c889e6c88d8425e48f8aa68c
BLAKE2b-256 6060cce6ce0ba48b5e7859e01d8ad88089c2771bf72ffd5a35bf1988534e739b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: zalando_kubectl-1.18.8.126-py3-none-any.whl
  • Upload date:
  • Size: 41.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6

File hashes

Hashes for zalando_kubectl-1.18.8.126-py3-none-any.whl
Algorithm Hash digest
SHA256 784abc0231e2c15e18caeeec477a5f3b174785ec82a98d22cd8f1e130f2f10ad
MD5 6f443bd0f5bf64b135a294a6ad8ba54b
BLAKE2b-256 eb5d085ce7a0f73b39ee0d2d2154405aef1072b8e5faa1c0e1e1d278ad4a4fad

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