Kafka: 2. ライフサイクルスクリプト
このドキュメントはGitHub Actions & GitLab CIガイドの一部です。完全なガイドはこちらからご覧いただけます：GitHub Actions または GitLab CI パイプラインから実際の Kafka サービスを起動し、テストを実行して、自動的に削除する方法。
👋 Stackheroドキュメントへようこそ！
Stackheroでは、すぐに利用可能なフルマネージドの Kafkaクラウド 環境をご提供しています。主な特長は以下の通りです：
- メッセージサイズや転送量に制限なし：データの拡張も制限を気にせずご利用いただけます。
- ワンクリックで簡単にアップデート：ダウンタイムや手作業なしで、常に最新のプラットフォームを維持できます。
- 専用のプライベートインフラ上で、常に高いパフォーマンスと堅牢なセキュリティを実現します。
より迅速な運用や運用負荷の軽減をお求めの場合は、Stackheroの Kafkaクラウドホスティング をご活用ください。約5分で本番環境対応のクラスタを構築できます。
以下はサービスのライフサイクル全体を管理する完全なサンプルスクリプトです。必要なセットアップはごくわずかで、数コマンドのみです。各プラットフォーム向けの完成済み YAML はこの後のセクションからコピーできます。
#!/bin/bash
set -euo pipefail
# STACKHERO_TOKEN は CI シークレットから供給され、CLI が自動的に取得します。
stackName="ci-kafka-$$" # 各実行ごとに一意のスタック名
serviceStore="kafka" # Kafka サービスストア
instance="10G" # 必要に応じて変更（ステップ3参照）
region="europe" # リージョン名（stackhero regions-list 参照）
# 1. ランナーに CLI をインストール
curl -fsSL https://www.stackhero.io/install.sh | sh
# 2. スモークテスト用クライアントをインストール（jq + curl がベース）
apt-get update && apt-get install -y --no-install-recommends jq curl netcat-openbsd
# 3. この実行用の専用スタックを作成
stackId=$(stackhero --format=script stack-create --name="$stackName")
echo "Stack created: $stackId"
# 4. Kafka を追加し、サービス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. スモークテスト: Open a TCP connection to the broker port.
nc -z -w 5 "$host" 9092
echo "✅ Kafka は CI から到達可能です。"
サービスの削除、削除完了待機、スタックの削除といったクリーンアップ手順は、下記のプラットフォーム別セクションで説明しています。この方法により、スモークテストが失敗した場合でも必ずクリーンアップが実行されます。
スタックは空でなければ削除できません。必ず先にサービスを削除し、その削除完了を待ってからスタックを削除してください。
service-wait-forコマンドは、サービスが稼働中または削除済みであることを保証するため、削除待機にも最適です。