Skip to main content

A Kubernetes API library

Project description

Test Codecov pre-commit.ci status Read the Docs EffVer Versioning PyPI Python Version Support 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.

Highlights

  • API inspired by kubectl for 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 asyncio and trio.
  • 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 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"})

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 asyncio examples.

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

kr8s-0.20.8.tar.gz (2.9 MB view details)

Uploaded Source

Built Distribution

kr8s-0.20.8-py3-none-any.whl (78.1 kB view details)

Uploaded Python 3

File details

Details for the file kr8s-0.20.8.tar.gz.

File metadata

  • Download URL: kr8s-0.20.8.tar.gz
  • Upload date:
  • Size: 2.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kr8s-0.20.8.tar.gz
Algorithm Hash digest
SHA256 0d5c708bf55985b076c48d9e82ecf211dde9cd71cf992f1c55602bed0119f39c
MD5 294f42825d6bebeb2f9f8b3218006511
BLAKE2b-256 5bf79b28088c13bd0304588550d4001cc67f7e006701ab44ab7eb15c7254e002

See more details on using hashes here.

Provenance

The following attestation bundles were made for kr8s-0.20.8.tar.gz:

Publisher: release.yaml on kr8s-org/kr8s

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kr8s-0.20.8-py3-none-any.whl.

File metadata

  • Download URL: kr8s-0.20.8-py3-none-any.whl
  • Upload date:
  • Size: 78.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kr8s-0.20.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4f9b829e5f3db02f6b9fa9db8914403b904e07703571807ebe0921a837c6a9c5
MD5 e76b0490e867b31f454a36500b2dde32
BLAKE2b-256 4a750ceeff57a9f26bdccba5abd4d1ee2addb8c3f960eb1683a7f56f4e8bae3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for kr8s-0.20.8-py3-none-any.whl:

Publisher: release.yaml on kr8s-org/kr8s

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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