Skip to content

Glossary

One-line explanations of the words used across the Takosumi docs. See the Model reference for details.

Words used in the UI

Normal screens do not expose the internal model directly; they use these words instead.

UI wordInternal termMeaning
Service / AppCapsuleAn app, worker, API, site, storage, etc. that you host
ConnectionProviderConnection / ProviderBindingAn account link to Cloudflare / AWS / GCP and others
Changesplan (Run)The list of changes you review before applying
HistoryRun records / AuditEventWho changed what, and when
Restore pointStateVersionA saved state you can go back to

Core words

TermMeaning
TakosumiSoftware that deploys and manages OpenTofu/Terraform modules from Git through a plan → review → apply flow.
OpenTofuAn open-source tool (Terraform-compatible) for defining infrastructure as code. Takosumi is the side that runs it.
WorkspaceThe boundary for a user or team. Projects, connections, secrets, and history are isolated inside it.
ProjectOne product, service, or infrastructure group inside a Workspace.
CapsuleOne OpenTofu/Terraform module execution unit, usually sourced from a Git URL + ref + path.
SourceWhere a Capsule comes from: Git URL / branch / commit / directory.
RunThe record of one execution. Operations such as plan / apply / destroy are stored with logs, results, and the actor.
plan / apply / destroyplan computes and shows what will change, apply makes the change, destroy removes resources. Each is recorded as a Run.
StateVersionThe state version saved on every apply. Usable as a restore point.
OutputAn ordinary root-module return value captured via tofu output -json. It may feed another Capsule's OpenTofu input or an explicit Interface input mapping.
InterfaceA versioned, non-secret declaration of a deployed runtime. Service-side configuration explicitly maps any required public Output name.
InterfaceBindingRuntime authorization that gives a Principal, ServiceAccount, Capsule, or Resource permissions and a credential-delivery method.
SecretAn encrypted stored value. Write-only through the API and redacted from logs.
RunnerThe isolated execution environment (sandbox) that actually runs OpenTofu.
AuditEventThe audit record of who did what to which target.
OperatorThe organization or person running Takosumi for themselves or their own users.

Connection and credential words

TermMeaning
ProviderConnectionSafely stored credentials for a provider such as Cloudflare or AWS. Passed as env vars or files only while a Run executes.
CredentialRecipeThe definition of env vars, files, and pre-run actions needed to run that provider.
ProviderBindingThe mapping "this provider in this Capsule uses this connection". Unbound providers are never silently filled in; they stop safely.

Service Form host words

These only appear when you use the typed service lifecycle. If you only run plain OpenTofu modules, you can skip them. Service Form is the adopted target concept. The current /v1/resources, takosumi_* provider, and state retain the Resource Shape compatibility name. Exact FormRef additive persistence is implemented, but the alias remains until live migration/rollback evidence and the compatibility-removal gate are complete.

TermMeaning
Service FormA portable, implementation-independent service definition, such as "I want one object store".
FormRefThe exact immutable identity: apiVersion, kind, definitionVersion, and schemaDigest. Resource and ResolutionLock pin it beside the package digest in additive columns.
Form Package / Form RegistryA signed data-only definition bundle and the trusted package pins installed on one host. Packages contain no executable code, credentials, price, or capacity.
Resource ShapeThe compatibility name used by the current API/provider/state for a Service Form-backed Resource.
FormActivationA generic OSS operator record exposing an exact FormRef to an audience/policy scope. It contains no price, payment, official capacity, or SLA.
ServiceOfferingA closed Cloud/operator record officially binding an exact FormRef, activation, implementation, target/region, SKU, price, quota, and support.
Target / TargetPoolWhere a Resource resolves: the operator-enabled candidates and their pools.
PolicyThe rules for which Resource may resolve where.
AdapterThe trusted host implementation that turns a Resource into a real resource.
ResolutionLockThe record that pins an exact form / implementation / Target decision.
NativeResourceThe record of the real resource created by a resolution.
Space / Environment / StackThe Resource API namespace, environment (dev/prod, etc.), and grouping units.
Compatibility APIA compatibility API with an explicit scope and version, like compat.s3.v1. Not full AWS or Cloudflare compatibility.

AGPL-3.0-only