OpenSearch: 2. Das Lifecycle-Skript
Diese Dokumentation ist Teil des GitHub Actions & GitLab CI-Leitfadens. Den vollständigen Leitfaden finden Sie hier: Starten Sie einen echten OpenSearch-Service direkt aus Ihrer GitHub Actions- oder GitLab CI-Pipeline, führen Sie Ihre Tests dagegen aus und fahren Sie ihn anschließend automatisch wieder herunter.
👋 Willkommen in der Stackhero-Dokumentation!
Stackhero bietet Ihnen eine vollständig verwaltete OpenSearch Cloud-Umgebung, die sowohl auf Performance als auch auf Sicherheit ausgelegt ist:
- Hohe Performance und starke Sicherheit auf einer privaten, dedizierten Infrastruktur.
- Nutzen Sie Ihre eigene individuelle Domain, standardmäßig geschützt mit HTTPS.
- Integrierte OpenSearch Dashboards für eine einfache Datenanalyse und Visualisierung.
Sparen Sie sich aufwändige Einrichtung und Wartung: Mit dem OpenSearch Cloud Hosting von Stackhero sind Sie in wenigen Minuten startklar.
Hier finden Sie ein vollständiges Beispielskript, das den gesamten Lebenszyklus des Services abbildet. Es zeigt, wie wenig Setup nötig ist – nur wenige Befehle. Die fertigen YAML-Beispiele für Ihre Plattform finden Sie in den folgenden Abschnitten.
#!/bin/bash
set -euo pipefail
# STACKHERO_TOKEN wird als CI-Secret bereitgestellt und vom CLI automatisch erkannt.
stackName="ci-opensearch-$$" # Eindeutiger Stack-Name pro Lauf
serviceStore="opensearch" # Der OpenSearch-Service Store
instance="20G" # Bei Bedarf anpassen (siehe Schritt 3)
region="europe" # Regionsname (siehe stackhero regions-list)
# 1. CLI auf dem Runner installieren
curl -fsSL https://www.stackhero.io/install.sh | sh
# 2. Client für den Smoke-Test installieren (jq + curl sind die Basis)
apt-get update && apt-get install -y --no-install-recommends jq curl
# 3. Dedizierten Stack für diesen Lauf erstellen
stackId=$(stackhero --format=script stack-create --name="$stackName")
echo "Stack erstellt: $stackId"
# 4. OpenSearch hinzufügen und Service-ID erfassen
serviceId=$(stackhero --format=script service-add \
--stack="$stackId" \
--service-store="$serviceStore" \
--instance="$instance" \
--region="$region")
echo "Service hinzugefügt: $serviceId"
# 5. Warten, bis der Service läuft (dauert ggf. einige Minuten)
stackhero service-wait-for --service="$serviceId"
# 6. Konfiguration auslesen (enthält die generierten Zugangsdaten)
config=$(stackhero service-configuration-get --service="$serviceId" --format=json)
# 7. Benötigte Zugangsdaten extrahieren
host=$(echo "$config" | jq -r '.configuration.domain')
user=$(echo "$config" | jq -r '.configuration.credentials.login')
password=$(echo "$config" | jq -r '.configuration.credentials.password')
# 8. Smoke-Test: Call the cluster health endpoint.
curl -fsS -u "$user:$password" "https://$host:9200/_cluster/health" | grep -q '"status"'
echo "✅ OpenSearch ist aus der CI erreichbar."
Der Teardown-Schritt, der den Service löscht, auf dessen Entfernung wartet und anschließend den Stack entfernt, ist in den plattformspezifischen Abschnitten unten beschrieben. So wird sichergestellt, dass immer aufgeräumt wird – auch wenn ein Smoke-Test fehlschlägt.
Ein Stack kann nur gelöscht werden, wenn er leer ist. Löschen Sie daher immer zuerst den Service und warten Sie auf dessen Entfernung, bevor Sie den Stack löschen. Der Befehl
service-wait-forstellt sicher, dass der Service entweder läuft oder bereits gelöscht ist, und eignet sich daher auch zum Warten auf die Löschung.