Skip to main content

A Kubernetes API library

Project description

Test Codecov status Read the Docs PyPI PyPI - Python Version Kubernetes Version Support PyPI - Wheel PyPI - License

A simple, extensible Python client library for Kubernetes that feels familiar for folks who already know how to use kubectl.


  • API inspired by kubectl to 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 asyncio and trio.
  • Client caching to reduce passing API objects around.
  • Batteries included by providing useful utilities and methods inspired by kubectl.



$ pip install kr8s


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"):

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": "",}]


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")

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):

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")

# Is equivalent to
# node.patch({"spec": {"unschedulable": True}})

Project details

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 hashes)

Uploaded source

Built Distribution

kr8s-0.12.1-py3-none-any.whl (48.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page