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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando-kubectl-1.13.9.78.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.13.9.78.tar.gz
Algorithm Hash digest
SHA256 2fafed8ca56f8175c90440711f6dcbb76b9e08bde4c7acf21081e024ee60d5d0
MD5 503b36492a3b5a115addfb263ce0de10
BLAKE2b-256 b9e8543c63e817e5e08dcfb6e37c350f8edd1c850fadd8edeb5dc78b9e7fb959

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: zalando_kubectl-1.13.9.78-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.13.9.78-py3-none-any.whl
Algorithm Hash digest
SHA256 e235cc9f1bbef8ec3f089593914a8b0cc1f1bca8b3e1783243f2f5c02ef0adb8
MD5 4ea4a6e4d4b396bf86f03fe2f86f9343
BLAKE2b-256 1ee360653d7e6ad497e0debb0fff6d72eab132e0cd7992783ea81eefd992e715

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