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.23.17.165.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | edef94f00ec71427b49b29e5ad4287f84b90dde20f55dbbbfa880fb08539cf17 |
|
MD5 | c2353b0295099ffd0df190958b3cfdb5 |
|
BLAKE2b-256 | dda7ca6cbb992690d2df551bec060efa0ef01b8a6942d458e27904656b8a4c15 |
Hashes for zalando_kubectl-1.23.17.165-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb7a451d583080517fe7eb83201cf59dc54a9ba25f244473fa9102d3076b4a1e |
|
MD5 | 1ce44ae917f4821068f0ad1d52bebccf |
|
BLAKE2b-256 | 217db9d34c85b232d9e7abbe0736787a7517098dbf82ef81e42616ddcdde0b4d |