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 kube-web-view dashboard in the browser:
$ zkubectl dashboard
Opening https://kube-web-view.zalando.net/ ..
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 into virtual test environment
$ cd <project-path>
# create new virtual environment if not yet
$ python -m venv test_environment
# enter virtual environment
$ source ./test_environment/bin/activate
# check pip is executed fron this virtual environment
(test_environment) $ which pip
<project-path>/test_environment/bin/pip
(test_environment) $ pip install -r requirements.txt
(test_environment) $ pip install --editable .
Now the code change will just be reflected in the zkubectl binary
(test_environment) $ zkubectl <whatever>
As an alternative for creating an environment you can run local changes from zalando_kubectl
$ cd <project-path>
$ python -m zalando_kubectl <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
Built Distribution
Hashes for zalando_kubectl-1.31.1.237.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e2defd7aa05bade454a766cb784e910bb4ebf4df4c1fe26bdca9980f408bc91 |
|
MD5 | 1f0c6a8c9b3cdd5b85c71fc2f918f412 |
|
BLAKE2b-256 | 386e39703db5c29613b1fa2a72dd8888e4c83e112bd9b51b9d65b68e00622d20 |
Hashes for zalando_kubectl-1.31.1.237-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 026aedc09b76dfc0f9870089f9d079c784695add80ca04383582c52c827ec9e8 |
|
MD5 | 100683ae1262a709788d55d1c9145456 |
|
BLAKE2b-256 | 44a1eb5158e92f54fa0b9388880859c2ccbe925593c142a1f505a34afea6e648 |