Skip to content

docs(self-managed): document Helm resource enforcement - #1936

Draft
sbaum1994 wants to merge 1 commit into
mainfrom
docs/helm-resource-limit-upgrades
Draft

sbaum1994 wants to merge 1 commit into
mainfrom
docs/helm-resource-limit-upgrades

Conversation

@sbaum1994

@sbaum1994 sbaum1994 commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

TL;DR

Document NVCA Helm workload resource-limit enforcement before self-managed
stack upgrades activate it. The guide covers required chart changes, the
temporary compatibility override, and post-upgrade verification.

Additional Details

Why

Self-managed stack upgrades can begin rejecting existing Helm function and
task charts that omit CPU or memory limits. Operators need the release
boundaries and remediation steps before updating their compute plane.

What changed

  • Documented the NVCA and stack release boundaries that introduced and enabled
    Helm workload resource-limit enforcement.
  • Required CPU and memory limits on every regular container and init container
    rendered by Helm function and task charts.
  • Added the exact negative feature-gate overrides for temporary compatibility.
  • Clarified that disabling HelmResourceConstraints does not disable these
    checks.
  • Added compute-plane render, apply, rollout, and feature-gate verification
    commands.

Customer Release Notes

Documents Helm workload resource requirements and a temporary compatibility
override for self-managed compute-plane upgrades.

Plan Summary

No cluster resources change in this PR. The guide documents existing NVCA and
compute-plane stack behavior.

Usage

Update Helm workload charts before upgrading. Use the negative feature-gate
overrides only when a legacy chart cannot be updated before the upgrade, then
remove the overrides after adding resource limits.

Testing

Notes

  • This PR updates only the current cluster configuration page.
  • The v0.6.1 release notes are unchanged.

References

Related Pull Requests

Dependencies

None.

For the Reviewer

Review the version boundaries, feature-gate semantics, and compute-plane
verification commands.

For QA

No additional QA is needed. This PR changes documentation only, and the
behavior is covered by the BDD scenarios in #1890.

Issues

Closes #1888

Checklist

  • I am familiar with the Contributing Guidelines.
  • I have signed off my commits for Developer Certificate of Origin (DCO)
    compliance.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Added guidance for enforcing CPU and memory limits on Helm workloads.
    • Documented default enforcement behavior for supported self-managed NVCF and compute-plane versions.
    • Clarified that upgrading NVCA alone does not enable enforcement.
    • Added troubleshooting guidance for workloads missing required limits, including temporary legacy-chart overrides.
    • Added commands and verification steps for rendering, applying, rolling out, and checking feature-gate settings.

Warn operators before stack upgrades activate the NVCA validating webhook. Document required chart limits, temporary negative feature-gate overrides, and post-rollout verification.

Refs: #1888
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@sbaum1994
sbaum1994 requested a review from a team as a code owner September 16, 2026 08:22
@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 87fd9ea3-345b-4559-aacf-5ca243b7fdff

📥 Commits

Reviewing files that changed from the base of the PR and between b046d4a and 0c3d0e1.

📒 Files selected for processing (1)
  • docs/user/cluster-management/configuration.md

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Walkthrough

Walkthrough

The cluster configuration documentation now describes Helm CPU and memory limit enforcement, temporary feature-gate overrides, and compute-plane commands for applying and verifying these settings.

Changes

Helm resource-limit enforcement

Layer / File(s) Summary
Enforcement requirements
docs/user/cluster-management/configuration.md
Documents version boundaries, independent function and task gates, required CPU and memory limits for regular and init containers, and webhook rejection when limits are missing.
Compatibility and verification
docs/user/cluster-management/configuration.md
Documents temporary negative gate overrides, clarifies that HelmResourceConstraints is separate, and adds compute-plane rollout and effective-gate verification commands.

Priority: ➖ Normal

Estimated code review effort: 1 (Trivial) | ~8 minutes

Change: Other · Severity of issue fixed: Medium

Merge Risk: ⚪ Minimal · up to 0c3d0

No actionable risk is currently established for this documentation-only change.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The reported documentation update addresses the enforcement boundaries, container limits, negative feature-gate overrides, HelmResourceConstraints distinction, upgrade workflow, rollout checks, and … Update the applicable versioned upgrade or release-note page. Add the required Gherkin scenario under tests/bdd/ and cover the default rejection behavior. Ensure success-path Helm fixtures declare CPU and memory limits.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title uses valid Conventional Commits syntax with the docs type and self-managed scope. The docs type accurately reflects this documentation-only change.
Out of Scope Changes check ✅ Passed The reported change is limited to docs/user/cluster-management/configuration.md. The documented release boundaries, resource-limit rules, feature-gate overrides, and upgrade verification steps direc…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

The reported documentation update addresses the enforcement boundaries, container limits, negative feature-gate overrides, HelmResourceConstraints distinction, upgrade workflow, rollout checks, and temporary-override guidance on the current configuration page. Issue #1888 also requires an applicable versioned upgrade or release-note page, at least one tests/bdd enforcement scenario, and compliant Helm fixture coverage. The PR evidence reports only docs/user/cluster-management/configuration.md with documentation changes and no BDD or fixture changes. Those requirements are not met.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/helm-resource-limit-upgrades

Warning

Git: CodeRabbit could not clone the repository, so clone-backed analysis was skipped and this review may be incomplete. Verify repository clone access, such as SSH credentials, before requesting another full review. If clone access is intentionally unavailable, use path_filters to narrow the review scope.


Comment @coderabbitai help to get the list of available commands.

@sbaum1994
sbaum1994 marked this pull request as draft September 16, 2026 08:24
@github-actions

Copy link
Copy Markdown
Contributor

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.

docs(self-managed): document NVCA Helm resource-limit enforcement during upgrades

1 participant