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
kubectlfor a shallow learning curve. - Sensible defaults to reduce boiler plate.
- No swagger generated code, human readable code only.
- Has both a standard and an async 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
[!TIP] See the Examples Documentation for a full set of examples including
asyncioexamples.
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"})
Generate a Pod
Generate a simple Pod with a couple of keyword arguments.
from kr8s.objects import Pod
pod = Pod.gen(name="example-1", image="nginx:latest")
pod.create()
Cordon a Node
Cordon a Node to mark it as unschedulable.
from kr8s.objects import Node
node = Node("k8s-node-1")
node.cordon()
Pod Exec
Exec a command in a Pod.
from kr8s.objects import Pod
pod = Pod.get("my-pod")
command = pod.exec(["uptime"])
print(command.stdout.decode())
# 13:49:05 up 23:03, 0 users, load average: 0.66, 0.87, 0.85
Port forward a Pod
Open a port forward to a Pod as a background task/thread.
from kr8s.objects import Pod
pod = Pod.get("my-pod")
pf = pod.portforward(remote_port=1234, local_port=5678)
# Starts the port forward in a background thread
pf.start()
# Your other code goes here
# Optionally stop the port forward thread (it will exit with Python anyway)
pf.stop()
[!TIP] See the Examples Documentation for a full set of examples including
asyncioexamples.
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 kr8s-0.16.2.tar.gz.
File metadata
- Download URL: kr8s-0.16.2.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 04508cc6743f3b47910a09dad646f27ef8bc39f725fcd1f66c8f3885ea1d67b8 |
|
| MD5 | 1f040da07784ea868bceab309b4cf15b |
|
| BLAKE2b-256 | 905a958ff984a32f468d04a8ed6c3b7e800f4ca06db59cf71f84896d2b211a53 |
Provenance
File details
Details for the file kr8s-0.16.2-py3-none-any.whl.
File metadata
- Download URL: kr8s-0.16.2-py3-none-any.whl
- Upload date:
- Size: 64.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee8afa62519c7b74e63eb19ff21e66ac2b594cbf94846967aa3e5bfd29b7e718 |
|
| MD5 | 8e7125162777c199299e31033aab7ec1 |
|
| BLAKE2b-256 | 523a6db967e7653c5f6f62a9b8ddef3960e3062e39ebab58c16cfa4668baccd3 |
