Kafka: 2. 服務生命週期腳本
此文件屬於GitHub Actions 及 GitLab CI指南的一部分。請在此處查看完整指南：直接於您的 GitHub Actions 或 GitLab CI pipeline 啟動一個真實的 Kafka 服務，執行測試，並自動清理資源。
👋 歡迎瀏覽 Stackhero 文件！
Stackhero 為您提供一個全受管理的 Kafka cloud 環境，幾分鐘內即可就緒。您可以預期以下優勢：
- 無限制的訊息大小及傳輸量：數據擴展無需擔心上限。
- 簡單，一鍵式更新：讓您的平台隨時保持最新，無需停機或手動操作。
- 穩定的高效能及強大的安全性，全部運行於您專屬的私人獨立基礎設施。
如果您希望加快部署速度並減少營運負擔，Stackhero 的 Kafka cloud hosting 能協助您。大約 5 分鐘即可擁有可投入生產的叢集。
以下是一個完整的腳本範例，涵蓋服務的全生命週期。您會看到只需幾個指令即可完成設定。您可於下方各平台區段複製對應的 YAML 範本。
#!/bin/bash
set -euo pipefail
# STACKHERO_TOKEN 由 CI 機密提供，CLI 會自動讀取。
stackName="ci-kafka-$$" # 每次執行唯一的 stack 名稱
serviceStore="kafka" # Kafka 服務 store
instance="10G" # 如有需要可調整（見步驟 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 netcat-openbsd
# 3. 建立本次執行專屬的 stack
stackId=$(stackhero --format=script stack-create --name="$stackName")
echo "Stack created: $stackId"
# 4. 加入 Kafka 並取得其 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：Open a TCP connection to the broker port.
nc -z -w 5 "$host" 9092
echo "✅ Kafka 已可由 CI 存取。"
清理步驟（刪除服務、等待刪除完成、再刪除 stack）會在下方各平台專屬區段說明。這樣可確保即使 smoke test 失敗也會自動清理。
Stack 必須為空才能刪除。請務必先刪除服務並等待其移除，再刪除 stack。
service-wait-for指令可確保服務已啟動或已刪除，是等待刪除的最佳工具。