OpenSearch: 2. 生命週期腳本

本文件是GitHub Actions 與 GitLab CI指南的一部分。請在此處查看完整指南:直接從您的 GitHub Actions 或 GitLab CI pipeline 啟動一個真實的 OpenSearch 服務,執行測試,並自動銷毀服務

👋 歡迎來到 Stackhero 文件中心!

Stackhero 提供全代管的 OpenSearch cloud 環境,專為高效能與安全性設計:

  • 專屬、私有基礎架構上,兼具高效能與強大安全性
  • 支援自訂網域名稱,預設即有HTTPS 保護。
  • 內建 OpenSearch Dashboards,輕鬆進行資料探索與視覺化。

免除繁瑣的設定與維護:只需幾分鐘,即可在 Stackhero 上啟用 OpenSearch cloud hosting

以下是一個完整的腳本範例,涵蓋服務的全生命週期。您會發現設定非常簡單,只需幾個指令即可。您可以直接從下方各平台區段複製對應的 YAML 配置。

#!/bin/bash
set -euo pipefail

# STACKHERO_TOKEN 由 CI 機密提供,CLI 會自動讀取。

stackName="ci-opensearch-$$"          # 每次執行唯一的 stack 名稱
serviceStore="opensearch"             # OpenSearch 服務 store
instance="20G"        # 如有需要可調整(見步驟 3)
region="europe"                         # 區域名稱(可用 stackhero regions-list 查詢)

# 1. 在 runner 上安裝 CLI
curl -fsSL https://www.stackhero.io/install.sh | sh

# 2. 安裝 smoke test 所需的 client(jq + curl 為基本需求)
apt-get update && apt-get install -y --no-install-recommends jq curl

# 3. 為本次執行建立專屬 stack
stackId=$(stackhero --format=script stack-create --name="$stackName")
echo "Stack created: $stackId"

# 4. 新增 OpenSearch 並取得其 service id
serviceId=$(stackhero --format=script service-add \
  --stack="$stackId" \
  --service-store="$serviceStore" \
  --instance="$instance" \
  --region="$region")
echo "Service added: $serviceId"

# 5. 等待服務啟動(可能需數分鐘)
stackhero service-wait-for --service="$serviceId"

# 6. 讀取設定(包含產生的認證資訊)
config=$(stackhero service-configuration-get --service="$serviceId" --format=json)

# 7. 取得所需認證資訊
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 已可從 CI 存取。"

資源清理(刪除服務、等待刪除完成、再刪除 stack)會在下方各平台專屬區段說明。這種做法可確保即使 smoke test 失敗也會進行完整清理。

Stack 必須為空才能刪除。請務必先刪除服務並等待其移除,再刪除 stack。service-wait-for 指令可確保服務已啟動或已刪除,是等待刪除的最佳工具。