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.2.tar.gz
(2.8 MB
view details)
Built Distribution
kr8s-0.12.2-py3-none-any.whl
(49.7 kB
view details)
File details
Details for the file kr8s-0.12.2.tar.gz.
File metadata
- Download URL: kr8s-0.12.2.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 | 8ad774c908f950e3e7201989fbd485d0530615c560842d603c7cd39fe4008aec |
|
| MD5 | 7a5cd0ab550d175f9a1ac826a77eb7c4 |
|
| BLAKE2b-256 | 1605dc13ad7b6bb6a51dc8ac24b8a0f07a5629a427a9d021b075840ff0e37bef |
Provenance
File details
Details for the file kr8s-0.12.2-py3-none-any.whl.
File metadata
- Download URL: kr8s-0.12.2-py3-none-any.whl
- Upload date:
- Size: 49.7 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 | 3e5e1c336fc74e54edda129493d5311fbf442db37621828c020c93933afa9f30 |
|
| MD5 | 90d4e89e3347fbd052218d577cac8f14 |
|
| BLAKE2b-256 | 5613b5ea1f8df1f3a35b24dd04fb8cc60681eb51121899faba9688256738bcf9 |
