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 <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.27.12.197.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1709c8850fb6c0544236431a3900378c1df995dc0b4b9b3816d85b98de64e83 |
|
MD5 | 4d4b1eea64865a59927fb33736f4835e |
|
BLAKE2b-256 | b57575b070120e7ca1b026e59cde79a2321e3f052b81d882981e2d28d4b5ec23 |
Hashes for zalando_kubectl-1.27.12.197-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f59def19815862b38b81e8c944721f6991559afe7936eb20c1e85043e2ed1ec9 |
|
MD5 | b60ee1013f4087ea3591053c4ca9323e |
|
BLAKE2b-256 | 489294b44d1622697418d43490c967e0eb0c8c4267afc7ed7e4d2974fa815068 |