Batchsystem mit Kueue bereitstellen

In dieser Anleitung erfahren Sie, wie Sie verfügbare Ressourcen optimieren, indem Sie Jobs in der Google Kubernetes Engine (GKE) mit Kueue planen. In dieser Anleitung lernen Sie, wie Sie mit Kueue Batchjobs effektiv verwalten und planen, die Ressourcennutzung verbessern und die Arbeitslastverwaltung vereinfachen. Sie richten einen freigegebenen Cluster für zwei Mandantenteams ein, wobei jedes Team einen eigenen Namespace hat und Jobs erstellt, die globale Ressourcen gemeinsam nutzen. Außerdem konfigurieren Sie Kueue so, dass die Jobs anhand von Ressourcenkontingenten geplant werden, die Sie definieren.

Diese Anleitung richtet sich an Cloud-Architekten und Plattformtechniker, die ein Batchsystem mit GKE implementieren möchten. Weitere Informationen zu gängigen Rollen und Beispielaufgaben, auf die in Google Cloud Inhalten verwiesen wird, finden Sie unter Häufig verwendete GKE-Nutzerrollen und -Aufgaben.

Bevor Sie diese Seite lesen, sollten Sie mit den folgenden Themen vertraut sein:

Hintergrund

Jobs sind Anwendungen, die bis zum Abschluss ausgeführt werden, z. B. Machine-Learning-, Rendering-, Simulations-, Analyse-, CI/CD- und ähnliche Arbeitslasten.

Kueue ist ein cloudnativer Jobplaner, der mit dem Standard-Kubernetes-Planer, dem Jobcontroller und dem Cluster-Autoscaler zusammenarbeitet, um ein End-to-End-Batchsystem bereitzustellen. Kueue implementiert die Jobwarteschlangen und entscheidet anhand der Kontingente und einer Hierarchie für die faire Freigabe von Ressourcen, wann Jobs warten und wann sie gestartet werden sollen.

Kueue hat die folgenden Eigenschaften:

  • Es ist für Cloud-Architekturen optimiert, in denen Ressourcen heterogen, austauschbar und skalierbar sind.
  • Es bietet eine Reihe von APIs zum Verwalten von flexiblen Kontingenten und zum Verwalten von Jobwarteschlangen.
  • Es implementiert keine vorhandenen Funktionen wie Autoscaling, Pod-Planung oder Job-Lebenszyklusverwaltung neu.
  • Kueue bietet integrierte Unterstützung für die Kubernetes-API batch/v1.Job.
  • Es kann in andere Job-APIs eingebunden werden.

Kueue bezieht sich auf Jobs, die mit einer beliebigen API als Arbeitslasten definiert sind, um Verwechslungen mit der spezifischen Kubernetes-Job-API zu vermeiden.

Ziele

  1. GKE-Cluster erstellen
  2. ResourceFlavor erstellen
  3. ClusterQueue erstellen
  4. LocalQueue erstellen
  5. Jobs erstellen und zugelassene Arbeitslasten beobachten

Kosten

In dieser Anleitung werden die folgenden kostenpflichtigen Komponenten von Google Cloudverwendet:

Sie können mithilfe des Preisrechners eine Kostenschätzung für Ihre voraussichtliche Nutzung erstellen.

Nach Abschluss dieser Anleitung können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.

Vorbereitung

Projekt einrichten

  1. Melden Sie sich in Ihrem Google Cloud Konto an. Wenn Sie noch kein Konto bei Google Cloudhaben, erstellen Sie ein Konto, um die Leistung unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

  2. In the Google Cloud console, on the project selector page, click Create project to begin creating a new Google Cloud project.

    Roles required to create a project

    To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the GKE API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, click Create project to begin creating a new Google Cloud project.

    Roles required to create a project

    To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the GKE API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

    8.

Standardeinstellungen für die Google Cloud CLI festlegen

  1. Starten Sie in der Google Cloud Console eine Cloud Shell-Instanz:
    Cloud Shell öffnen

  2. Laden Sie den Quellcode für diese Beispielanwendung herunter:

    git clone https://github.com/GoogleCloudPlatform/kubernetes-engine-samples
cd kubernetes-engine-samples/batch/kueue-intro

  3. Legen Sie die Standardumgebungsvariablen fest:

    gcloud config set project PROJECT_ID
gcloud config set compute/region CONTROL_PLANE_LOCATION

    Ersetzen Sie die folgenden Werte:

    • PROJECT_ID: Ihre Google Cloud Projekt-ID.
    • CONTROL_PLANE_LOCATION: die Compute Engine Region der Steuerungsebene Ihres Clusters.

GKE-Cluster erstellen

  1. Erstellen Sie einen GKE Autopilot-Cluster mit dem Namen kueue-autopilot:

    gcloud container clusters create-auto kueue-autopilot \
  --release-channel "rapid" --location CONTROL_PLANE_LOCATION

    Autopilot-Cluster werden vollständig verwaltet und haben integriertes Autoscaling. Weitere Informationen zu GKE-Autopilot.

    Kueue unterstützt auch Standard-GKE mit automatischer Knotenbereitstellung und regulären automatisch skalierten Knotenpools.

    Das Ergebnis sieht nach der Erstellung des Clusters in etwa so aus:

      NAME: kueue-autopilot
  LOCATION: us-central1
  MASTER_VERSION: 1.26.2-gke.1000
  MASTER_IP: 35.193.173.228
  MACHINE_TYPE: e2-medium
  NODE_VERSION: 1.26.2-gke.1000
  NUM_NODES: 3
  STATUS: RUNNING

    Dabei ist STATUS gleich RUNNING für den kueue-autopilot.

  2. Authentifizierungsdaten für den Cluster abrufen:

    gcloud container clusters get-credentials kueue-autopilot

  3. Kueue im Cluster installieren:

    VERSION=VERSION
kubectl apply --server-side -f \
  https://github.com/kubernetes-sigs/kueue/releases/download/$VERSION/manifests.yaml

    Ersetzen Sie VERSION durch die neueste Version von Kueue. Weitere Informationen zu Kueue-Versionen finden Sie unter Kueue-Releases.

  4. Warten Sie, bis die Kueue-Pods bereit sind:

    watch kubectl -n kueue-system get pods

    Die Ausgabe sollte in etwa so aussehen, bevor Sie fortfahren können:

    NAME                                        READY   STATUS    RESTARTS   AGE
kueue-controller-manager-66d8bb946b-wr2l2   2/2     Running   0          3m36s

  5. Erstellen Sie zwei neue Namespaces mit den Namen team-a und team-b:

    kubectl create namespace team-a
kubectl create namespace team-b

ResourceFlavor erstellen

Ein ResourceFlavor ist ein Objekt, das die Variationen in den in Ihrem Cluster verfügbaren Knoten darstellt, indem es sie mit Knotenlabels und Markierungen verknüpft. Sie können mit ResourceFlavors beispielsweise VMs mit unterschiedlichen Garantien (z. B. Spot im Vergleich zu On-Demand), Architekturen (z. B. x86 im Vergleich zu ARM-CPUs), Marken und Modellen (z. B. Nvidia A100 im Vergleich zu T4-GPUs) darstellen.

In dieser Anleitung hat der Cluster kueue-autopilot homogene Ressourcen. Erstellen Sie daher ein einzelnes ResourceFlavor für CPU, Arbeitsspeicher, sitzungsspezifischen Speicher und GPUs ohne Labels oder Markierungen.

apiVersion: kueue.x-k8s.io/v1beta1
kind: ResourceFlavor
metadata:
  name: default-flavor # This ResourceFlavor will be used for all the resources
Stellen Sie das ResourceFlavor bereit:

kubectl apply -f flavors.yaml

ClusterQueue erstellen

Eine ClusterQueue ist ein clusterbezogenes Objekt, das einen Pool von Ressourcen wie CPU, Arbeitsspeicher und GPU verwaltet. Es verwaltet die ResourceFlavors, begrenzt die Nutzung und bestimmt die Reihenfolge, in der Arbeitslasten zugelassen werden.

apiVersion: kueue.x-k8s.io/v1beta1
kind: ClusterQueue
metadata:
  name: cluster-queue
spec:
  namespaceSelector: {} # Available to all namespaces
  queueingStrategy: BestEffortFIFO # Default queueing strategy
  resourceGroups:
  - coveredResources: ["cpu", "memory", "nvidia.com/gpu", "ephemeral-storage"]
    flavors:
    - name: "default-flavor"
      resources:
      - name: "cpu"
        nominalQuota: 10
      - name: "memory"
        nominalQuota: 10Gi
      - name: "nvidia.com/gpu"
        nominalQuota: 10
      - name: "ephemeral-storage"
        nominalQuota: 10Gi

ClusterQueue bereitstellen:

kubectl apply -f cluster-queue.yaml

Die Reihenfolge des Verbrauchs wird durch .spec.queueingStrategy bestimmt. Es gibt zwei Konfigurationen:

  • BestEffortFIFO

    • Die Standardkonfiguration der Warteschlangenstrategie.
    • Die Aufnahme von Arbeitslasten erfolgt nach der FIFO-Regel (first in first out). Wenn jedoch das Kontingent nicht ausreicht, um die Arbeitslast am Anfang der Warteschlange aufzunehmen, wird die nächste in der Reihe versucht.

  • StrictFIFO

    • Garantiert die FIFO-Semantik.
    • Die Arbeitslast am Anfang der Warteschlange kann die Warteschlange blockieren, bis die Arbeitslast zugelassen werden kann.

In cluster-queue.yaml erstellen Sie eine neue ClusterQueue mit dem Namen cluster-queue. Diese ClusterQueue verwaltet vier Ressourcen: cpu, memory, nvidia.com/gpu und ephemeral-storage mit dem in flavors.yaml erstellten Flavor. Das Kontingent wird durch die Anfragen in den Pod-Spezifikationen der Arbeitslast verbraucht.

Jedes Flavor enthält Nutzungslimits, die als .spec.resourceGroups[].flavors[].resources[].nominalQuota dargestellt werden. In diesem Fall lässt die ClusterQueue Arbeitslasten nur zu, wenn:

  • Die Summe der CPU-Anfragen ist kleiner oder gleich 10.
  • Die Summe der Speicheranfragen ist kleiner oder gleich 10 Gi.
  • Die Summe der GPU-Anfragen ist kleiner oder gleich 10.
  • Die Summe des verwendeten Speichers ist kleiner oder gleich 10 Gi.

LocalQueue erstellen

Eine LocalQueue ist ein Namespace-Objekt, das Arbeitslasten von Nutzern im Namespace akzeptiert. LocalQueues aus verschiedenen Namespaces können auf dieselbe ClusterQueue verweisen, in der sie das Kontingent der Ressourcen gemeinsam nutzen können. In diesem Fall verweist die LocalQueue aus dem Namespace team-a und team-b unter .spec.clusterQueue auf dieselbe ClusterQueue cluster-queue.

apiVersion: kueue.x-k8s.io/v1beta1
kind: LocalQueue
metadata:
  namespace: team-a # LocalQueue under team-a namespace
  name: lq-team-a
spec:
  clusterQueue: cluster-queue # Point to the ClusterQueue
---
apiVersion: kueue.x-k8s.io/v1beta1
kind: LocalQueue
metadata:
  namespace: team-b # LocalQueue under team-b namespace
  name: lq-team-b
spec:
  clusterQueue: cluster-queue # Point to the ClusterQueue

Jedes Team sendet seine Arbeitslasten an die LocalQueue im eigenen Namespace. Diesen werden dann von der ClusterQueue Ressourcen zugewiesen.

LocalQueues bereitstellen:

kubectl apply -f local-queue.yaml

Jobs erstellen und zugelassene Arbeitslasten beobachten

In diesem Abschnitt erstellen Sie Kubernetes-Jobs im Namespace team-a. Ein Jobcontroller in Kubernetes erstellt einen oder mehrere Pods und sorgt dafür, dass sie eine bestimmte Aufgabe erfolgreich ausführen.

Der Job im Namespace team-a hat die folgenden Attribute:

  • Er verweist auf die LocalQueue lq-team-a.
  • Er fordert GPU-Ressourcen an, indem das Feld nodeSelector auf nvidia-tesla-t4 gesetzt wird.
  • Er besteht aus drei Pods, die parallel zehn Sekunden lang in den Ruhemodus wechseln. Jobs werden entsprechend dem im Feld ttlSecondsAfterFinished definierten Wert nach 60 Sekunden bereinigt.
  • Für diesen Job sind 1.500 MilliCPU, 1.536 Mi Arbeitsspeicher, 1.536 Mi sitzungsspezifischer Speicher und drei GPUs erforderlich, da es drei Pods gibt.
apiVersion: batch/v1
kind: Job
metadata:
  namespace: team-a # Job under team-a namespace
  generateName: sample-job-team-a-
  labels:
    kueue.x-k8s.io/queue-name: lq-team-a # Point to the LocalQueue
spec:
  ttlSecondsAfterFinished: 60 # Job will be deleted after 60 seconds
  parallelism: 3 # This Job will have 3 replicas running at the same time
  completions: 3 # This Job requires 3 completions
  suspend: true # Set to true to allow Kueue to control the Job when it starts
  template:
    spec:
      nodeSelector:
        cloud.google.com/gke-accelerator: "nvidia-tesla-t4" # Specify the GPU hardware
      containers:
      - name: dummy-job
        image: gcr.io/k8s-staging-perf-tests/sleep:latest
        args: ["10s"] # Sleep for 10 seconds
        resources:
          requests:
            cpu: "500m"
            memory: "512Mi"
            ephemeral-storage: "512Mi"
            nvidia.com/gpu: "1"
          limits:
            cpu: "500m"
            memory: "512Mi"
            ephemeral-storage: "512Mi"
            nvidia.com/gpu: "1"
      restartPolicy: Never

Jobs werden auch unter der Datei job-team-b.yaml erstellt, deren Namespace zu team-b gehört, mit Anfragen, die verschiedene Teams mit unterschiedlichen Bedürfnissen repräsentieren.

Weitere Informationen finden Sie unter GPU-Arbeitslasten in Autopilot bereitstellen.

  1. Beobachten Sie in einem neuen Terminal den Status der ClusterQueue, der alle zwei Sekunden aktualisiert wird:

    watch -n 2 kubectl get clusterqueue cluster-queue -o wide

  2. Beobachten Sie in einem neuen Terminal den Status der Knoten:

    watch -n 2 kubectl get nodes -o wide

  3. Erstellen Sie in einem neuen Terminal alle 10 Sekunden Jobs für die LocalQueue aus dem Namespace team-a und team-b:

    ./create_jobs.sh job-team-a.yaml job-team-b.yaml 10

  4. Beobachten Sie, wie Jobs in die Warteschlange gestellt und in der ClusterQueue zugelassen werden und wie Knoten mit GKE Autopilot erstellt werden.

  5. Rufen Sie einen Job aus dem Namespace team-a ab:

    kubectl -n team-a get jobs

    Die Ausgabe sieht in etwa so aus:

    NAME                      COMPLETIONS   DURATION   AGE
sample-job-team-b-t6jnr   3/3           21s        3m27s
sample-job-team-a-tm7kc   0/3                      2m27s
sample-job-team-a-vjtnw   3/3           30s        3m50s
sample-job-team-b-vn6rp   0/3                      40s
sample-job-team-a-z86h2   0/3                      2m15s
sample-job-team-b-zfwj8   0/3                      28s
sample-job-team-a-zjkbj   0/3                      4s
sample-job-team-a-zzvjg   3/3           83s        4m50s

  6. Kopieren Sie einen Jobnamen aus dem vorherigen Schritt und beobachten Sie den Zulassungsstatus und die Ereignisse für den Job.

    kubectl -n team-a describe job JOB_NAME

  7. Wenn die ausstehenden Jobs von der ClusterQueue-Ressource zunehmen, beenden Sie das Script, indem Sie im ausgeführten Script CTRL + C drücken.

  8. Sobald alle Jobs abgeschlossen sind, werden die Knoten herunterskaliert.

Bereinigen

Damit Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen nicht in Rechnung gestellt werden, löschen Sie entweder das Projekt, das die Ressourcen enthält, oder Sie behalten das Projekt und löschen die einzelnen Ressourcen.

Projekt löschen

  1. Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten.

    Zur Seite „Ressourcen verwalten“

  2. Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie auf Löschen.
  3. Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie auf Shut down (Beenden), um das Projekt zu löschen.

Einzelne Ressource löschen

  1. Das Kueue-Kontingentsystem löschen:

    kubectl delete -n team-a localqueue lq-team-a
kubectl delete -n team-b localqueue lq-team-b
kubectl delete clusterqueue cluster-queue
kubectl delete resourceflavor default-flavor

  2. Das Kueue-Manifest löschen:

    VERSION=VERSION
kubectl delete -f \
  https://github.com/kubernetes-sigs/kueue/releases/download/$VERSION/manifests.yaml

  3. Löschen Sie den Cluster:

    gcloud container clusters delete kueue-autopilot --location=CONTROL_PLANE_LOCATION

Nächste Schritte