Tag 11: OneGate und Hooks
Ziel: VMs ihren Zustand an OpenNebula melden lassen und auf Ereignisse in OpenNebula mit eigenen Skripten reagieren. · Dauer: ca. 60 min · Voraussetzung: Tag 10
Briefing
Zwei Richtungen, zwei Werkzeuge:
| Werkzeug | Richtung | Beispiel |
|---|---|---|
| OneGate | VM → OpenNebula | „Ich bin bereit“, „ich habe 42 Notizen“ |
| Hooks | OpenNebula → Skript auf dem Frontend | „VM läuft“ → Eintrag ins Log, Ticket, Chat |
- OneGate ist ein kleiner REST-Dienst (Port 5030).
Eine VM darf ihn nutzen, wenn ihr Kontext
TOKEN = "YES"enthält. Dann bekommt sie ein Token, das nur für sie selbst gilt. Der Befehlonegatein der VM spricht damit. REPORT_READY = "YES"lässt one-context nach dem StartREADY=YESmelden. Darauf wartet OneFlow mitready_status_gate(Tag 9).- Hooks führt der Hook Execution Manager
(
opennebula-hem) aus. Ein State-Hook reagiert auf Zustandswechsel, ein API-Hook auf Aufrufe der XML-RPC-API.
VM ── onegate vm update ──► OneGate :5030 ──► oned: USER_TEMPLATE der VM
oned ── VM wird RUNNING ──► HEM ──► /usr/local/bin/vm-laeuft.sh <Template als Base64>
Drill 1: Token für das Template
Das Template alpine aus Tag 4 bekommt zwei Zeilen im
Kontext:
mkdir -p ~/one-lab/tag11
cd ~/one-lab/tag11
sed 's/ NETWORK = "YES",/ NETWORK = "YES",\n TOKEN = "YES",\n REPORT_READY = "YES",/' \
../tag04/alpine.tpl > alpine.tpl
grep -A3 '^CONTEXT' alpine.tpl
onetemplate update alpine alpine.tplErwartet:
CONTEXT = [
NETWORK = "YES",
TOKEN = "YES",
REPORT_READY = "YES",
onetemplate update ersetzt den Inhalt, die Rechte aus
Tag 8 bleiben.
onetemplate instantiate alpine --name gate --user-inputs GRUSS=gNach einer Minute:
onevm show gate | grep -E 'READY|ONEGATE'Erwartet:
READY="YES"
ONEGATE_ENDPOINT="http://169.254.16.9:5030",
REPORT_READY="YES",
READY="YES" hat die VM selbst gemeldet. Die Adresse
169.254.16.9 ist eine Link-Local-Adresse, die OpenNebula auf jedem Host
zu OneGate weiterleitet. So erreichen auch VMs in Netzen ohne Gateway
den Dienst.
Fortschritt speichern? Kostenlos registrieren
Drill 2: Eigene Werte melden
IP=$(onevm show gate | grep -o 'ETH0_IP="[0-9.]*' | cut -d'"' -f2)
ssh $IP 'onegate vm update --data "NOTIZEN=1
STATUS=bereit"'
onevm show gate | sed -n '/USER TEMPLATE/,$p' | grep -E 'NOTIZEN|STATUS'Erwartet:
NOTIZEN="1"
STATUS="bereit"
Die Werte stehen jetzt im USER_TEMPLATE der VM, sichtbar
in CLI, Sunstone und API. Eine Appliance kann so ihre Version, ihre URL
oder einen Fehler nach außen geben, ohne dass jemand sich einloggen
muss.
Die VM darf auch lesen:
ssh $IP onegate vm showErwartet:
VM 35
NAME : gate
Mehr darf sie nicht. Das Token gilt nur für diese eine VM und, falls
sie zu einem OneFlow-Service gehört, für ihre Geschwister im Service
(onegate service show).
Fortschritt speichern? Kostenlos registrieren
Drill 3: Ein Hook
Jedes Mal, wenn eine VM läuft, soll ein Eintrag ins Systemlog. Der Hook bekommt das ganze VM-Template als Base64-XML. Ein kleines Skript holt den Namen heraus:
cat > vm-laeuft.sh <<'EOF'
#!/bin/sh
# Hook: $1 ist das Template der VM als Base64-XML
NAME=$(echo "$1" | base64 -d | grep -o "<NAME>[^<]*" | head -1 | cut -d">" -f2)
logger -t opennebula-hook "VM $NAME läuft"
EOF
sudo install -m 755 vm-laeuft.sh /usr/local/bin/vm-laeuft.sh
cat > laeuft.hook <<'EOF'
NAME = "vm-laeuft"
TYPE = "state"
RESOURCE = "VM"
ON = "RUNNING"
COMMAND = "/usr/local/bin/vm-laeuft.sh"
ARGUMENTS = "$TEMPLATE"
EOF
onehook create laeuft.hookErwartet:
ID: 2
ON = "RUNNING"ist eine Abkürzung für den Wechsel nachACTIVE/RUNNING. Andere sindPROLOG,SHUTDOWN,STOP,DONE,UNKNOWN, oderCUSTOMmit eigenemSTATEundLCM_STATE.- Das Skript läuft auf dem Frontend als Benutzer
oneadmin. Deshalb liegt es in/usr/local/bin, wooneadmines ausführen darf.
Ausprobiert: Ohne
ONscheitertonehook createmitUnkown state condition(sic). Und inARGUMENTSersetzt OpenNebula nur$TEMPLATEund wenige andere Platzhalter, ein$IDbleibt leer. Deshalb liest das Skript den Namen aus dem Template.
Eine VM zum Ausprobieren:
onetemplate instantiate alpine --name hooktest --user-inputs GRUSS=hNach einer Minute:
onehook show vm-laeuft | sed -n '/EXECUTION LOG/,$p'
sudo journalctl -t opennebula-hook --since "-5min" --no-pager | tail -1Erwartet (Zeiten weichen ab):
EXECUTION LOG
ID TIMESTAMP RC EXECUTION
0 11/12 20:25 0 SUCCESS
Nov 12 20:25:07 one opennebula-hook[1290086]: VM hooktest läuft
onehook show vm-laeuft -e 0 zeigt die ganze Ausführung
mit Befehl, Argumenten und Ausgabe. Das ist die erste Anlaufstelle, wenn
ein Hook mit RC ungleich 0 endet.
Fortschritt speichern? Kostenlos registrieren
Kontrollpunkt
onehook listErwartet: vm-laeuft vom Typ state.
onevm show gate | grep READY=Erwartet: READY="YES".
Challenge
Ein zweiter Hook vm-weg soll ins Log schreiben, wenn
eine VM gelöscht wird. Lösch hooktest und prüf das Log.
Lösung
sed -e 's/vm-laeuft"/vm-weg"/' -e 's/"RUNNING"/"DONE"/' -e 's|vm-laeuft.sh|vm-weg.sh|' \
laeuft.hook > weg.hook
sed 's/läuft/ist gelöscht/' vm-laeuft.sh > vm-weg.sh
sudo install -m 755 vm-weg.sh /usr/local/bin/vm-weg.sh
onehook create weg.hook
onevm terminate --hard hooktestEin paar Sekunden später:
sudo journalctl -t opennebula-hook --since "-1min" --no-pager | tail -1Erwartet:
Nov 12 20:25:57 one opennebula-hook[1291354]: VM hooktest ist gelöscht
DONE ist der letzte Zustand einer VM. Danach existiert
sie nur noch in der Historie.
Aufräumen:
onevm terminate --hard gateDie Hooks bleiben, sie stören nicht.
Fortschritt speichern? Kostenlos registrieren
Enterprise-Notiz
- Hooks für Integrationen: Typische Hooks melden neue
VMs an eine CMDB, tragen sie ins DNS ein oder öffnen ein Ticket, wenn
ein Host
ERRORmeldet. Für Hosts gibt es eine fertige Hook-Vorlage, die bei Ausfall eines Hosts die VMs auf anderen Hosts neu startet. - Monitoring aus der VM: OneGate ist kein Ersatz für Prometheus, aber praktisch für Werte, die OpenNebula selbst braucht, etwa für die Elastizitätsregeln von OneFlow.
- Token-Schutz: Das OneGate-Token liegt in der VM.
Wer root in der VM ist, kann die VM über OneGate beschreiben, aber nicht
mehr. Wer OneGate nicht braucht, lässt
TOKENweg.