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

Uploaded Source

Built Distribution

zalando_kubectl-1.30.2.217-py3-none-any.whl (53.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando_kubectl-1.30.2.217.tar.gz
  • Upload date:
  • Size: 52.3 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.217.tar.gz
Algorithm Hash digest
SHA256 a0d137a1c029009caf5c0d5291b944f159d365a153b519a936d813404c488ca0
MD5 8a0567a9f6b88da26e92c5ffac9997c6
BLAKE2b-256 dd83356440d6037876385c18523f3db4c77b2572f738d7a7ff0c7d04c5f4d0e7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.30.2.217-py3-none-any.whl
Algorithm Hash digest
SHA256 66d7c717b6f36c392b8dd997fe1c28116ca2888f4e9706c55beba4a22215c443
MD5 bd466a173c812b6b537dccc761365df2
BLAKE2b-256 c2414cfb77debcd8c8bbc8fb87da272d72daab1758dae36b5830c9a963686e70

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