Mercure-Hub: 2. 服務生命週期腳本
此文件屬於GitHub Actions 及 GitLab CI指南的一部分。請在此處查看完整指南:直接於您的 GitHub Actions 或 GitLab CI pipeline 啟動一個真實的 Mercure Hub 服務,執行測試,並自動清理資源。
👋 歡迎瀏覽 Stackhero 文件!
Stackhero 為您提供全託管的 Mercure-Hub cloud 服務,專為簡化和提升即時數據傳送的可靠性而設計。您將享有:
- 無限請求及訊息大小,靈活度極高。
- 內建 HTTPS 安全性的自訂網域(例如 https://real-time.your-company.com)。
- 一鍵更新,輕鬆保持您的 hub 為最新狀態,無需額外操作。
- 在專屬私有基礎設施上提供高效能及強大安全性。
- 多個地區選擇:🇪🇺 歐洲及🇺🇸 美國,確保低延遲傳送。
快速啟動:只需 5 分鐘即可部署您的 Mercure-Hub cloud hosting 環境,立即開始為您的應用程式推送即時更新。
以下是一個完整的腳本範例,涵蓋服務的全生命週期。您會看到只需幾個指令即可完成設定。您可於下方各平台區段複製對應的 YAML 範本。
#!/bin/bash
set -euo pipefail
# STACKHERO_TOKEN 由 CI 機密提供,CLI 會自動讀取。
stackName="ci-mercure-hub-$$" # 每次執行唯一的 stack 名稱
serviceStore="mercure-hub" # Mercure Hub 服務 store
instance="20G" # 如有需要可調整(見步驟 3)
region="europe" # 區域名稱(可用 stackhero regions-list 查詢)
# 1. 安裝 CLI 至 runner
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. 加入 Mercure Hub 並取得其 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')
# 8. Smoke test:Request the hub endpoint and check it answers.
curl -fsS -o /dev/null -w "%{http_code}" "https://$host/.well-known/mercure?topic=test" | grep -qE "^(200|400|401)$"
echo "✅ Mercure Hub 已可由 CI 存取。"
清理步驟(刪除服務、等待刪除完成、再刪除 stack)會在下方各平台專屬區段說明。這樣可確保即使 smoke test 失敗也會自動清理。
Stack 必須為空才能刪除。請務必先刪除服務並等待其移除,再刪除 stack。
service-wait-for指令可確保服務已啟動或已刪除,是等待刪除的最佳工具。