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

$ 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.

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zalando_kubectl-1.14.7.86-py3-none-any.whl (39.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando-kubectl-1.14.7.86.tar.gz
  • Upload date:
  • Size: 25.6 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.14.7.86.tar.gz
Algorithm Hash digest
SHA256 40f5333528c37e8bba9bcff54cc002b7ca5b02acf8b4afa18b9d2a5b3d2407b4
MD5 aa4bff0b321a9d092a751095579340c3
BLAKE2b-256 9101cda262eb55efca6060d5ad6ce261a24a767e0bae292f7e0f7d42bfe872f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: zalando_kubectl-1.14.7.86-py3-none-any.whl
  • Upload date:
  • Size: 39.2 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.14.7.86-py3-none-any.whl
Algorithm Hash digest
SHA256 7ca92085d4e4220f07ca005d1cc280ce32a861f57963c72828956517c4cf28ea
MD5 56e73230887da704af4f31a0a36e57ee
BLAKE2b-256 552051b9f9df7efca94e6dcbd631d87cb6d32ec333b3729805f121c315dfd2e3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page