Client libraries

mkdir -p ~/armada-guide/python
cd ~/armada-guide/python
python3 -m venv .venv
source .venv/bin/activate
pip install armada-client

cat > hello_armada.py <<'EOF'
import time

import grpc
from armada_client.client import ArmadaClient
from armada_client.k8s.io.api.core.v1 import generated_pb2 as core_v1
from armada_client.k8s.io.apimachinery.pkg.api.resource import (
    generated_pb2 as api_resource,
)

# Laptop install: no login, no TLS. For a team installation, see Authentication.
client = ArmadaClient(grpc.insecure_channel("localhost:30002"))

resources = core_v1.ResourceRequirements(
    requests={
        "cpu": api_resource.Quantity(string="200m"),
        "memory": api_resource.Quantity(string="128Mi"),
    },
    limits={
        "cpu": api_resource.Quantity(string="200m"),
        "memory": api_resource.Quantity(string="128Mi"),
    },
)
pod_spec = core_v1.PodSpec(
    restartPolicy="Never",
    containers=[
        core_v1.Container(
            name="hello",
            image="alpine:3.21",
            args=["echo", "hello from Python"],
            resources=resources,
        )
    ],
)

# A new job set for each run, so the events below are this run's only.
job_set_id = f"python-demo-{int(time.time())}"

job = client.create_job_request_item(
    namespace="default", priority=0, pod_spec=pod_spec
)
response = client.submit_jobs(
    queue="my-team", job_set_id=job_set_id, job_request_items=[job]
)
for item in response.job_response_items:
    print("Submitted job", item.job_id)

# A new job set takes a few seconds to appear in the event stream.
time.sleep(5)

for event in client.get_job_events_stream(queue="my-team", job_set_id=job_set_id):
    kind = event.message.WhichOneof("events")
    print(kind)
    if kind in ("succeeded", "cancelled"):
        break
    # A retryable failure isn't final: the job runs again.
    if kind == "failed" and not event.message.failed.retryable:
        break
EOF

python hello_armada.py

Submitted job <job-id>
submitted
queued
leased
pending
succeeded

mkdir -p ~/armada-guide/go && cd ~/armada-guide/go
go mod init godemo
go get github.com/armadaproject/armada@latest

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/armadaproject/armada/pkg/api"
	"github.com/armadaproject/armada/pkg/client"
	"github.com/armadaproject/armada/pkg/client/domain"
	v1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/api/resource"
)

func main() {
	// Laptop install: no login, no TLS (plain text because the address contains "localhost").
	conn, err := client.CreateApiConnection(&client.ApiConnectionDetails{ArmadaUrl: "localhost:30002"})
	if err != nil {
		panic(err)
	}
	defer conn.Close()

	// A new job set for each run, so the events below are this run's only.
	jobSetId := fmt.Sprintf("go-demo-%d", time.Now().Unix())

	res := v1.ResourceList{
		v1.ResourceCPU:    resource.MustParse("200m"),
		v1.ResourceMemory: resource.MustParse("128Mi"),
	}
	resp, err := client.SubmitJobs(api.NewSubmitClient(conn), &api.JobSubmitRequest{
		Queue:    "my-team",
		JobSetId: jobSetId,
		JobRequestItems: []*api.JobSubmitRequestItem{{
			Namespace: "default",
			PodSpec: &v1.PodSpec{
				RestartPolicy: v1.RestartPolicyNever,
				Containers: []v1.Container{{
					Name:      "hello",
					Image:     "alpine:3.21",
					Args:      []string{"echo", "hello from Go"},
					Resources: v1.ResourceRequirements{Requests: res, Limits: res},
				}},
			},
		}},
	})
	if err != nil {
		panic(err)
	}
	fmt.Println("Submitted job", resp.JobResponseItems[0].JobId)

	time.Sleep(5 * time.Second) // a new job set takes a few seconds to appear
	client.WatchJobSet(api.NewEventClient(conn), "my-team", jobSetId, true, false, false, false, context.Background(),		func(state *domain.WatchContext, e api.Event) bool {
			fmt.Printf("%T\n", e)
			switch ev := e.(type) {
			case *api.JobSucceededEvent, *api.JobCancelledEvent:
				return true // stop watching
			case *api.JobFailedEvent:
				return !ev.Retryable // a retryable failure means the job runs again
			}
			return false
		})
}

go mod tidy
go run .

Submitted job <job-id>
*api.JobSubmittedEvent
*api.JobQueuedEvent
*api.JobLeasedEvent
*api.JobPendingEvent
*api.JobSucceededEvent

docker run --rm -v "$PWD":/src -v "$HOME/.m2":/root/.m2 -w /src/client/java \
  maven:3.9.9-eclipse-temurin-11 mvn -B clean package -DskipTests

go run github.com/magefile/mage@v1.17.2 BootstrapProto
docker run --rm -v "$PWD":/src -v "$HOME/.m2":/root/.m2 -w /src/client/scala/armada-scala-client \
  maven:3.9.9-eclipse-temurin-11 mvn -B package -DskipTests