Kafka: 5. GitLab CI

このドキュメントはGitHub Actions & GitLab CIガイドの一部です。完全なガイドはこちらからご覧いただけます:GitHub Actions または GitLab CI パイプラインから実際の Kafka サービスを起動し、テストを実行して、自動的に削除する方法

👋 Stackheroドキュメントへようこそ!

Stackheroでは、すぐに利用可能なフルマネージドの Kafkaクラウド 環境をご提供しています。主な特長は以下の通りです:

  • メッセージサイズや転送量に制限なし:データの拡張も制限を気にせずご利用いただけます。
  • ワンクリックで簡単にアップデート:ダウンタイムや手作業なしで、常に最新のプラットフォームを維持できます。
  • 専用のプライベートインフラ上で、常に高いパフォーマンスと堅牢なセキュリティを実現します。

より迅速な運用や運用負荷の軽減をお求めの場合は、Stackheroの Kafkaクラウドホスティング をご活用ください。約5分で本番環境対応のクラスタを構築できます。

以下の設定を .gitlab-ci.yml として保存してください。この構成では、パイプラインごとに新しい実際の 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 内で行われます。このセクションはジョブが失敗しても必ず実行されるため、Kafka リソースが確実に削除され、不要な課金を防げます。

GitLab では after_script新しいシェルで実行されます。そのため、ジョブ中にサービスIDやスタックIDを deploy.env に書き出し、クリーンアップ前に再ロードしています。これにより、ジョブ途中で失敗してもリソースが確実に削除されます。

以上が Kafka の CI ライフサイクルの全体像です。スタック作成、サービス追加、待機、認証情報取得、スモークテスト、そして必ずクリーンアップ。各パイプライン実行ごとに実際の分離されたサービスが提供され、実行後は何も残りません。利用可能なコマンドや非対話型 STACKHERO_TOKEN 認証については、CLI の詳細ドキュメント もご参照ください。