Skip to content

docs: correct security boundaries and runtime guidance - #5331

Merged
alangou merged 12 commits into
mainfrom
docs/security-documentation-consistency/alangou
Nov 9, 2026
Merged

alangou merged 12 commits into
mainfrom
docs/security-documentation-consistency/alangou

Conversation

@alangou

@alangou alangou commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Correct security documentation that describes retired runtime behavior or presents conditional guarantees as universal. The changes were checked against the implementation at 11fa5f09 and the corresponding hosted documentation.

Related Issue

None.

Changes

Each documentation topic has its own signed-off commit:

  1. Describe sandbox-channel authentication as server-authenticated TLS plus a sandbox JWT, including the diagram and transport direction.
  2. Document gateway-authorized supervisor takeover and its recovery limits; remove the Kubernetes README's unconditional single-point-of-failure claim.
  3. Distinguish sandbox-session JWTs from the shared supervisor-host assignment credential and clarify their lifecycle.
  4. Remove the claimed GPU promotion of /proc to read-write; describe the narrow thread-name exception.
  5. Distinguish workload placeholder delivery from explicitly enabled operator credential export, and qualify response handling.
  6. Describe workspace membership and roles alongside method/scope authorization, including the auth-only and Platform Admin exceptions.
  7. Replace the privileged supervisor/veth startup description with the current driver fence, non-root runtime admission, inherited mediation, and child hardening order.
  8. Clarify ordinary retained revisions, conditional fallback, and opted-in stable placeholders; align the related CLI and inference skills.
  9. Replace the policy-generation skill's retired inference set/get guidance with native provider access. Historical migration examples remain in place.
  10. Correct Kubernetes supervisor credential delivery: preissued bundles arrive through dedicated Secrets or shared assignments; distinguish the optional ServiceAccount bootstrap exchange and align the authentication diagram and Access Control page.
  11. Correct the OIDC role defaults and distinguish omitted configuration from explicitly empty role strings for auth-only mode.
  12. Replace absolute credential-visibility claims in the Pi tutorial and AWS guide with placeholder delivery and proxy-side use, linking to the response-handling limits.

Release Notes

Clarify security boundaries, supervisor recovery, credential rotation, and native inference guidance. No runtime behavior changes.

Testing

  • Checks appropriate to the affected code and behavior pass.
  • Unit tests added/updated — not applicable, documentation only.
  • E2E tests added/updated — not applicable, documentation only.

Validation performed:

  • markdownlint-cli2 0.22.0: 167 documentation files, zero errors.
  • Underlying mise run docs checks run directly because mise is unavailable: check_docs_nav.py passes; Fern 5.112.0 check --warnings reports zero errors.
  • Fern retains three existing warnings: gateway configuration MDX parsing, unauthenticated redirect checking, and light-theme accent contrast. None originates in a changed page or configuration.
  • All three modified skills pass quick_validate.py.
  • Rendered and visually reviewed the authentication SVG; no clipped labels.
  • Independently reviewed the changed claims against source. The bootstrap, OIDC-default, and Pi/AWS follow-ups each received a separate final review against both the PR implementation and v0.1.7 source/hosted documentation; git diff --check passes.

Checklist

  • Follows Conventional Commits.
  • Commits are signed off (DCO).
  • Architecture docs updated.

Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Nov 6, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
Signed-off-by: Adrien Langou <alangou@nvidia.com>
@alangou
alangou marked this pull request as ready for review November 6, 2026 14:23
@alangou alangou added the area:docs Documentation and examples label Nov 6, 2026
@alangou alangou added topic:security Security issues area:runtime topic:documentation and removed area:docs Documentation and examples labels Nov 6, 2026 — with ChatGPT Codex Connector
@alangou
alangou enabled auto-merge November 6, 2026 14:46
@alangou
alangou added this pull request to the merge queue Nov 9, 2026
Merged via the queue into main with commit 9525bec Nov 9, 2026
94 of 99 checks passed
@alangou
alangou deleted the docs/security-documentation-consistency/alangou branch November 9, 2026 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants