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 <whatever>

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

Uploaded Source

Built Distribution

zalando_kubectl-1.30.2.219-py3-none-any.whl (54.0 kB view details)

Uploaded Python 3

File details

Details for the file zalando_kubectl-1.30.2.219.tar.gz.

File metadata

  • Download URL: zalando_kubectl-1.30.2.219.tar.gz
  • Upload date:
  • Size: 52.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.19

File hashes

Hashes for zalando_kubectl-1.30.2.219.tar.gz
Algorithm Hash digest
SHA256 f5d9cd17b7554f84f54cb488f722cf3cd2537870a3e6d422e123dd8e6be5d07d
MD5 18305eecd9089a69f65db776f24b50a7
BLAKE2b-256 1179aa777a71680cf5c39e08447f8f2f51170d249ec576ba5afeb776aa1b8d31

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.30.2.219-py3-none-any.whl
Algorithm Hash digest
SHA256 92d6e2450de7991c7df9e586600c297627c99c15007ba0e9fad94f9b3cb4884d
MD5 7c66d30ede7dc604a40c02273153ea65
BLAKE2b-256 9feb7771fd49eee8103a9dc669bf29e8b1e04e2d905a09404dc8af9f96f6501d

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