Quickstart

Takosumi には 2 つの入口があります。

Takosumi software:
  self-host / local / operator endpoint で OpenTofu control plane を確認する

Takosumi Cloud:
  app.takosumi.com の公式 hosted service と managed resources を使う

Software としての動きを確認する場合は、まず OSS / local runner から始めます。 公式 hosted service として使う場合は、後半の Takosumi Cloud flow を使います。

OSS / local runner

Takosumi OSS は既存の OpenTofu/Terraform provider をそのまま実行します。いちばん短い 確認の流れは、provider と credential を必要としない examples/opentofu-basic を Git Source として登録し、 通常の plan / apply / destroy と Output 記録を確認することです。provider を使う module では、その provider 自身が定める認証情報を ProviderConnection に登録します。

Prerequisites

• Bun
• OpenTofu CLI (tofu)
• Git
• 選んだ module が provider 認証を必要とする場合だけ、その credential

1. Start the service

cd takosumi
bun install

export TAKOSUMI_DEV_MODE=1
export TAKOSUMI_DEPLOY_CONTROL_TOKEN=dev-token
PORT=8788 bun core/index.ts

別 terminal:

export BASE=http://127.0.0.1:8788
export AUTH="Authorization: Bearer dev-token"

2. Add a Git URL in /new

標準の流れは dashboard の /new です。外部リンク /install?git=...&ref=...&path=... は /new に値を入れておくだけで、サーバー側で 勝手に install することはありません。

ユーザーは次の項目を自分で確認して進みます。

Git URL
compatibility check
ProviderConnection selection
plan result
apply approval

3. ProviderConnection (provider 認証が必要な場合)

Credential は .env や manifest に書かず、ProviderConnection に保存します。

takosumi connections create \
  --provider registry.opentofu.org/example/example \
  --recipe generic-env \
  --auth-mode env \
  --secret-partition provider-credentials \
  --values-file <path-to-provider-credential-env-json>

example/example は説明用の placeholder です。実際には module の required_providers と provider 公式ドキュメントに従って source と env/file 名を 指定します。値は Run の実行中だけ runner sandbox に渡されます。provider 名から credential schema や RunnerProfile を推測しません。

4. Result

Run が成功すると Takosumi は以下を保存します。

run log
plan/apply result
state version
outputs
audit event

この quickstart は OpenTofu Stack flow に絞っています。Compatibility API framework は OSS の機能ですが、公式の managed target pool、Takosumi 自社リソースの内部実装、 強制課金、support / SLA は Takosumi for Operator / Cloud の運用側にあります。

Hosted Cloud flow

公式 hosted service としての app.takosumi.com の使い方、managed resources、 pricing、API key、usage、spend guard は Takosumi Cloud docs に分けています。

Cloud でも software の基礎 model は同じですが、この quickstart では portable な Takosumi software / operator endpoint の動作だけを扱います。