docs: add podConfig documentation for tolerations, nodeSelector, labels, and env#2196
docs: add podConfig documentation for tolerations, nodeSelector, labels, and env#2196kaovilai wants to merge 1 commit into
Conversation
WalkthroughAdds dedicated documentation for the DataProtectionApplication ChangespodConfig documentation + cross-references
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 12✅ Passed checks (12 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kaovilai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
Bot
added
the
approved
kaovilai
force-pushed
the
docs-podconfig-tolerations-nodeselector
branch
from
3200692 to
416e7d8
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/config/pod_config.md`:
- Around line 9-18: Update the fenced code blocks to include a language
specifier (e.g. "shell") for syntax highlighting: add ```shell before the block
containing "oc explain
dataprotectionapplication.spec.configuration.velero.podConfig" and the "oc
explain dataprotectionapplication.spec.configuration.nodeAgent.podConfig" lines,
and likewise add ```shell before the block containing "oc get crd
dataprotectionapplications.oadp.openshift.io -o yaml", closing each block with
``` as currently present; ensure no other text is added or removed in the
command lines so only the fence headers change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 3f1d4db3-7d93-4316-9ce4-69f6010301d1
📒 Files selected for processing (2)
docs/config/pod_config.mddocs/config/resource_req_limits.md
| ``` | ||
| oc explain dataprotectionapplication.spec.configuration.velero.podConfig | ||
| oc explain dataprotectionapplication.spec.configuration.nodeAgent.podConfig | ||
| ``` | ||
|
|
||
| The full CRD schema can also be inspected with: | ||
|
|
||
| ``` | ||
| oc get crd dataprotectionapplications.oadp.openshift.io -o yaml | ||
| ``` |
There was a problem hiding this comment.
Add language specifiers to fenced code blocks.
The code blocks showing oc commands should specify a language identifier for better syntax highlighting and to comply with markdown best practices.
📝 Proposed fix
-```
+```shell
oc explain dataprotectionapplication.spec.configuration.velero.podConfig
oc explain dataprotectionapplication.spec.configuration.nodeAgent.podConfigThe full CRD schema can also be inspected with:
- +shell
oc get crd dataprotectionapplications.oadp.openshift.io -o yaml
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` | |
| oc explain dataprotectionapplication.spec.configuration.velero.podConfig | |
| oc explain dataprotectionapplication.spec.configuration.nodeAgent.podConfig | |
| ``` | |
| The full CRD schema can also be inspected with: | |
| ``` | |
| oc get crd dataprotectionapplications.oadp.openshift.io -o yaml | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 16-16: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/config/pod_config.md` around lines 9 - 18, Update the fenced code blocks
to include a language specifier (e.g. "shell") for syntax highlighting: add
```shell before the block containing "oc explain
dataprotectionapplication.spec.configuration.velero.podConfig" and the "oc
explain dataprotectionapplication.spec.configuration.nodeAgent.podConfig" lines,
and likewise add ```shell before the block containing "oc get crd
dataprotectionapplications.oadp.openshift.io -o yaml", closing each block with
``` as currently present; ensure no other text is added or removed in the
command lines so only the fence headers change.
There was a problem hiding this comment.
Pull request overview
Adds new end-user documentation for the podConfig section of the DataProtectionApplication (DPA) CR, to make supported scheduling/runtime customization options (notably tolerations/nodeSelector) more discoverable and reduce misconfiguration.
Changes:
- Added
docs/config/pod_config.mddocumentingpodConfigusage and common misconfiguration patterns. - Added a cross-reference from
docs/config/resource_req_limits.mdto the newpodConfigdocumentation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/config/resource_req_limits.md | Adds a short pointer to the broader podConfig documentation. |
| docs/config/pod_config.md | Introduces new podConfig documentation with examples and a misconfiguration table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| ### Available Fields | ||
|
|
||
| | Field | Type | Description | |
| effect: "NoSchedule" | ||
| velero: | ||
| defaultPlugins: | ||
| - openshift |
kaovilai
force-pushed
the
docs-podconfig-tolerations-nodeselector
branch
2 times, most recently
from
c08818c to
5f2eb3d
Compare
…ls, and env Adds comprehensive documentation for all podConfig fields available under spec.configuration.velero and spec.configuration.nodeAgent in the DPA CR. This addresses confusion where users attempt to set tolerations directly under nodeAgent instead of under nodeAgent.podConfig, and clarifies that unsupportedOverrides is for image overrides only. Also adds a cross-reference from the existing resource_req_limits.md doc. Relates: OADP-7829 Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering> Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>
kaovilai
force-pushed
the
docs-podconfig-tolerations-nodeselector
branch
from
5f2eb3d to
788fdaf
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (3)
docs/TROUBLESHOOTING.md (3)
326-328: ⚡ Quick winAdd language specifier to the CRD inspection command.
The code block should specify
shellas the language identifier for proper syntax highlighting.📝 Proposed fix
-``` +```shell oc get crd dataprotectionapplications.oadp.openshift.io -o yaml</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/TROUBLESHOOTING.mdaround lines 326 - 328, Update the fenced code block
that contains the command "oc get crd
dataprotectionapplications.oadp.openshift.io -o yaml" in docs/TROUBLESHOOTING.md
to include the language specifier by changing the opening fence from ``` tothe command text are needed.
318-322: ⚡ Quick winAdd language specifier to the command code block.
The code block showing
oc explaincommands should specifyshellas the language identifier for proper syntax highlighting.📝 Proposed fix
-``` +```shell oc explain dataprotectionapplication.spec.configuration.nodeAgent oc explain dataprotectionapplication.spec.configuration.nodeAgent.podConfig oc explain dataprotectionapplication.spec.configuration.velero</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/TROUBLESHOOTING.mdaround lines 318 - 322, Update the fenced code block
that contains the three oc explain commands (oc explain
dataprotectionapplication.spec.configuration.nodeAgent, oc explain
dataprotectionapplication.spec.configuration.nodeAgent.podConfig, oc explain
dataprotectionapplication.spec.configuration.velero) to include the shell
language specifier (```shell) at the opening fence so the block becomes a
shell-highlighted code block; leave the closing fence unchanged.</details> --- `312-314`: _⚡ Quick win_ **Add language specifier to the warning example code block.** The code block showing the warning message should specify a language identifier for better rendering and markdown compliance. <details> <summary>📝 Proposed fix</summary> ```diff -``` +```text Warning: unknown field "spec.configuration.nodeAgent.<fieldName>" ``` ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/TROUBLESHOOTING.mdaround lines 312 - 314, Update the example code
block that contains the warning message Warning: unknown field
"spec.configuration.nodeAgent." to include a language specifier
(e.g., change the fenced block fromtotext) so the markdown renders
correctly; locate the fenced block with that exact warning string and add the
language identifier at the opening fence.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.Nitpick comments:
In@docs/TROUBLESHOOTING.md:
- Around line 326-328: Update the fenced code block that contains the command
"oc get crd dataprotectionapplications.oadp.openshift.io -o yaml" in
docs/TROUBLESHOOTING.md to include the language specifier by changing the
opening fence fromtoshell so the block becomes a shell-highlighted
snippet; no other changes to the command text are needed.- Around line 318-322: Update the fenced code block that contains the three oc
explain commands (oc explain
dataprotectionapplication.spec.configuration.nodeAgent, oc explain
dataprotectionapplication.spec.configuration.nodeAgent.podConfig, oc explain
dataprotectionapplication.spec.configuration.velero) to include the shell
language specifier (```shell) at the opening fence so the block becomes a
shell-highlighted code block; leave the closing fence unchanged.- Around line 312-314: Update the example code block that contains the warning
message Warning: unknown field "spec.configuration.nodeAgent." to
include a language specifier (e.g., change the fenced block fromtotext)
so the markdown renders correctly; locate the fenced block with that exact
warning string and add the language identifier at the opening fence.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Repository: openshift/coderabbit/.coderabbit.yaml **Review profile**: CHILL **Plan**: Enterprise **Run ID**: `fa9d38a2-a631-4770-aae9-2ac09af68c26` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 416e7d8299d9d5ff33ec01327aa9a887e058709c and 788fdaf582f97dadd8ead9239e7f89c7679cd1f9. </details> <details> <summary>📒 Files selected for processing (3)</summary> * `docs/TROUBLESHOOTING.md` * `docs/config/pod_config.md` * `docs/config/resource_req_limits.md` </details> <details> <summary>✅ Files skipped from review due to trivial changes (1)</summary> * docs/config/resource_req_limits.md </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
|
@kaovilai: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
/lgtm |
Summary
docs/config/pod_config.mdcovering allpodConfigfields: tolerations, nodeSelector, resourceAllocations, labels, and envdocs/config/resource_req_limits.mdnodeAgentorveleroinstead of underpodConfigunsupportedOverridesis for image overrides onlyMotivation
Support case [04410122] / OADP-7829 — customer could not configure tolerations for node-agent DaemonSet because they used incorrect YAML path (
spec.configuration.nodeAgent.tolerationsinstead ofspec.configuration.nodeAgent.podConfig.tolerations). Both the customer and the support engineer were unaware that tolerations are already supported. The Red Hat PodConfig API docs list the field but lack examples specific to nodeAgent tolerations. This doc makes the correct paths discoverable with concrete examples.Test plan
oc explaincommands shown in the doc work on a cluster with OADP installed🤖 Generated with Claude Code
Summary by CodeRabbit