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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando_kubectl-1.29.4.214.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.214.tar.gz
Algorithm Hash digest
SHA256 33aa7b478720b16e8b9900f91feb92a7d46427d77a331db95a41baf2d78d92f4
MD5 61698b362343f80e30e81c8a6d3831c9
BLAKE2b-256 e28f369a4f3144a40d73b25810bb0964a14fd815d07d460104160685e5c948d5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.29.4.214-py3-none-any.whl
Algorithm Hash digest
SHA256 d478c655945a1ba029f60061428b4db248fa180b9eca1342017ff44a2276445d
MD5 42d8208852f629f6425bc2ce00d109fb
BLAKE2b-256 abeaa94f985ee6178509e1813b7ce70cc50f315b59ebab59ceb46847ee087c30

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