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. 在 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 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 指令可確保服務已啟動或已刪除,是等待刪除的最佳工具。