Zum Inhalt springen
Trainingslager IT-Trainingslager

Tag 12: Image Updater und Notifications

Ziel: Ein neues Image von notes-api landet ohne Handarbeit als Commit im Fleet-Repo. Nach jedem Deployment schickt Argo CD eine Nachricht an einen Webhook. · Dauer: ca. 50 min · Voraussetzung: Tag 8

Briefing

  • Bisher änderst du den Image-Tag von Hand in Git. Der Argo CD Image Updater fragt die Registry regelmäßig nach neuen Tags und trägt den passenden selbst ein.
  • Seit Version 1.0 steht die Konfiguration in einem eigenen Objekt ImageUpdater, nicht mehr in Annotationen an der Application.
  • Für das Zurückschreiben gibt es zwei Wege: argocd ändert die Application im Cluster, git macht einen Commit ins Fleet-Repo. Nur der zweite ist GitOps.
  • Die Notifications gehören zu Argo CD und laufen seit Tag 1 als argocd-notifications-controller. Ein Trigger sagt, wann etwas passiert, ein Template, was verschickt wird, ein Service, wohin.
  • Eine Application abonniert einen Trigger mit einer Annotation.
 ghcr.io ──Tags──► Image Updater ──git push──► Fleet-Repo ──► Argo CD ──sync──► notes
                                                                │
                                                                └─ Notification ─► echo

Drill 1: Den Image Updater installieren

mkdir -p ~/argo-lab/tag12
cd ~/argo-lab/tag12
IU_URL=https://raw.githubusercontent.com/argoproj-labs/argocd-image-updater
curl -sLO $IU_URL/v1.5.0/config/install.yaml
kubectl apply -n argocd -f install.yaml
kubectl -n argocd rollout status deploy argocd-image-updater-controller --timeout 120s

Erwartet (gekürzt):

customresourcedefinition.apiextensions.k8s.io/imageupdaters.argocd-image-updater.argoproj.io created
serviceaccount/argocd-image-updater-controller created
…
deployment.apps/argocd-image-updater-controller created
…
deployment "argocd-image-updater-controller" successfully rolled out

Der Controller läuft im Namespace argocd und sieht nur Objekte dort. Das ist richtig so, denn dort liegen auch die Applications.

Welche Tags hat notes-api? Die Registry ghcr.io gibt sie ohne Anmeldung heraus. Du brauchst nur ein anonymes Token:

TOKEN=$(curl -s "https://ghcr.io/token?scope=repository:thomaszachmann/notes-api:pull" \
  | python3 -c 'import sys,json; print(json.load(sys.stdin)["token"])')
curl -s -H "Authorization: Bearer $TOKEN" \
  "https://ghcr.io/v2/thomaszachmann/notes-api/tags/list?n=1000" \
  | python3 -c 'import sys,json; print([t for t in json.load(sys.stdin)["tags"]
    if t[0]=="0"])'

Erwartet:

['0.5.1', '0.5', '0.6.0-rc.1', '0.5.2', '0.5.3', '0.6.0-rc.2', '0.6.0-rc.3', '0.6.0-rc.4', '0.7.0', '0.7', '0.7.1']

Die Produktion notes läuft mit 0.5.3, notes-dev seit Tag 6 mit 0.7.1. Die Reihe 0.7 ist freigegeben, also soll auch die Produktion jeden Patch daraus bekommen.

Fortschritt speichern? Kostenlos registrieren

Drill 2: Zurückschreiben in die Application

Zuerst ein Versuch mit der Standardmethode argocd. Die Datei kommt bewusst nicht ins Repo:

cat > notes-updater.yaml <<'EOF'
apiVersion: argocd-image-updater.argoproj.io/v1alpha1
kind: ImageUpdater
metadata:
  name: notes
  namespace: argocd
spec:
  applicationRefs:
    - namePattern: notes
      images:
        - alias: api
          imageName: ghcr.io/thomaszachmann/notes-api:~0.7
EOF
kubectl apply -f notes-updater.yaml
  • namePattern wählt Applications über ihren Namen, hier genau notes.
  • ~0.7 ist eine Versionsbedingung: alles ab 0.7.0 und unter 0.8.0. Die Release-Kandidaten 0.6.0-rc.* fallen ohnehin heraus.
  • alias ist ein frei wählbarer Name für das Image innerhalb des ImageUpdater.

Der Controller prüft alle zwei Minuten. Du wartest zwei Durchläufe ab:

sleep 180
kubectl -n argocd logs deploy/argocd-image-updater-controller \
  | grep -E "Setting new image" | cut -c1-110
kubectl -n argocd get app notes -o jsonpath='{.spec.source.kustomize}'
echo
kubectl -n notes get deploy notes \
  -o jsonpath='{.spec.template.spec.containers[0].image}'
echo

Erwartet:

time="2026-11-15T07:44:31Z" level=info msg="Setting new image to ghcr.io/thomaszachmann/notes-api:0.7.1"
time="2026-11-15T07:46:32Z" level=info msg="Setting new image to ghcr.io/thomaszachmann/notes-api:0.7.1"

ghcr.io/thomaszachmann/notes-api:0.5.3

Ausprobiert: Der Image Updater setzt alle zwei Minuten 0.7.1, und kurz darauf steht wieder 0.5.3 da. Die Methode argocd schreibt das Image in die Application. Die gehört aber dem ApplicationSet aus Tag 8, und das setzt seine Vorlage sofort wieder durch. Zwei Controller kämpfen um dasselbe Feld, und notes wird jedes Mal neu ausgerollt.

Fortschritt speichern? Kostenlos registrieren

Drill 3: Zurückschreiben in Git

Mit method: git macht der Image Updater einen Commit. writeBackTarget: kustomization schreibt das Image so in die kustomization.yaml des Overlays, als hättest du kustomize edit set image aufgerufen. Gepusht wird mit dem Deploy-Key, den Argo CD seit Tag 2 kennt. Deshalb hast du ihm in Tag 0 Schreibrechte gegeben.

Diesmal kommt das Objekt ins Fleet-Repo und ersetzt den Versuch:

cd ~/argo-lab/argocd-fleet
cat > applications/notes-updater.yaml <<'EOF'
apiVersion: argocd-image-updater.argoproj.io/v1alpha1
kind: ImageUpdater
metadata:
  name: notes
  namespace: argocd
spec:
  writeBackConfig:
    method: git
    gitConfig:
      branch: main
      writeBackTarget: kustomization
  applicationRefs:
    - namePattern: notes
      images:
        - alias: api
          imageName: ghcr.io/thomaszachmann/notes-api:~0.7
EOF
git add -A
git commit -m "ImageUpdater notes"
git push
argocd app get root --refresh
sleep 150

Jetzt hat jemand anderes ins Repo geschrieben. Du holst seinen Commit:

git pull
git log -2 --format="%h %an: %s"
cat apps/notes/overlays/prod/kustomization.yaml

Erwartet (gekürzt):

9bd76bb argocd-image-updater: build: automatic update of notes
…
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
  - ../../base
images:
  - name: ghcr.io/thomaszachmann/notes-api
    newTag: 0.7.1

Ab jetzt gilt: Vor jeder eigenen Änderung erst git pull. Sonst lehnt GitHub dein git push ab, weil der Image Updater schneller war.

argocd app get notes | grep -E "Sync Status|Health Status"
curl -s localhost:30080/version; echo
curl -s localhost:30080/notes; echo

Erwartet:

Sync Status:        Synced to main (9bd76bb)
Health Status:      Healthy
0.7.1
[{"id":"3fef3430-d55d-431b-bad7-c314189bd7a9","text":"Hallo Argo CD"},{"id":"21d3c5b0-d13b-4f1a-8c0e-a9350c1eb22e","text":"neuer Key"}]

Die Produktion läuft mit 0.7.1, beide Notizen sind noch da. Im nächsten Durchlauf findet der Image Updater nichts mehr zu tun:

kubectl -n argocd logs deploy/argocd-image-updater-controller --since=150s \
  | grep "Processing results" | cut -c1-140

Erwartet:

time="…" level=info msg="Processing results: applications=1 images_considered=1 images_skipped=0 images_updated=0 errors=

Fortschritt speichern? Kostenlos registrieren

Drill 4: Ein Empfänger für Nachrichten

Statt Slack oder Teams nimmt das Lab einen kleinen Dienst im Cluster, der jede Anfrage in sein Log schreibt. Er kommt wie alles andere über Git:

mkdir -p platform/echo
cat > platform/echo/echo.yaml <<'EOF'
apiVersion: apps/v1
kind: Deployment
metadata:
  name: echo
spec:
  replicas: 1
  selector:
    matchLabels:
      app: echo
  template:
    metadata:
      labels:
        app: echo
    spec:
      containers:
        - name: echo
          image: mendhak/http-https-echo:43
          ports:
            - containerPort: 8080
---
apiVersion: v1
kind: Service
metadata:
  name: echo
spec:
  selector:
    app: echo
  ports:
    - port: 80
      targetPort: 8080
EOF
cat > applications/echo.yaml <<'EOF'
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: echo
  namespace: argocd
spec:
  project: default
  source:
    repoURL: [email protected]:<du>/argocd-fleet.git
    targetRevision: main
    path: platform/echo
  destination:
    server: https://kubernetes.default.svc
    namespace: echo
  syncPolicy:
    automated:
      selfHeal: true
      prune: true
    syncOptions:
      - CreateNamespace=true
EOF

Fortschritt speichern? Kostenlos registrieren

Drill 5: Service, Trigger, Template

Die Konfiguration steht in argocd-notifications-cm. Die Installation hat sie leer angelegt, also kommt sie wie argocd-rbac-cm in Tag 9 als ganze Datei nach platform/argocd:

cat > platform/argocd/argocd-notifications-cm.yaml <<'EOF'
apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-notifications-cm
  namespace: argocd
  labels:
    app.kubernetes.io/name: argocd-notifications-cm
    app.kubernetes.io/part-of: argocd
data:
  service.webhook.echo: |
    url: http://echo.echo.svc
    headers:
      - name: Content-Type
        value: application/json
  trigger.on-deployed: |
    - when: >-
        app.status.operationState.phase in ['Succeeded'] and
        app.status.health.status == 'Healthy'
      oncePer: app.status.operationState.syncResult.revision
      send: [deployed]
  template.deployed: |
    webhook:
      echo:
        method: POST
        body: |
          {
            "app": "{{.app.metadata.name}}",
            "revision": "{{.app.status.operationState.syncResult.revision}}",
            "images": "{{.app.status.summary.images}}"
          }
EOF
git add -A
git commit -m "Notifications an echo"
git push
argocd app get root --refresh
argocd app get argocd-extras --refresh
sleep 30
kubectl -n echo get pods

Erwartet (gekürzt):

NAME                    READY   STATUS    RESTARTS   AGE
echo-74669bfbb7-sf67p   1/1     Running   0          27s
  • service.webhook.echo definiert einen Webhook mit dem Namen echo.
  • trigger.on-deployed feuert, wenn ein Sync gelungen und die Application gesund ist. oncePer sorgt dafür, dass das pro Commit nur einmal passiert.
  • template.deployed baut den Text. Er hat Zugriff auf die ganze Application als .app.

Ob die Bedingung für eine Application gerade zutrifft, verrät die CLI im Container des Notification-Controllers:

kubectl -n argocd exec deploy/argocd-notifications-controller -- \
  argocd admin notifications trigger run on-deployed notes-dev

Erwartet:

CONDITION                                                                                   RESULT
app.status.operationState.phase in ['Succeeded'] and app.status.health.status == 'Healthy'  true

Fortschritt speichern? Kostenlos registrieren

Drill 6: Abonnieren

Die Applications von notes entstehen aus dem ApplicationSet. Eine Annotation von Hand würde es wieder entfernen, sie gehört deshalb in die Vorlage. In applications/notes-appset.yaml ergänzt du unter template.metadata zwei Zeilen, so dass der Anfang der Vorlage so aussieht:

  template:
    metadata:
      name: "{{.name}}"
      annotations:
        notifications.argoproj.io/subscribe.on-deployed.echo: ""

Der Aufbau ist subscribe.<trigger>.<service>. Der Wert wäre bei Slack der Kanal. Ein Webhook braucht keinen, deshalb bleibt er leer.

git pull
git commit -am "notes: Benachrichtigung bei Deployment"
git push
argocd app get root --refresh

Jetzt ein echtes Deployment: notes-dev bekommt zwei Repliken.

sed -i "s/replicas: 1/replicas: 2/" apps/notes/overlays/dev/replicas.yaml
git commit -am "notes-dev: zwei Repliken"
git push
git log -1 --format=%h
argocd app get notes-dev --refresh
sleep 30
kubectl -n echo logs deploy/echo | grep '"body"' | tail -1

Erwartet (gekürzt):

36ca1fe
…
    "body": "{\n  \"app\": \"notes-dev\",\n  \"revision\": \"36ca1fe94ba4eca675ea5a9d683d8fd52c16de5f\",\n  \"images\": \"[ghcr.io/thomaszachmann/notes-api:0.7.1 postgres:18.6-alpine]\"\n}\n",

Welche Nachrichten schon verschickt sind, merkt sich Argo CD in einer Annotation an der Application:

kubectl -n argocd get app notes-dev \
  -o jsonpath='{.metadata.annotations.notified\.notifications\.argoproj\.io}'
echo

Erwartet (gekürzt):

{"36ca1fe94ba4eca675ea5a9d683d8fd52c16de5f:on-deployed:[0].y7b5…:echo:":1794729675,…}

Setz die Repliken wieder auf eins. Auch dafür kommt eine Nachricht:

sed -i "s/replicas: 2/replicas: 1/" apps/notes/overlays/dev/replicas.yaml
git commit -am "notes-dev: wieder eine Replik"
git push

Ausprobiert: Ein Tippfehler in der Bedingung, etwa fehlende Anführungszeichen um Succeeded, erzeugt keinen Fehler. Der Controller schreibt nur Trigger 'on-deployed' FAILED ins Log, und es kommt nie eine Nachricht. trigger run zeigt dann false.

Fortschritt speichern? Kostenlos registrieren

Kontrollpunkt

kubectl -n argocd get imageupdater notes

Erwartet: READY ist True.

grep -A2 "images:" ~/argo-lab/argocd-fleet/apps/notes/overlays/prod/kustomization.yaml

Erwartet: newTag: 0.7.1.

kubectl -n argocd get app notes -o jsonpath='{.metadata.annotations}' \
  | grep -o 'subscribe[^"]*'

Erwartet: subscribe.on-deployed.echo.

kubectl -n echo logs deploy/echo | grep -c '"body"'

Erwartet: mindestens 3.

Challenge

Lass den Image Updater auch notes-dev überwachen. Was schreibt er ins Repo?

Hinweis: namePattern versteht Platzhalter wie *.

Lösung

cd ~/argo-lab/argocd-fleet
git pull
sed -i 's/namePattern: notes$/namePattern: "notes*"/' applications/notes-updater.yaml
grep -n namePattern applications/notes-updater.yaml
git commit -am "ImageUpdater auch für notes-dev"
git push
argocd app get root --refresh
sleep 150
kubectl -n argocd logs deploy/argocd-image-updater-controller --since=150s \
  | grep -E "considering|Processing results" | cut -c1-140
kubectl -n argocd get imageupdater notes

Erwartet (gekürzt):

13:    - namePattern: "notes*"
…
time="…" level=info msg="Starting image update cycle, considering 2 application(s) for update" controller=imageupdater co
time="…" level=info msg="Processing results: applications=2 images_considered=2 images_skipped=0 images_updated=0 errors=
NAME    APPS   IMAGES   LAST CHECKED   READY
notes   2      2        27s            True

Nichts. notes-dev läuft schon mit 0.7.1, dem höchsten Tag unter ~0.7. Erst ein Tag 0.7.2 in der Registry löst einen Commit aus, dann für beide Umgebungen.

Fortschritt speichern? Kostenlos registrieren

Enterprise-Notiz

  • Der Image Updater schreibt direkt auf main. Bei geschütztem Branch schreibt er auf einen eigenen (branch: "main:image-updater"), und ein Mensch merged per Pull-Request.
  • Statt semver gibt es digest für veränderliche Tags wie latest und newest-build. Feste Versionsnummern mit semver sind am leichtesten nachzuvollziehen.
  • Private Registries brauchen ein Pull-Secret, das der Image Updater lesen darf.
  • Für Slack, Teams, Mail und viele andere bringt Argo CD fertige Services mit. Ein Katalog fertiger Trigger und Templates liegt im Repo von Argo CD unter notifications_catalog. Zugangsdaten wie ein Slack-Token gehören in argocd-notifications-secret, nie in die ConfigMap.