Repository navigation
feat: add capsule proxy scope documentation - #183
Merged
oliverbaehler merged 3 commits intoNov 9, 2026
Merged
Conversation
Signed-off-by: Oliver Baehler <oliver@sudo-i.net>
… feat/proxy-scopes
Signed-off-by: Oliver Baehler <oliver@sudo-i.net>
✅ Deploy Preview for docs-projectcapsule ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The proxy deployment recipe relies on an unsupported release mode, and the API reference omits the newly documented ingress class fields and constraints.
1 open issue
What changed in this PR
This documentation update expands Capsule Proxy user-scope guidance and documents namespace-level class policies within Capsule’s existing rule system.
Changes:
- Explain proxy identity eligibility, administrator exclusions, RoleBinding reflection, and global-only deployment.
- Document Ingress/Gateway class mutation and enforcement, plus DeviceClass defaults and restrictions.
- Extend API references, cross-links, and the tenant security baseline for DRA administrative access.
| File | Description |
|---|---|
content/en/docs/tenants/enforcement.md |
Connect Tenant-wide restrictions to namespace class rules. |
content/en/docs/rules/mutate/ingress.md |
Document class defaults, replacement, and admission scope. |
content/en/docs/rules/mutate/devices.md |
Add DeviceClass defaulting guidance and examples. |
content/en/docs/rules/mutate/_index.md |
Summarize class mutation behavior. |
content/en/docs/rules/enforcement/network.md |
Add Ingress and Gateway class enforcement guidance. |
content/en/docs/rules/enforcement/devices.md |
Add DeviceClass matching, scope, and security guidance. |
content/en/docs/rules/enforcement/_index.md |
Link device policies and clarify audit behavior. |
content/en/docs/rules/_index.md |
Extend rule scope and condition documentation. |
content/en/docs/reference.md |
Add device and storage-class API fields. |
content/en/docs/proxy/setup/options.md |
Document identity and reflection configuration options. |
content/en/docs/proxy/setup/installation.md |
Explain user eligibility and global-only setup. |
content/en/docs/proxy/proxysettings.md |
Clarify subject eligibility and link user-scope guidance. |
content/en/docs/operating/best-practices/tenants.yaml |
Add a rule denying the DRA administrative-access label. |
content/en/docs/operating/best-practices/tenants.md |
Explain DRA administrative-access safeguards. |
content/dictionary.txt |
Add terminology used by the new documentation. |
Review effort: Balanced
Comment on lines
+295
to
+297
| To allow authenticated subjects to use matching `GlobalProxySettings` without | ||
| making them Capsule users, set | ||
| `--require-capsule-user=false` and `--feature-gates=ProxyClusterScoped=true`. |
Svarrogh1337
approved these changes
Nov 5, 2026
oliverbaehler
merged commit Nov 9, 2026
5881cb2
into
projectcapsule:release/0.16
10 of 12 checks passed
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.
No description provided.