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.24.17.180.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64a34e84bd88c61df4a151a8f0d520d2a01576759246cc4877c915dbd84ce782 |
|
MD5 | c3fb6e14f1f56a657f40acfdc59323fd |
|
BLAKE2b-256 | 83bbccd2a1ab7795976858420ec0fd6ae6916fe29794b073daa86c372f3ef129 |
Hashes for zalando_kubectl-1.24.17.180-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9ee053a4a7ea652f29e1e6b553fa7245a510a50cdbed3279ce2aef0eb333792 |
|
MD5 | d86cf4504d3c48ead49851fbe97cd366 |
|
BLAKE2b-256 | 2addfd6660020890243a0e06211170f625290458e90cbf3a1ef400a66f97bd75 |