クイックスタート
まず開発用 API を確認し、そのあと必要なら dashboard、サインイン、データベース、 OpenTofu runner を含むローカル環境を起動します。
開発用 API
必要なものは Bun と Git です。
git clone https://github.com/tako0614/takosumi.git
cd takosumi
bun install
TAKOSUMI_DEV_MODE=1 \
TAKOSUMI_DEPLOY_CONTROL_TOKEN=dev-token \
PORT=8788 \
bun core/index.ts別のターミナルで確認します。
curl http://127.0.0.1:8788/api/v1/capabilities \
-H "authorization: Bearer dev-token"JSON が返れば API は動いています。この構成はデータをメモリに置き、再起動すると消えます。 dashboard や runner も起動しないため、開発中の API 確認にだけ使ってください。
完全なローカル環境
ここからは Linux マシン上にローカルの Takosumi を立て、Git module の plan と apply を 実行します。初回はコンテナと dashboard をビルドするため時間がかかります。
必要なもの
- Linux。macOS、WSL、Windows はこの構成の対象外です
- Docker と
docker compose - Bun、Git、
curl、python3 - 証明書と DNS を設定するための
sudo
1. 環境を起動する
すでにリポジトリを取得している場合は、ルートから次を実行します。
cd deploy/local-substrate
bash scripts/up.sh --profile postgresこのコマンドは Postgres、オブジェクトストレージ、runner、control plane、dashboard、 ローカル認証局と DNS をまとめて起動します。既定の AppArmor 設定でコンテナを起動 できないホストでは、次を使います。
TAKOSUMI_LOCAL_SUBSTRATE_DISABLE_APPARMOR=1 \
bash scripts/up.sh --profile postgres2. ローカル証明書と DNS を設定する
sudo bash scripts/ca-install.sh
sudo bash scripts/configure-dns.shこの 2 つはホストごとに 1 回だけ実行します。ローカル認証局を作り直した場合は ca-install.sh をもう一度実行してください。
3. 起動を確認する
curl https://app.takosumi.test/healthz
curl https://app.takosumi.test/.well-known/openid-configuration/healthz が {"ok":true,"database":"ok"} を返せば、アプリから Postgres まで 接続できています。
4. サインインする
ブラウザで https://app.takosumi.test/ を開き、Local OIDC を選びます。これは ローカル確認用の ID provider なので、実在のアカウントは必要ありません。
5. サンプルを追加する
サインインしたまま、次の URL を開きます。
https://app.takosumi.test/install?git=https://github.com/tako0614/takosumi.git&ref=main&path=examples/opentofu-basic画面には Git URL、ref、module path が入力された状態で表示されます。リンクを開いただけ では作成されません。内容を確認して追加すると、Takosumi は ref を commit に固定し、 module の互換性を調べて plan を作ります。
このサンプルは provider を使わず、外部リソースも作りません。クラウドの認証情報なしで runner、plan、apply、state 保存まで確認できます。
インストール操作は、削除を含まず承認も不要な plan だけを apply まで続けるよう明示的に 要求します。削除、承認ポリシー、料金、その他の gate がある場合は Run 画面で停止します。 通常の更新、drift の検出、Git の新しい commit は勝手に apply されません。
6. 結果を見る
https://app.takosumi.test/runs で plan と apply の記録を確認します。Capsule の詳細には 適用後の state が版ごとに保存されます。
環境全体を検査する場合は、リポジトリ同梱の smoke test を使います。
TAKOSUMI_LOCAL_SUBSTRATE_PROFILE=postgres bash scripts/smoke.sh最後に 0 failed と表示されれば、サインイン、Run、保存先、DNS、TLS まで通っています。 失敗した検査のログは /tmp/smoke-logs/ に残ります。
7. 停止する
bash scripts/down.shPostgres のデータと証明書も消す場合は bash scripts/down.sh -v を使います。
次に読むもの
公式ホスティングを使う場合は Takosumi hosted service のドキュメントを参照してください。