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.5+.

$ 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.15.6.104.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

zalando_kubectl-1.15.6.104-py3-none-any.whl (43.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando-kubectl-1.15.6.104.tar.gz
  • Upload date:
  • Size: 28.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.9.1 pkginfo/1.4.1 requests/2.18.4 setuptools/38.3.0 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.4

File hashes

Hashes for zalando-kubectl-1.15.6.104.tar.gz
Algorithm Hash digest
SHA256 e5e954b8c2a7d05242fa26cd0674ffc1782b450911f87a014e28d2ba02d4ae90
MD5 713df18177b814e72cda7378c58a4ac9
BLAKE2b-256 7708958031cd38bae249ac95784bf2d4d978bf0548388f941833bd7b04d838d7

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: zalando_kubectl-1.15.6.104-py3-none-any.whl
  • Upload date:
  • Size: 43.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.9.1 pkginfo/1.4.1 requests/2.18.4 setuptools/38.3.0 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.4

File hashes

Hashes for zalando_kubectl-1.15.6.104-py3-none-any.whl
Algorithm Hash digest
SHA256 d0c90cb30916568558842d1dee3062c6a8d021fb9c13f654fd1f5f4334aeca7c
MD5 de2811c2e9ff87f68937518b5f783659
BLAKE2b-256 8d913129794b84a116375dab1daffa07451f43652380ec3da4c9a88ebe66be66

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