Kafka: 5. GitLab CI

此文件屬於GitHub Actions 及 GitLab CI指南的一部分。請在此處查看完整指南:直接於您的 GitHub Actions 或 GitLab CI pipeline 啟動一個真實的 Kafka 服務,執行測試,並自動清理資源

👋 歡迎瀏覽 Stackhero 文件!

Stackhero 為您提供一個全受管理的 Kafka cloud 環境,幾分鐘內即可就緒。您可以預期以下優勢:

  • 無限制的訊息大小及傳輸量:數據擴展無需擔心上限。
  • 簡單,一鍵式更新:讓您的平台隨時保持最新,無需停機或手動操作。
  • 穩定的高效能及強大的安全性,全部運行於您專屬的私人獨立基礎設施

如果您希望加快部署速度並減少營運負擔,Stackhero 的 Kafka cloud hosting 能協助您。大約 5 分鐘即可擁有可投入生產的叢集。

請將下列設定儲存為 .gitlab-ci.yml。每次 pipeline 執行時都會建立一個全新的 Kafka 實例供測試使用。

test:
  image: ubuntu:24.04
  variables:
    STACK_NAME: "ci-kafka-$CI_PIPELINE_ID-$CI_JOB_ID"
    INSTANCE: "10G"   # 如有需要可調整(見步驟 3)
    REGION: "europe"
    SERVICE_STORE: "kafka"
  # STACKHERO_TOKEN 來自您於步驟 1 建立的 CI/CD 變數。
  script:
    - set -euo pipefail
    - curl -fsSL https://www.stackhero.io/install.sh | sh
    - apt-get update && apt-get install -y --no-install-recommends jq curl netcat-openbsd
    - STACK_ID=$(stackhero --format=script stack-create --name="$STACK_NAME")
    - echo "STACK_ID=$STACK_ID" >> deploy.env
    - SERVICE_ID=$(stackhero --format=script service-add --stack="$STACK_ID" --service-store="$SERVICE_STORE" --instance="$INSTANCE" --region="$REGION")
    - echo "SERVICE_ID=$SERVICE_ID" >> deploy.env
    - stackhero service-wait-for --service="$SERVICE_ID"
    - config=$(stackhero service-configuration-get --service="$SERVICE_ID" --format=json)
    - host=$(echo "$config" | jq -r '.configuration.domain')
    # Open a TCP connection to the broker port.
    - nc -z -w 5 "$host" 9092
    - echo "✅ Kafka 已可由 CI 存取。"
    # 您亦可於此處使用上述認證資料執行自訂測試 ...
  after_script:
    - test -f deploy.env && . ./deploy.env || true
    - >
      if [ -n "${SERVICE_ID:-}" ]; then
        stackhero service-delete --service="$SERVICE_ID" --confirm
        stackhero service-wait-for --service="$SERVICE_ID"
      fi
    - >
      if [ -n "${STACK_ID:-}" ]; then
        stackhero stack-delete --stack="$STACK_ID" --confirm
      fi

於 GitLab,清理動作會寫在 after_script,此區段無論 job 成功與否都會執行,確保 Kafka 資源被移除,避免產生不必要的費用。

在 GitLab,after_script 會於 全新 shell 執行。為處理此情境,腳本會於 job 過程中將 service 及 stack ID 寫入 deploy.env,於清理前再讀取。即使 job 執行中途失敗,您的資源仍會被正確清理。

這就是 Kafka 的完整 CI 生命週期:建立 stack、加入服務、等待、取得認證、smoke test、並始終清理。每次 pipeline 執行都會獲得一個獨立的真實服務,流程結束後不會有任何資源殘留。如需更多 CLI 指令及非互動式 STACKHERO_TOKEN 認證說明,請參閱 完整 CLI 文件