-
Notifications
You must be signed in to change notification settings - Fork 8.3k
sbx: restructure governance docs and add API reference #25162
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.
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
Draft
dvdksn
wants to merge
1
commit into
docker:main
Choose a base branch
from
dvdksn:sbx/governance-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: Governance | ||
| weight: 55 | ||
| description: Control what sandboxes can access, from local developer rules to org-wide enforcement. | ||
| keywords: docker sandboxes, governance, policy, network access, filesystem access, organization policy | ||
| --- | ||
|
|
||
| Sandbox governance covers the policy system that controls what sandboxes can | ||
| access over the network and on the filesystem. It operates at two layers that | ||
| build on each other: | ||
|
|
||
| **Local policy** is configured per machine using the `sbx policy` CLI. It | ||
| lets individual developers customize which domains their sandboxes can reach. | ||
| See [Local policy](local.md). | ||
|
|
||
| **Organization policy** is configured centrally in the Docker Admin Console or | ||
| via the [Governance API](api.md). Rules defined at the org level apply | ||
| uniformly across every sandbox in the organization and take precedence over | ||
| local rules. Admins can optionally delegate specific rule types back to local | ||
| control so developers can extend the org policy with additional allow rules. | ||
| See [Organization policy](org.md). | ||
|
|
||
| > [!NOTE] | ||
| > Organization governance is available on a separate paid subscription. | ||
| > [Contact Docker Sales](https://www.docker.com/products/ai-governance/#contact-sales) | ||
| > to request access. | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Policy concepts](concepts.md): resource model, rule syntax, evaluation, | ||
| and precedence | ||
| - [Local policy](local.md): configure network and filesystem rules on your | ||
| machine with the `sbx policy` CLI | ||
| - [Organization policy](org.md): centrally manage sandbox policies across | ||
| your organization from the Admin Console | ||
| - [Monitoring](monitoring.md): inspect active rules and monitor sandbox | ||
| network traffic with `sbx policy ls` and `sbx policy log` | ||
| - [API reference](api.md): manage org policies programmatically via the | ||
| Governance API | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[MEDIUM] Links to
api.mdwill fail — API reference lives atapi/index.md(leaf bundle)Multiple files in
content/manuals/ai/sandboxes/governance/link toapi.mdas a sibling file:No sibling
api.mdfile exists — the API reference is a leaf bundle atgovernance/api/index.md. Hugo link checking will report these as broken links. Change the links toapi/(orapi/index.md) to correctly point at the bundle's index page.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the link resolves correctly it seems, but that's just luck. Agree that we should link to the actual file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right that Hugo is likely resolving it — Hugo's link resolver is forgiving and will often find the target even with imprecise paths. But as you noted, relying on that is fragile. Using
api/(orapi/index.md) makes the intent explicit and ensures the link works predictably across different contexts (ref lookups, relrefs, etc.).Thanks for confirming the fix makes sense!