Zum Inhalt springen
Trainingslager IT-Trainingslager

Anhang B: Abschlussprüfung

Ziel: Ohne Anleitung zeigen, dass du Infrastruktur mit OpenTofu im Team betreiben kannst: eine neue Umgebung, eine neue Modulversion mit Test, ein Import, ein Secret ohne State und eine eigene Policy. · Dauer: ca. 90 min · Voraussetzung: Tag 15

Spielregeln

  • Jede Übung beschreibt nur das Ziel. Den Weg findest du selbst; die Tage in Klammern helfen beim Nachschlagen.
  • Jede Übung endet mit einem Prüfblock: einzelne Befehle mit dem, was sie zeigen müssen. Erst wenn alle stimmen, gilt die Übung.
  • Alles entsteht unter ~/tf-lab/anhb, der State liegt im S3-Speicher unter anhb/….
source ~/tf-lab/setup/env.sh
mkdir -p ~/tf-lab/anhb && cd ~/tf-lab/anhb

Übung 1: Eine Umgebung staging

Leg in ~/tf-lab/anhb/staging eine Umgebung an: Modul notes-docker in Version v1.2.0, Name stg, Port 8095, eine Instanz a. Der State liegt unter dem Schlüssel anhb/staging.tfstate. (Tag 5, Tag 9, Tag 10)

Prüfblock:

curl -s -o /dev/null -w '%{http_code}\n' http://127.0.0.1:8095/healthz

Erwartet:

200
s3ls 'tofu-state?list-type=2' | grep -o '<Key>anhb[^<]*</Key>'

Erwartet:

<Key>anhb/staging.tfstate</Key>

Lösung

mkdir -p ~/tf-lab/anhb/staging && cd ~/tf-lab/anhb/staging
sed 's|tag05/terraform.tfstate|anhb/staging.tfstate|' ~/tf-lab/tag05/backend.tf \
  > backend.tf
cp ~/tf-lab/tag05/versions.tf .
cat > main.tf <<'EOF'
provider "docker" {}

module "notes" {
  source      = "git::file:///home/ubuntu/tf-lab/module//notes-docker?ref=v1.2.0"
  name        = "stg"
  port        = 8095
  instanzen   = ["a"]
  db_passwort = "lab-db-pw-123"
}
EOF
tofu init -no-color >/dev/null
tofu apply -auto-approve -no-color | tail -1

Erwartet:

Apply complete! Resources: 9 added, 0 changed, 0 destroyed.

Fortschritt speichern? Kostenlos registrieren

Übung 2: Modulversion v1.3.0

Das Modul bekommt einen Ausgang proxy mit dem Namen des Proxy-Containers und einen Plan-Test dafür. Veröffentliche es als v1.3.0 und stelle staging darauf um. staging gibt den Wert als eigenen Ausgang proxy aus. (Tag 5, Tag 13)

Prüfblock:

git -C ~/tf-lab/module tag --points-at HEAD

Erwartet:

v1.3.0
cd ~/tf-lab/anhb/staging && tofu output -raw proxy; echo

Erwartet:

stg-proxy
cd ~/tf-lab/module/notes-docker && tofu test -no-color -filter=tests/plan.tftest.hcl \
  | tail -1

Erwartet (4 statt 5, wenn du die Challenge aus Tag 13 nicht gemacht hast):

Success! 5 passed, 0 failed.

Lösung

cd ~/tf-lab/module/notes-docker
cat >> outputs.tf <<'EOF'

output "proxy" {
  description = "Name des Proxy-Containers"
  value       = docker_container.proxy.name
}
EOF
cat >> tests/plan.tftest.hcl <<'EOF'

run "proxy_name" {
  command = plan

  assert {
    condition     = output.proxy == "test-proxy"
    error_message = "Ausgang proxy stimmt nicht."
  }
}
EOF
tofu test -no-color -filter=tests/plan.tftest.hcl | tail -1
cd .. && git add -A
git -c user.name=Lab -c [email protected] commit -qm "Ausgang proxy"
git tag v1.3.0
cd ~/tf-lab/anhb/staging
sed -i 's/ref=v1.2.0/ref=v1.3.0/' main.tf
cat > outputs.tf <<'EOF'
output "proxy" {
  value = module.notes.proxy
}
EOF
tofu init -no-color >/dev/null
tofu apply -auto-approve -no-color | grep 'Apply complete'

Erwartet:

Success! 5 passed, 0 failed.
Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

Neue Modulversion, kein Umbau: Der Ausgang ändert keine Ressource.

Fortschritt speichern? Kostenlos registrieren

Übung 3: Das Archiv-Volume

Jemand hat von Hand ein Volume stg-archiv angelegt. Übernimm es in staging als Ressource docker_volume.archiv – mit einem import-Block. (Tag 11)

Spielleitung:

docker volume create stg-archiv

Erwartet:

stg-archiv

Prüfblock:

cd ~/tf-lab/anhb/staging && tofu state list | grep archiv

Erwartet:

docker_volume.archiv
tofu plan -no-color | tail -1

Erwartet:

No changes. Your infrastructure matches the configuration.

Lösung

cd ~/tf-lab/anhb/staging
cat > archiv.tf <<'EOF'
import {
  to = docker_volume.archiv
  id = "stg-archiv"
}

resource "docker_volume" "archiv" {
  name = "stg-archiv"
}
EOF
tofu apply -auto-approve -no-color | grep 'Apply complete'

Erwartet:

Apply complete! Resources: 1 imported, 0 added, 0 changed, 0 destroyed.

Fortschritt speichern? Kostenlos registrieren

Übung 4: Ein Secret ohne State

staging bekommt ein Kubernetes-Secret stg-api im Namespace anhb mit einem zufälligen Passwort aus 32 Zeichen unter dem Schlüssel password. Das Passwort darf nicht im State stehen. (Tag 6, Tag 12)

Prüfblock:

PW=$(kubectl -n anhb get secret stg-api -o jsonpath='{.data.password}' | base64 -d)
echo "${#PW}"

Erwartet:

32
cd ~/tf-lab/anhb/staging && tofu state pull | grep -c "$PW"

Erwartet:

0

Lösung

cd ~/tf-lab/anhb/staging
cat > versions.tf <<'EOF'
terraform {
  required_version = ">= 1.13.0"
  required_providers {
    docker     = { source = "kreuzwerker/docker", version = "~> 4.6" }
    kubernetes = { source = "hashicorp/kubernetes", version = "~> 3.4" }
    random     = { source = "hashicorp/random", version = "~> 3.9" }
  }
}
EOF
cat > k8s.tf <<'EOF'
provider "kubernetes" {
  config_path = "/etc/rancher/k3s/k3s.yaml"
}

resource "kubernetes_namespace_v1" "anhb" {
  metadata {
    name = "anhb"
  }
}

ephemeral "random_password" "api" {
  length  = 32
  special = false
}

resource "kubernetes_secret_v1" "api" {
  metadata {
    name      = "stg-api"
    namespace = kubernetes_namespace_v1.anhb.metadata[0].name
  }
  data_wo = {
    password = ephemeral.random_password.api.result
  }
  data_wo_revision = 1
}
EOF
tofu init -no-color >/dev/null
tofu apply -auto-approve -no-color | grep 'Apply complete'

Erwartet:

Apply complete! Resources: 2 added, 0 changed, 0 destroyed.

required_providers darf es je Verzeichnis nur einmal geben. Darum kommen alle drei Provider in versions.tf.

Fortschritt speichern? Kostenlos registrieren

Übung 5: Eine eigene Policy

Ergänze ~/tf-lab/policy/plan.rego um eine Regel: Docker-Container dürfen Ports nur im Bereich 8000–8999 veröffentlichen. Prüfe sie gegen einen Plan von staging, in dem der Port auf 9095 steht. (Tag 13)

Prüfblock:

cd ~/tf-lab/anhb/staging && conftest test -p ~/tf-lab/policy neu.json --no-color \
  | grep -o 'Port 9095 nicht in.*'

Erwartet:

Port 9095 nicht in 8000–8999
grep -c '8095' main.tf

Erwartet: Der Port im Code ist wieder 8095.

1

Lösung

cat >> ~/tf-lab/policy/plan.rego <<'EOF'

deny contains msg if {
    some rc in input.resource_changes
    rc.type == "docker_container"
    some p in rc.change.after.ports
    not p.external >= 8000
    msg := sprintf("%s: Port %d nicht in 8000–8999", [rc.address, p.external])
}

deny contains msg if {
    some rc in input.resource_changes
    rc.type == "docker_container"
    some p in rc.change.after.ports
    p.external > 8999
    msg := sprintf("%s: Port %d nicht in 8000–8999", [rc.address, p.external])
}
EOF
conftest fmt --check ~/tf-lab/policy && echo "Rego formatiert"
cd ~/tf-lab/anhb/staging
sed -i 's/port        = 8095/port        = 9095/' main.tf
tofu plan -no-color -out=neu.plan >/dev/null
tofu show -json neu.plan > neu.json
sed -i 's/port        = 9095/port        = 8095/' main.tf
rm neu.plan

Erwartet:

Rego formatiert

Zwei Regeln, weil eine Regel in Rego nur zutrifft, wenn alle Bedingungen gelten – „kleiner als 8000 oder größer als 8999“ sind darum zwei Regeln. Lösche neu.json nach dem Prüfblock: Sie enthält das Datenbank-Passwort im Klartext.

Fortschritt speichern? Kostenlos registrieren

Aufräumen

cd ~/tf-lab/anhb/staging
rm -f neu.json
tofu destroy -auto-approve -no-color | tail -1
docker volume ls -q --filter name=stg- | wc -l

Erwartet:

Destroy complete! Resources: 12 destroyed.
0

Das Archiv-Volume ist mit weg: Nach dem Import gehört es OpenTofu, also baut destroy es ab.

Wissenstest

  1. Was steht in der Lock-Datei .terraform.lock.hcl, und warum gehört sie ins Git?
  2. Wann ändert OpenTofu eine Ressource an Ort und Stelle, und wann ersetzt es sie?
  3. Warum ist for_each für Instanzen meist besser als count?
  4. Was passiert mit einer Ressource, wenn du sie im Code umbenennst – und wie verhinderst du es?
  5. Was schützt sensitive = true, und was nicht?
  6. Wozu dient use_lockfile = true im S3-Backend?
  7. Workspaces oder ein Verzeichnis je Umgebung: Was spricht für Verzeichnisse bei dev/prod?
  8. Warum ist ein import-Block im Team besser als tofu import?
  9. Was bedeutet Exit-Code 2 bei tofu plan -detailed-exitcode?
  10. Warum soll eine CI-Pipeline den Plan aus dem PR anwenden statt neu zu planen?

Antworten

  1. Die genauen Provider-Versionen und ihre Prüfsummen. Im Git sorgt sie dafür, dass alle – und die CI – dieselben Provider benutzen (Tag 1).
  2. Ändern, wenn der Provider das Attribut im laufenden Objekt anpassen kann; ersetzen, wenn es nur beim Anlegen gesetzt werden kann. Der Plan zeigt es mit # forces replacement (Tag 1).
  3. Instanzen hängen an Namen statt an Positionen. Fällt eine weg, bleiben die anderen unberührt; bei count rutschen die Indizes nach (Tag 4).
  4. OpenTofu plant Löschen und Neuanlegen. Ein moved-Block sagt, dass es dieselbe Ressource ist (Tag 11, 15).
  5. Die Ausgabe in Plan und Log. Im State steht der Wert weiter im Klartext (Tag 12).
  6. Eine Sperrdatei im Bucket verhindert, dass zwei Läufe gleichzeitig den State schreiben (Tag 9).
  7. Jeder Unterschied steht sichtbar im Code, jede Umgebung hat eigene Werte, eigenen State und eigene Rechte. Bei Workspaces entscheidet ein unsichtbarer Zustand (Tag 10).
  8. Er läuft durch Review und Plan; tofu import ändert den State sofort (Tag 11).
  9. Der Plan enthält Änderungen – bei einer Drift-Prüfung also: Drift (Tag 14).
  10. Nur so wird genau das umgesetzt, was im Review geprüft wurde. Hat sich etwas geändert, lehnt OpenTofu den alten Plan ab (Tag 14).

Wie geht es weiter?

  • Kubernetes zum Anfassen: was hinter den Ressourcen aus Tag 6 und 7 steckt.
  • Keycloak zum Anfassen: der Identity-Provider aus Tag 8 von innen.
  • GitHub Actions zum Anfassen: dieselbe Pipeline wie in Tag 14 auf GitHub.
  • In die Cloud: Die Provider für AWS, Azure und Google funktionieren genauso wie der Docker-Provider – mit Zugangsdaten statt Socket. Fang mit einem Bucket und einem Netzwerk an, nicht mit einem Cluster.