Tag 13: API und Automatisierung
Ziel: Mit OpenNebula direkt über seine APIs sprechen: XML-RPC aus Python ohne Zusatzpakete und die REST-API von OneFlow mit
curl. · Dauer: ca. 60 min · Voraussetzung: Tag 9
Briefing
- Alles in OpenNebula läuft über eine XML-RPC-API auf
Port 2633: CLI, Sunstone, OpenTofu. Jeder Aufruf heißt
one.<objekt>.<aktion>, etwaone.vm.infooderone.vmpool.info, und bekommt als erstes Argument die Session"benutzer:passwort". - Jede Antwort ist eine Liste:
[Erfolg, Ergebnis oder Fehlermeldung, Fehlercode, …]. Objekte kommen als XML-Text. - OneFlow hat eine eigene REST-API mit JSON auf Port 2474.
- Python bringt einen XML-RPC-Client mit (
xmlrpc.client). Die Bibliothekpyoneaus dem OpenNebula-Projekt macht dasselbe bequemer, ist aber nicht nötig.
vms.py ──► XML-RPC :2633/RPC2 ──► oned
curl ──► REST :2474/service ──► OneFlow ──► XML-RPC ──► oned
Drill 1: Der erste Aufruf
mkdir -p ~/one-lab/tag13
cd ~/one-lab/tag13
python3 -c 'import xmlrpc.client; print(xmlrpc.client.ServerProxy("http://localhost:2633/RPC2").one.system.version("oneadmin:lab-one-pass-123"))'Erwartet:
[True, '7.4.1', 0]
Dasselbe mit falschem Passwort:
python3 -c 'import xmlrpc.client; print(xmlrpc.client.ServerProxy("http://localhost:2633/RPC2").one.system.version("oneadmin:falsch"))'Erwartet:
[False, "[one.system.version] User couldn't be authenticated, aborting call.", 256, -1, -1]
Kein Python-Fehler, sondern False und ein Code. Ein
Skript muss das erste Element deshalb immer prüfen.
Fortschritt speichern? Kostenlos registrieren
Drill 2: Alle VMs
cat > vms.py <<'EOF'
#!/usr/bin/env python3
"""Listet alle VMs über die XML-RPC-API von OpenNebula."""
import xml.etree.ElementTree as ET
import xmlrpc.client
SESSION = "oneadmin:lab-one-pass-123"
one = xmlrpc.client.ServerProxy("http://localhost:2633/RPC2")
ok, body, code = one.one.vmpool.info(SESSION, -2, -1, -1, -1)[:3]
if not ok:
raise SystemExit(f"Fehler {code}: {body}")
for vm in ET.fromstring(body).findall("VM"):
ip = vm.findtext("TEMPLATE/NIC/IP", default="-")
print(vm.findtext("ID"), vm.findtext("NAME"), vm.findtext("STATE"), ip)
EOF
python3 vms.pyErwartet (IDs und IPs weichen ab):
30 api_0_(service_3) 3 192.168.150.33
29 db_0_(service_3) 3 192.168.150.32
Argument von vmpool.info |
Bedeutung |
|---|---|
-2 |
alle VMs, die die Session sehen darf |
-1, -1 |
ID-Bereich von … bis, -1 heißt ohne Grenze |
-1 |
alle Zustände außer DONE |
STATE kommt als Zahl: 3 ist
ACTIVE. Die Zuordnung steht in der API-Dokumentation.
TEMPLATE/NIC/IP ist ein XPath-Ausdruck, er nimmt die erste
NIC.
Fortschritt speichern? Kostenlos registrieren
Drill 3: Schreiben
Ein Skript, das an eine VM ein Attribut hängt, zum Beispiel wem sie gehört:
cat > markieren.py <<'EOF'
#!/usr/bin/env python3
"""Schreibt ein Attribut in das USER_TEMPLATE einer VM."""
import sys
import xmlrpc.client
SESSION = "oneadmin:lab-one-pass-123"
one = xmlrpc.client.ServerProxy("http://localhost:2633/RPC2")
vm_id, wert = int(sys.argv[1]), sys.argv[2]
ok, body, code = one.one.vm.update(SESSION, vm_id, f"BESITZER=\"{wert}\"", 1)[:3]
print("ok" if ok else f"Fehler {code}: {body}")
EOF
python3 markieren.py 30 "Team Blau"
onevm show 30 | grep BESITZERErwartet (nimm die ID deiner API-VM):
ok
BESITZER="Team Blau"
Die 1 am Ende heißt merge: Das Attribut kommt
dazu, alles andere bleibt. Mit 0 würde der Text das ganze
USER_TEMPLATE ersetzen.
python3 markieren.py 9999 xErwartet:
Fehler 1024: [one.vm.update] Error getting virtual machine [9999].
Fortschritt speichern? Kostenlos registrieren
Drill 4: OneFlow per REST
curl -s -u oneadmin:lab-one-pass-123 http://localhost:2474/service \
| jq -r '.DOCUMENT_POOL.DOCUMENT[] | [.ID, .NAME, .TEMPLATE.BODY.state] | @tsv'Erwartet:
3 notes-service 2
Zustand 2 ist RUNNING. Skalieren geht mit
einem POST auf /service/<ID>/scale:
curl -s -u oneadmin:lab-one-pass-123 -X POST http://localhost:2474/service/3/scale \
-H "Content-Type: application/json" \
-d '{"role_name": "api", "cardinality": 2, "force": false}'
oneflow show 3 | sed -n '/ROLE api/,/NODES/p' | grep -E 'STATE|CARD'Erwartet (kurz danach):
ROLE STATE : SCALING
CARDINALITY : 2
Die API antwortet bei Erfolg ohne Text. Ein falscher Pfad dagegen liefert eine HTML-Seite „Sinatra doesn’t know this ditty“, die Fehlerseite des Ruby-Frameworks hinter OneFlow.
Fortschritt speichern? Kostenlos registrieren
Kontrollpunkt
python3 vms.py | wc -lErwartet: 3, die Datenbank und zwei API-VMs.
diff ~/one-lab/tag13/markieren.py ~/one-lab/code/loesung/tag13/markieren.pyErwartet: keine Ausgabe.
Challenge
Erweitere vms.py so, dass es zu jeder VM auch das
Attribut BESITZER ausgibt, falls es gesetzt ist, sonst
-.
Hinweis: onevm show zeigt, dass
BESITZER im USER_TEMPLATE steht, nicht im
TEMPLATE.
Lösung
Der erste Versuch, nur die Ausgabe zu erweitern, zeigt überall
-, auch bei der markierten VM. vmpool.info
liefert aus Geschwindigkeitsgründen nur einen Auszug jedes Templates.
Das volle USER_TEMPLATE gibt es mit vmpool.infoextended,
mit denselben Argumenten:
sed -i 's/one.one.vmpool.info(/one.one.vmpool.infoextended(/' vms.py
head -n -1 vms.py > neu.py
cat >> neu.py <<'EOF'
owner = vm.findtext("USER_TEMPLATE/BESITZER", default="-")
print(vm.findtext("ID"), vm.findtext("NAME"), vm.findtext("STATE"), ip, owner)
EOF
mv neu.py vms.py
python3 vms.pyErwartet:
43 api_1_(service_3) 3 192.168.150.46 -
30 api_0_(service_3) 3 192.168.150.33 Team Blau
29 db_0_(service_3) 3 192.168.150.32 -
head -n -1 lässt die letzte Zeile weg, die neue
print-Zeile ersetzt sie. Für große Clouds ist
infoextended deutlich langsamer. Wer nur Namen und Zustände
braucht, bleibt bei info.
Fortschritt speichern? Kostenlos registrieren
Enterprise-Notiz
- pyone und goca: Für größere Werkzeuge gibt es
offizielle Bibliotheken,
pyonefür Python undgocafür Go. Sie übersetzen XML in Objekte und kennen alle Aufrufe. - Tokens statt Passwörter: Skripte bekommen einen
eigenen Benutzer mit Login-Token
(
oneuser token-create --time 86400). Läuft das Token ab oder wird es zurückgezogen, ist nur das Skript betroffen. - API absichern: Port 2633 und 2474 hören im Lab auf allen Adressen. Im Betrieb stehen sie hinter einem TLS-Proxy, und nur Verwaltungsnetze kommen heran.