Kafka: 4. GitHub Actions
このドキュメントはGitHub Actions & GitLab CIガイドの一部です。完全なガイドはこちらからご覧いただけます：GitHub Actions または GitLab CI パイプラインから実際の Kafka サービスを起動し、テストを実行して、自動的に削除する方法。
👋 Stackheroドキュメントへようこそ！
Stackheroでは、すぐに利用可能なフルマネージドの Kafkaクラウド 環境をご提供しています。主な特長は以下の通りです：
- メッセージサイズや転送量に制限なし：データの拡張も制限を気にせずご利用いただけます。
- ワンクリックで簡単にアップデート：ダウンタイムや手作業なしで、常に最新のプラットフォームを維持できます。
- 専用のプライベートインフラ上で、常に高いパフォーマンスと堅牢なセキュリティを実現します。
より迅速な運用や運用負荷の軽減をお求めの場合は、Stackheroの Kafkaクラウドホスティング をご活用ください。約5分で本番環境対応のクラスタを構築できます。
まず、以下の内容を .github/workflows/ci.yml として保存してください。これ以降、push や pull request ごとに実際の Kafka インスタンスでテストが実行されます。
name: CI with Kafka
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
env:
STACKHERO_TOKEN: ${{ secrets.STACKHERO_TOKEN }}
STACK_NAME: ci-kafka-${{ github.run_id }}-${{ github.run_attempt }}
INSTANCE: "10G" # 必要に応じて変更（ステップ3参照）
REGION: europe
steps:
- uses: actions/checkout@v4
- name: Stackhero CLI とクライアントのインストール
run: |
curl -fsSL https://www.stackhero.io/install.sh | sh
apt-get update && apt-get install -y --no-install-recommends jq curl netcat-openbsd
- name: Kafka サービスの作成
run: |
set -euo pipefail
STACK_ID=$(stackhero --format=script stack-create --name="$STACK_NAME")
echo "STACK_ID=$STACK_ID" >> "$GITHUB_ENV"
SERVICE_ID=$(stackhero --format=script service-add \
--stack="$STACK_ID" \
--service-store="kafka" \
--instance="$INSTANCE" \
--region="$REGION")
echo "SERVICE_ID=$SERVICE_ID" >> "$GITHUB_ENV"
stackhero service-wait-for --service="$SERVICE_ID"
- name: Kafka でテストを実行
run: |
set -euo pipefail
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 から到達可能です。"
# 上記の認証情報を使って独自のテストスイートも実行できます ...
- name: クリーンアップ（常に実行、失敗時も）
if: always()
run: |
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
クリーンアップステップは if: always() で設定されているため、どんな場合でも必ず実行され、Kafka インスタンスが削除され、未使用リソースの課金を防ぎます。