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

Uploaded Source

Built Distribution

zalando_kubectl-1.14.6.79-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando-kubectl-1.14.6.79.tar.gz
  • Upload date:
  • Size: 24.5 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.6.79.tar.gz
Algorithm Hash digest
SHA256 10e60aaa1788f75eaa417d0f42b75fc6d6dbe5d31ab5127f9d837dae610ba15d
MD5 29bbc0e12c65596e0d70f68920c09874
BLAKE2b-256 150e40e62e91f1cf8a031d26470f95da2773264a105cff90568b0d559319a648

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: zalando_kubectl-1.14.6.79-py3-none-any.whl
  • Upload date:
  • Size: 37.4 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.6.79-py3-none-any.whl
Algorithm Hash digest
SHA256 e82e40f64481a203d967b3735ac110e20e80e011032c11ac7bfe977ad6cc0137
MD5 4effd333a37a581b21cca1cbe78615a3
BLAKE2b-256 c0226a707e13d5d109f9cc2bd3071d840fddc559a5258afaf1e4728e7620d9de

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