Skip to content

docs: add priority class rules and mutation - #182

Merged
oliverbaehler merged 6 commits into
projectcapsule:release/0.16from
Svarrogh1337:docs/rules-priority-classes
Nov 9, 2026
Merged

oliverbaehler merged 6 commits into
projectcapsule:release/0.16from
Svarrogh1337:docs/rules-priority-classes

Conversation

@Svarrogh1337

Copy link
Copy Markdown
Member

This pull request introduces comprehensive documentation and example updates to support fine-grained enforcement and mutation of Kubernetes Pod priority classes within Capsule. It adds detailed explanations, configuration examples, and migration guidance for priority class policies, and updates related sample manifests and references accordingly.

Major documentation additions and updates:

Priority class policy enforcement:

  • Added an extensive new section on priority class enforcement to workloads.md, covering configuration, matching by name/regex/labels, audit/deny/allow actions, controller template handling, update behaviors, namespace profiles, and migration from legacy fields.
  • Updated workload enforcement tables, targets, and reference examples to include priority class policies alongside existing resource, placement, and security policies. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Mutation documentation:

  • Documented how classes.priority can be assigned via mutation in merge/replace modes, and updated property tables to include classes. [1] [2]

Example and sample manifest updates:

Tenant resource and status examples:

  • Updated example manifests and status blocks in global.md and tenant.md to remove legacy priority class fields and references, focusing on storage classes instead. [1] [2] [3]

Other related clarifications:

Update and enforcement behavior:

  • Clarified in rules/_index.md that priority class enforcement is reevaluated on updates only when allow/deny rules have conditions.

oliverbaehler and others added 2 commits November 5, 2026 08:20
Signed-off-by: Oliver Baehler <oliver@sudo-i.net>
Signed-off-by: Hristo Hristov <me@hhristov.info>
Copilot AI balanced review requested due to automatic review settings November 5, 2026 14:18
@netlify

netlify Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for docs-projectcapsule ready!

Name Link
🔨 Latest commit b365d26
🔍 Latest deploy log https://app.netlify.com/projects/docs-projectcapsule/deploys/6aed820eecf352e5860fb11b
😎 Deploy Preview https://deploy-preview-182--docs-projectcapsule.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The release note incorrectly says existing generators receive no entries, but templates using missingKey: error can fail reconciliation when status.classes.priority is absent and need migration or a missing-key guard.

1 open issue
What changed in this PR

This documentation update explains namespace-specific PriorityClass enforcement and mutation in Capsule, including migration from legacy Tenant settings.

Changes:

  • Documents PriorityClass matching, mutation, controller targets, and update behavior.
  • Adds configuration examples and guidance for combining legacy settings with namespace rules.
  • Updates release notes and replication examples for the removal of status.classes.priority.
File Description
content/​en/​docs/​whats-new.md Announces PriorityClass features and the status-field removal.
content/​en/​docs/​tenants/​enforcement.md Links legacy settings to new rules and migration guidance.
content/​en/​docs/​rules/​mutate/​workloads.md Documents PriorityClass assignment and merge/replace behavior.
content/​en/​docs/​rules/​mutate/​_index.md Adds class mutation semantics to shared guidance.
content/​en/​docs/​rules/​enforcement/​workloads.md Adds PriorityClass enforcement, targeting, and migration examples.
content/​en/​docs/​rules/​_index.md Clarifies conditional PriorityClass checks on updates.
content/​en/​docs/​replications/​tenant.md Removes the obsolete priority-class status example.
content/​en/​docs/​replications/​global.md Switches generated RBAC examples to storage classes and updates status.

Review effort: Balanced

Comment thread content/en/docs/whats-new.md Resolved
Signed-off-by: Hristo Hristov <me@hhristov.info>
Signed-off-by: Hristo Hristov <me@hhristov.info>
Signed-off-by: Hristo Hristov <me@hhristov.info>
@oliverbaehler
oliverbaehler changed the base branch from main to release/0.16 November 5, 2026 18:34
@oliverbaehler
oliverbaehler merged commit 906877e into projectcapsule:release/0.16 Nov 9, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants