docs(policy): refresh policy documentation and references - #3563
Merged
Merged
Conversation
johnnygreco
requested review from
a team,
derekwaynecarr,
mrunalp and
sjenning
as code owners
September 22, 2026 19:42
|
🌿 Preview your docs: https://nvidia-preview-pr-3563.docs.buildwithfern.com/openshell |
johnnygreco
force-pushed
the
johnny/policy-documentation-rewrite
branch
from
September 24, 2026 16:05
c941bac to
756d842
Compare
This was referenced Sep 25, 2026
Collaborator
Author
|
/ok to test 01f0966 |
7 tasks
johnnygreco
added a commit
that referenced
this pull request
Sep 25, 2026
The policy documentation rewrite (#3563) makes the same change to the GitHub tutorial's log command and sample line. Restore the tutorial here so the two pull requests do not conflict. Signed-off-by: Johnny Greco <jogreco@nvidia.com>
pimlock
reviewed
Sep 25, 2026
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
…r own page Signed-off-by: Johnny Greco <jogreco@nvidia.com>
…mand reference Signed-off-by: Johnny Greco <jogreco@nvidia.com>
… guide Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
The first policy tutorial said the 403 body begins with error, policy, and rule, but the proxy serializes the body with sorted keys. Its log samples also showed the wrong CONNECT deny reason for a sandbox without network rules, and the L7 deny sample omitted the :443 authority, the `l7` engine, and the reason tag that the shorthand formatter emits. The GitHub tutorial filtered denials with `--level warn`, which hides the INFO level OCSF policy events, and showed the retired key=value log format. Its hand-written policy also omitted /bin from the restrictive default, so `policy set` would reject the file for removing a filesystem path on a live sandbox. Start from `policy get --base` and add only the network rules. Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
6 tasks
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
johnnygreco
force-pushed
the
johnny/policy-documentation-rewrite
branch
from
September 25, 2026 16:30
01f0966 to
379f55a
Compare
…tation-rewrite Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Collaborator
Author
|
/ok to test 823f132 |
pimlock
approved these changes
Sep 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructure the Policies section so it reads well top to bottom, from a high-level overview through network rules and CLI workflows to the prover, the advisor, and the references. Every behavioral claim is checked against current
main.Related Issue
No issue required: this is documentation maintenance for implemented behavior. It changes no production behavior or public API. Code issues found along the way are tracked separately, including #3698.
Changes
Structure (
docs/how-it-works/policies/, in nav order):Accuracy fixes, checked against the code and, where possible, by running the tools:
landlockrow.processsettings apply only on Docker and Podman.--binarylist must match the rule's binaries exactly;--add-allowexpands access presets into explicit rules;--remove-endpointleaves provider rules alone;policy_validation_failure_modeis a gateway config option;openshell-prover, and the unsupported-shape list is now complete.tls: skipfor clients that start TLS immediately, present client certificates, or use a protocol where the server sends first.policy.localand policy DNS.Rebase onto #3705's
how-it-workslayout:docs/how-it-works/policies/./prover,/advisor, and/schema.main(isolation-backends.mdx) and one broken anchor (kubernetes/ingress.mdx), with the same changes as docs: keep page URLs aligned with file paths #3713.Outside the section: pages that link into Policies now point to the new pages and no longer repeat the corrected claims. They are the tutorials, best practices, logging, inference, provider profiles, sandbox overview, and About overview. The first-policy tutorial now uses
openshell policy updateand shows current log output.Testing
mise run pre-commitpassesAlso verified:
mise run docsreports 0 errors and 3 existing warnings.npx --yes "fern-api@5.112.0" docs broken-linksreports "All checks passed". A separate check of every internal#anchorfinds no problems.mainat924486805.openshell-prover.Checklist