Kafka: CLIによる自動化

Stackhero CLIを使ってKafkaを起動し、認証情報を取得し、構成をプログラムで変更する方法

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

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

メッセージサイズや転送量に制限なし：データの拡張も制限を気にせずご利用いただけます。

ワンクリックで簡単にアップデート：ダウンタイムや手作業なしで、常に最新のプラットフォームを維持できます。

専用のプライベートインフラ上で、常に高いパフォーマンスと堅牢なセキュリティを実現します。

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

このガイドでは、コマンドラインのみでKafkaサービスを作成し、その認証情報を取得し、構成を更新する方法を解説します。ダッシュボードでクリック操作を行う必要はありません。スクリプト、CIパイプライン、AIエージェントでの利用に最適です。

すべての操作にはStackhero CLIを使用します。まだインストールしていない場合は、以下のコマンドでインストールできます。

curl -fsSL https://www.stackhero.io/install.sh | sh

1. 認証

最も簡単な開始方法は、ブラウザ経由でログインすることです。ログインコマンドを実行すると、CLIがWebページを開き、そこでアクセスを承認できます。CLI自体にパスワードや2要素認証コードを入力する必要はありません。

stackhero login

ログイン後、認証情報はローカルに保存され、以降のCLIコマンドで自動的に利用されます。

スクリプトやCIパイプラインなど完全自動化された環境では、非対話型のアクセストークンを利用するのが便利です。ダッシュボード（アカウント > Access tokens）からトークンを作成し、環境変数としてエクスポートしてください。CLIや実行するスクリプトは自動的にこのトークンを認識します。

export STACKHERO_TOKEN="usr-xxxxxx:your-token"

2. Kafkaサービスストアの検索

次に、アカウントで利用可能なKafkaサービスストアを一覧表示します。CLIはストアの名前（kafka）を直接受け付けるため、IDを調べたりコピーしたりする必要はありません。

# Kafkaサービスストアを一覧表示（複数組織を管理している場合は--organizationを追加）
stackhero services-store-list --name="kafka"

以降のコマンドではストア名kafkaを参照できます。また、必要に応じてリストから特定のsvs-xxxxxx IDを選択することも可能です。

3. インスタンスサイズとリージョンの選択

# サービスストアのインスタンスサイズを一覧表示（--instanceにはNAME列を使用）
stackhero instances-store-list --service-store=kafka

# 利用可能なリージョンを一覧表示（例: "europe"など）
stackhero regions-list

4. サービスの作成

以下は、スタックを作成し、Kafkaサービスを追加し、起動を待ち、構成（生成された認証情報を含む）を取得し、新しい構成を適用するサンプルスクリプトです。

#!/bin/bash
set -e

export STACKHERO_TOKEN="usr-xxxxxx:your-token"

serviceStore="kafka"   # Kafkaサービスストア名（ステップ2参照）
instance="..."                # ステップ3で選択したインスタンスサイズ
region="europe"               # ステップ3で選択したリージョン名

# サービス用のスタックを作成（デフォルト組織を使用。必要に応じて--organizationを追加）
stackId=$(stackhero --format=script stack-create \
  --name="My Kafka stack")
echo "Stack created: ${stackId}"

# スタックにKafkaを追加（名前は自動解決されます）
serviceId=$(stackhero --format=script service-add \
  --stack="My Kafka stack" \
  --service-store="${serviceStore}" \
  --instance="${instance}" \
  --region="${region}")
echo "Service added: kafka"

# サービスが完全に起動するまで待機（数分かかる場合があります）
stackhero service-wait-for --service="kafka"

# サービスの構成を取得（生成された認証情報を含む）
stackhero service-configuration-get --service="kafka" --format=json

5. 認証情報の取得

service-configuration-getコマンドは、サービスの完全な構成（自動生成されたパスワードや接続情報を含む）を返します。出力はJSON形式なので、スクリプトや自動化で簡単に利用できます。

stackhero service-configuration-get --service=svc-xxxxxx --format=json

6. 構成の変更

構成スキーマの例を確認し、ご自身の設定を適用できます。構成を更新すると、必要に応じてサービスが再起動されます。

# サービスの構成スキーマと例を表示
stackhero service-configuration-example --service=svc-xxxxxx

# カスタム構成を適用（必要に応じてサービスが再起動）
stackhero service-configuration-set \
  --service=svc-xxxxxx \
  --configuration='{ "...": "..." }'

# 新しい構成が適用されるまで待機
stackhero service-wait-for --service=svc-xxxxxx

以上です。これで、サービスの起動、認証情報の取得、再構成まで、すべてスクリプトや自動化で完結できる一連の流れをご確認いただけました。さらに詳しく知りたい場合は、CLIの詳細ドキュメントもご参照ください。ここで紹介した非対話型STACKHERO_TOKEN認証についても解説しています。