Skip to content

docs: use one canonical name for the config-authored boot shape#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Aug 18, 2026
+2 −2
Merged

docs: use one canonical name for the config-authored boot shape #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/architecture.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,7 +118,7 @@ carries the exact contract for each.
|---|---|---|
| **Config-authored** | The shipped shape. Single app, evaluation, air-gapped, most production deployments | The runtime boots the metadata authored in the image, plus anything installed into it |
| **Artifact-pinned** | The app is released on its own cadence, separately from the runtime image | One variable names a published artifact by URL, with an optional integrity pin. Upgrading the app is a change to that variable plus a restart |
| **Composed** | Several organizations behind the isolation wall, sharing one database, running a published app | The same artifact reference, consumed from the deployment's own configuration so the enterprise plugins load alongside it. Air-gap licensed only |
| **Composed** | Several organizations behind the isolation wall, sharing one database, running a published app — the hosted single-app SaaS shape | The same artifact reference, consumed from the deployment's own configuration so the enterprise plugins load alongside it. Air-gap licensed only, and [refused at startup](/docs/deploy/air-gapped) otherwise |

Whether the deployment also talks to a **control plane** is a separate
decision, made by the cloud-posture variable — a connected deployment can be
Expand Down
2 changes: 1 addition & 1 deletion content/docs/deploy/index.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ available to you — it is not just a matter of packaging.

| Shape | The app comes from | Use it when |
|---|---|---|
| **Shipped runtime** | The image's own bundled application | A single-organization deployment; the default the Compose stack configures. |
| **Config-authored** | The image's own bundled application — the metadata authored in the image, plus anything installed into it | A single-organization deployment; the default the Compose stack configures, and the shape that needs no configuration. |
| **Artifact-pinned** | A published app artifact named by URL, resolved before any deployment config runs | You run one published app and want app upgrades to be an environment change and a restart, with no image rebuild. Note that the deployment's enterprise plugins do **not** load on this path. |
| **Composed** | A published app artifact composed *with* this deployment's enterprise plugins | Several organizations share one database. This is the hosted single-app SaaS shape — and it is **air-gap-licensed only**, enforced at startup. |

Expand Down
Loading