A Kubernetes API library
Project description
A simple, extensible Python client library for Kubernetes that feels familiar for folks who already know how to use kubectl.
Highlights
- API inspired by
kubectlto reduce developer learning curve. - Sensible defaults to reduce boiler plate.
- No swagger generated code, human readable code only.
- Also has an asynchronous API that can be used with
asyncioandtrio. - Client caching to reduce passing API objects around.
- Batteries included by providing useful utilities and methods inspired by
kubectl.
Quickstart
Installation
$ pip install kr8s
Examples
See the Examples Documentation for a full set of examples including asyncio examples.
List Nodes
Print out all of the node names in the cluster.
import kr8s
for node in kr8s.get("nodes"):
print(node.name)
Create a Pod
Create a new Pod.
from kr8s.objects import Pod
pod = Pod({
"apiVersion": "v1",
"kind": "Pod",
"metadata": {
"name": "my-pod",
},
"spec": {
"containers": [{"name": "pause", "image": "gcr.io/google_containers/pause",}]
},
})
pod.create()
Scale a Deployment
Scale the Deployment metrics-server in the Namespace kube-system to 1 replica.
from kr8s.objects import Deployment
deploy = Deployment.get("metrics-server", namespace="kube-system")
deploy.scale(1)
List Pods by label selector
Get all Pods from all Namespaces matching a label selector.
import kr8s
selector = {'component': 'kube-scheduler'}
for pod in kr8s.get("pods", namespace=kr8s.ALL, label_selector=selector):
print(pod.namespace, pod.name)
Add a label to a Pod
Add the label foo with the value bar to an existing Pod.
from kr8s.objects import Pod
pod = Pod("kube-apiserver", namespace="kube-system")
pod.label({"foo": "bar"})
Cordon a Node
Cordon a Node to mark it as unschedulable.
from kr8s.objects import Node
node = Node("k8s-node-1")
node.cordon()
# Is equivalent to
# node.patch({"spec": {"unschedulable": True}})
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
kr8s-0.12.1.tar.gz
(2.8 MB
view details)
Built Distribution
kr8s-0.12.1-py3-none-any.whl
(48.1 kB
view details)
File details
Details for the file kr8s-0.12.1.tar.gz.
File metadata
- Download URL: kr8s-0.12.1.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 85d3ab84574fca901f87f9d186a8c4b2c62b1925a6b517bbb26e039ac242af9b |
|
| MD5 | 98d0b7e8745e0ee62693b2f4b0131cf4 |
|
| BLAKE2b-256 | aabc14e003a7bb63b6cbe8e6d9f76dde91277eece2a906974db63c4fc1b3f37b |
Provenance
File details
Details for the file kr8s-0.12.1-py3-none-any.whl.
File metadata
- Download URL: kr8s-0.12.1-py3-none-any.whl
- Upload date:
- Size: 48.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 38fb39a3e3826e2bf54ba603898fbc1d27bf0e3d990c025548c7419173430ac0 |
|
| MD5 | bfcf376f0c5cead8354807ffb5b2e1a1 |
|
| BLAKE2b-256 | a8bbe339f9f4fc6617f655d35ee3c2f31c6ee743a5d6b3dbf199ca6b1c019bb7 |
