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.22.17.157.tar.gz (15.7 MB view details)

Uploaded Source

Built Distribution

zalando_kubectl-1.22.17.157-py3-none-any.whl (15.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando-kubectl-1.22.17.157.tar.gz
  • Upload date:
  • Size: 15.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for zalando-kubectl-1.22.17.157.tar.gz
Algorithm Hash digest
SHA256 b5a3dadaa5b63a62d3566b73412514909023750a858e33242e14d9b84d73dc0f
MD5 24daf3d45db53f30a77fedd6a8835593
BLAKE2b-256 e88250412931240c8bb0565095a9ec77561f9dd0ff64b9173a454b646299c267

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.22.17.157-py3-none-any.whl
Algorithm Hash digest
SHA256 aab25d040088a459de4b0e36c480d85251946e745c5d7b394abe75cb940cbad1
MD5 676a2abfff766f30fdd9f61791155699
BLAKE2b-256 abe776840793cf88c126e90c637bb5a3892c2d2d7b958d199d24aca7cbd42111

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