Skip to content

docs: stop claiming the generated config reference covers policy keys #71

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
leifj merged 1 commit into from
Sep 28, 2026
Merged

docs: stop claiming the generated config reference covers policy keys #71

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
7 changes: 6 additions & 1 deletion docs/sirosid/trust/go-trust.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,12 @@ services:
## Configuration

:::tip Complete Configuration Reference
See the [generated configuration reference](/sirosid/trust/go-trust-configuration) for every YAML key, its type, description, and (where one exists) `GT_*` environment variable override — generated directly from the Go config structs, so it can't drift from what the code actually accepts.
See the [generated configuration reference](/sirosid/trust/go-trust-configuration) for each `server`, `logging`, `security` and `registries` key, its type, description, and (where one exists) `GT_*` environment variable override — generated directly from the Go config structs, so it can't drift from what the code actually accepts.

**It does not cover `policies`.** The generator does not descend into
`PolicyConfig`, so the whole policy key space renders as a single opaque row,
`policies.policies · map[string]*PolicyConfig (object)`. For those keys, this
page and `example/config.yaml` in the go-trust repo are the references.
:::

### Basic Configuration
Expand Down
7 changes: 4 additions & 3 deletions docs/sirosid/trust/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ For production deployments, we recommend using **[Go-Trust](./go-trust)** as a t

All configuration snippets on this page are Go-Trust `config.yaml` fragments.
Registries live under a single top-level `registries:` map; per-role
constraints live under `policies:`. See the
[generated configuration reference](/sirosid/trust/go-trust-configuration) for
the authoritative key list.
constraints live under `policies:`. The
[generated configuration reference](/sirosid/trust/go-trust-configuration) is
authoritative for registry keys; it does not expand `policies`, so for those see
[Policy-Based Trust Decisions](./go-trust#policy-based-trust-decisions).
:::

## Why Trust Matters
Expand Down
Loading