Creating Resources

Create a Pod

Create a new Pod.

Sync

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

Async

from kr8s.asyncio.objects import Pod

pod = await Pod({
        "apiVersion": "v1",
        "kind": "Pod",
        "metadata": {
            "name": "my-pod",
        },
        "spec": {
            "containers": [{"name": "pause", "image": "gcr.io/google_containers/pause",}]
        },
    })

await pod.create()

Create a Pod and wait for it to be ready

Create a new Pod and wait for it to be ready. There are two common patterns for implementing this.

Sync

from kr8s.objects import Pod

pod = Pod(...)
pod.create()

# Option 1: Block until ready, similar to kubectl wait
pod.wait("condition=Ready")

# Option 2: Poll readiness
import time
while not pod.ready():
    time.sleep(1)

Async

from kr8s.asyncio.objects import Pod

pod = await Pod(...)
await pod.create()

# Option 1: Block until ready, similar to kubectl wait
await pod.wait("condition=Ready")

# Option 2: Poll readiness
import asyncio
while not await pod.ready():
    await asyncio.sleep(1)

Create a Job and wait for it to either succeed or fail

Create a new Job and wait for it to either succeed or fail with Job.wait().

Sync

from kr8s.objects import Job

job = Job(...)
job.create()

job.wait(["condition=Complete", "condition=Failed"])

Async

from kr8s.asyncio.objects import Jod

job = await Job(...)
await job.create()

await job.wait(["condition=Complete", "condition=Failed"])

Create a Secret

Create a Secret with several keys.

Sync

from base64 import b64encode
from kr8s.objects import Secret

secret = Secret({
        "apiVersion": "v1",
        "kind": "Secret",
        "metadata": {
            "name": "mysecret",
        },
        "type": "Opaque",
        "data": {
            "password": b64encode("s33msi4".encode()).decode(),
            "username": b64encode("jane".encode()).decode(),
        },
    })

secret.create()

Async

from base64 import b64encode
from kr8s.asyncio.objects import Secret

secret = await Secret({
        "apiVersion": "v1",
        "kind": "Secret",
        "metadata": {
            "name": "mysecret",
        },
        "type": "Opaque",
        "data": {
            "password": b64encode("s33msi4".encode()).decode(),
            "username": b64encode("jane".encode()).decode(),
        },
    })

await secret.create()

Validate a Pod

Validate the schema of a Pod before creating it.

Hint

kr8s does not perform client-side validation of object schemas, instead it behaves like kubectl and relies on server-side validation. However, if you have the kubernetes-validate>=1.28.1 package installed you can easily check it yourself.

Sync

import kubernetes_validate
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",}]
        },
    })

kubernetes_validate.validate(pod, "1.28")
pod.create()

Async

import kubernetes_validate
from kr8s.asyncio.objects import Pod

pod = await Pod({
        "apiVersion": "v1",
        "kind": "Pod",
        "metadata": {
            "name": "my-pod",
        },
        "spec": {
            "containers": [{"name": "pause", "image": "gcr.io/google_containers/pause",}]
        },
    })

kubernetes_validate.validate(pod, "1.28")
await pod.create()

Create objects from a YAML file

Open a YAML file containing some resources and create them.

Let’s start with a YAML file containing a simple nginx Pod and Service.

# manifest.yaml
apiVersion: v1
kind: Pod
metadata:
  name: nginx
  labels:
    app.kubernetes.io/name: proxy
spec:
  containers:
  - name: nginx
    image: nginx:stable
    ports:
      - containerPort: 80
        name: http-web-svc

---
apiVersion: v1
kind: Service
metadata:
  name: nginx-service
spec:
  selector:
    app.kubernetes.io/name: proxy
  ports:
  - name: name-of-service-port
    protocol: TCP
    port: 80
    targetPort: http-web-svc

Then with kr8s we can load this file and create an object for each resource. Then use objetc methods to create them.

Sync

from kr8s.objects import objects_from_files

resources = objects_from_files("manifest.yaml")

for resource in resources:
    resource.create()

Async

from kr8s.asyncio.objects import objects_from_files

resources = await objects_from_files("manifest.yaml")

for resource in resources:
    await resource.create()