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

Uploaded Source

Built Distribution

zalando_kubectl-1.24.17.175-py3-none-any.whl (52.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando-kubectl-1.24.17.175.tar.gz
  • Upload date:
  • Size: 49.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.18

File hashes

Hashes for zalando-kubectl-1.24.17.175.tar.gz
Algorithm Hash digest
SHA256 6ccdb615a86721ea72ab37768d925fcf2d443949b3f7d3fe142eab87c4e90170
MD5 7ed6db9b92222b046469dd893edbe36d
BLAKE2b-256 1f7b3b8d304bb2dfc65ae6e78e380434408f63ae66f118d3784e33cab45330b2

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.24.17.175-py3-none-any.whl
Algorithm Hash digest
SHA256 4139add21ab74da91b4cc0545a08f8067bfb9e50d842f884353eb663db0d571b
MD5 496bacdecc98329c39259682d8e0b959
BLAKE2b-256 27709edba61256c16f3df114657b9077e44d789e09143b7e2b48bd2d5dc97544

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