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
File details
Details for the file zalando-kubectl-1.26.14.190.tar.gz
.
File metadata
- Download URL: zalando-kubectl-1.26.14.190.tar.gz
- Upload date:
- Size: 51.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | df264f582b9ad1b1773838dca82f1d8e024be125c1cca80230fb1ea1d060b47b |
|
MD5 | 6262f27cbac05b20292c01127ff39f71 |
|
BLAKE2b-256 | 77deea3b2614c9710c9794228f441a5c0f6c9c3271f114db4e63477abe5014ae |
Provenance
File details
Details for the file zalando_kubectl-1.26.14.190-py3-none-any.whl
.
File metadata
- Download URL: zalando_kubectl-1.26.14.190-py3-none-any.whl
- Upload date:
- Size: 53.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c560cd36ea34b8848fe4de112a6e7ab81e5d465b88ae1e5869cfc7de3addcc0 |
|
MD5 | 7710d0b0050dc038465bfc6f6deeb296 |
|
BLAKE2b-256 | ade687d568bfedacab9a64feb8c067c6c5428030c9bb1a9e30dc4739b1459ae5 |