Kubectl wrapper in Python with OAuth token auth
Project description
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
Built Distribution
Hashes for zalando-kubectl-1.25.16.186.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c639b6641e3b8b0a8b088fd68df1583bd062a3614386fc97f1e1694c6b94a76 |
|
MD5 | 3628aa91727c0e1002d575c5a5381ed0 |
|
BLAKE2b-256 | bb3f69bf527cc1024a13cbc6833d9a2a9302301c199618a315c5991717e9948a |
Hashes for zalando_kubectl-1.25.16.186-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28c8c1f75af4286c68a4353ebb3c2b9e1d84ceb7d385fe4f673a82e3ecb358d1 |
|
MD5 | 928128ca1880c174dd0ed2ae895e0fef |
|
BLAKE2b-256 | 7d9f40f354171f268894dc2539603c8d42af417bc1cd287cc8bd481538d8b0b1 |