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

Uploaded Source

Built Distribution

zalando_kubectl-1.25.16.188-py3-none-any.whl (53.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zalando-kubectl-1.25.16.188.tar.gz
  • Upload date:
  • Size: 51.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for zalando-kubectl-1.25.16.188.tar.gz
Algorithm Hash digest
SHA256 0bef29c2be783a7590139fbcd7c17528f7ea69e1b66ab06ed0caa40fa48dfa14
MD5 296e5aef8d6c18cdd474364406fda706
BLAKE2b-256 142bb9d97d7a1167c5b4ea603b94e8825617ad2217c42be09472353831b08efa

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for zalando_kubectl-1.25.16.188-py3-none-any.whl
Algorithm Hash digest
SHA256 0a2ca57b3149cab3a0e13778d48631c452a855db1d54e21275ff61c94f6defb3
MD5 37f59b08d86e43ef17b101e71f2603e1
BLAKE2b-256 f680ae84e16dce4633cc00373aa8b301455edefbe15169705ce9bb0dc9564706

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