Skip to content

Takosumi software

Takosumi は、Git に置いた OpenTofu/Terraform module を、計画 → 確認 → 反映の流れで 安全にデプロイ・管理する基盤ソフトウェアです。普通の OpenTofu/Terraform module を そのまま実行でき、必要な場合は現在の takosumi_* Resource Shape 互換 surface を Target / Adapter に解決できます。採用済みの target では、portable な定義を Service Form、 exact identity を FormRef と呼び、Takosumi は Form Package が 0 個でも動く optional host です (用語のひとこと説明は 用語集 を参照)。

このページは、software としての Takosumi と Takosumi for Operator の docs です。 私たちが運営する公式 hosted service、Takosumi Cloud の docs は app.takosumi.com/docs に分けています。

どちらを読むか

読みたいこと読む場所
Takosumi の model、API、Run、StateVersion、Outputこの Software docs
self-host / operator が使う OpenTofu Stack flowQuickstartModel reference
Service Form host(現在の Resource Shape 互換 API)、Compatibility API framework、Adapter systemTakosumi APIModel reference
app.takosumi.com の managed resources、pricing、API key、usageTakosumi Cloud docs
Cloud の endpoint family、compatibility matrix、billing contractCloud resourcesCloud endpointsCloud pricing

Product split

text
Takosumi OSS:
  Git-based OpenTofu control plane
  + plain OpenTofu stack execution
  + optional zero-form Service Form host
  + current Resource Shape compatibility API
  + Resolver / Planner / Reconciler
  + Target / Credential / OIDC / Secret / Policy
  + Compatibility API framework
  + Adapter system

Takosumi for Operator:
  Takosumi
  + customer / tenant operation
  + billing / metering / quota
  + DB-backed operator configuration
  + CLI / API / runbook operations
  + managed target catalog

Takosumi Cloud:
  official hosted Takosumi for Operator
  + official managed targets
  + Cloud-operated managed service backends
  + official billing / SLA / support

境界は次のとおりです。

text
portable project は Service Form / FormRef / Form Package / typed client conformance を持つ。
Takosumi OSS は generic host lifecycle と API を持つ。
Operator / Cloud は商用運用と managed capacity を持つ。

Cloud は Takosumi の本体ではなく、公式 hosted deployment です。Software docs では 任意の Takosumi endpoint、self-host、operator 運用でも成立する API と model を説明します。 Cloud docs では app.takosumi.com の managed resources、pricing、spend guard、 Cloud endpoint を説明します。

Takosumi が管理すること

Takosumi は OpenTofu/Terraform の外側を管理します。

text
Git repo / Source を登録する
ProviderConnection を保存する
CredentialRecipe に従って Run の実行中だけ env/file を渡す
OpenTofu/Terraform を runner sandbox で実行する
plan / apply / destroy を Run として記録する
StateVersion / Output / log / AuditEvent を保存する
exact Service Form-backed Resource を TargetPool / Policy / Adapter に解決する

中心にある価値はこれです。

text
Same manifest, different connection.
Same form, different target.

同じ .tf を使い、ProviderBinding だけを変えて dev/prod、別 account、別 provider alias に流せます。同じ exact Service Form を使い、TargetPool / Policy / Adapter によって operator が有効化した target へ解決できます。現在の wire/provider/state では、この flow を Resource Shape と呼びます。

作り直さないもの

業界標準の API / protocol / OpenTofu provider で足りるものを、 Takosumi は作り直しません。

text
標準 API / protocol / OpenTofu provider がある:
  その surface を Stack flow または scoped compatibility profile で使う。

標準 surface がなく、繰り返し使う service form がある:
  portable governance を通した typed Service Form として定義する。

一回限りの不足:
  generic-env ProviderConnection と通常の OpenTofu module で扱う。

takosumi/takosumi provider は Takosumi を使うための必須入口ではありません。 既存 provider が十分なら Stack flow でそのまま使います。現在の Takosumi provider は supported Resource Shape compatibility state と operator/admin object を維持します。新しい typed Service Form client の authority は、state migration 後に独立 provider へ移ります。

Compatibility API

Compatibility API は OSS Takosumi の framework と capability surface です。 compat.s3.v1compat.oci.v1compat.cloudevents.v1compat.cloudflare.workers.v1 のように scope と version を明示します。

これらは full AWS API compatibility や full Cloudflare API compatibility ではありません。 普通の S3/R2/GCS、registry、queue、database 利用で既存 provider や標準 endpoint が 足りる場合は、それを使います。

画面で使う言葉

通常画面では、内部 model をそのまま前面に出しません。

画面の言葉意味
サービスホストするアプリ、worker、API、site、storage など
接続Cloudflare / AWS / GCP などのアカウント連携
変更内容deploy 前に確認する plan / resource summary
履歴いつ誰が何を変更したか
Restore pointstate version を使った復元点

ほかの用語のひとこと説明は 用語集 に、詳細は Model reference にあります。 外部の web / desktop / mobile / CLI からサービス作成へつなぐ場合は App Handoff Protocol を使います。

Docs の境界

公開 docs は、ユーザー、self-host operator、Takosumi Cloud 利用者が外部 contract として 依存できる情報だけを扱います。内部メモ、operator runbook、secret rotation、raw readiness record、pricing 同期手順、implementation-only wiring は公開 product contract ではありません。

詳しい分類は Published docs contract に固定しています。

次に読むもの

AGPL-3.0-only