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

Uploaded Source

Built Distribution

zalando_kubectl-1.29.4.213-py3-none-any.whl (53.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for zalando_kubectl-1.29.4.213.tar.gz
Algorithm Hash digest
SHA256 2a423003e8132512a10eb8446810c3e35166d04137bea0e6a19b670e3581c734
MD5 b0cbaf326254e5cbe40433477d172e17
BLAKE2b-256 2a623cacecd5bfed68d16c932b4a6be441c2e059cf79bbb868f13ec7988a289a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.29.4.213-py3-none-any.whl
Algorithm Hash digest
SHA256 d70806b27a0f72064feb01f46a0e925505d33bddd0330d1633655330320d3019
MD5 3449ec73601a9999427b518cdc779eeb
BLAKE2b-256 49e06b9cabcdfde32c12e555f30fcb15cd3c19fd167d8851f71cae9a5293e901

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