Skip to content

docs: note that nodeAgent.loadAffinity also limits File System Backup - #2519

Draft
kaovilai wants to merge 1 commit into
openshift:oadp-devfrom
kaovilai:docs-nodeagent-loadaffinity-fsbackup
Draft

kaovilai wants to merge 1 commit into
openshift:oadp-devfrom
kaovilai:docs-nodeagent-loadaffinity-fsbackup

Conversation

@kaovilai

@kaovilai kaovilai commented Oct 25, 2026 •

Copy link
Copy Markdown
Member

Why the changes were made

OADP applies spec.configuration.nodeAgent.loadAffinity to the NodeAgent DaemonSet as well as to the data mover pods (internal/controller/nodeagent.go, ReconcileNodeAgentDaemonset). This is intended (see docs/design/DPA-and-node-selectors.md). Upstream Velero uses loadAffinity from the node-agent ConfigMap for data mover pods only, and does not change where node-agent runs.

The side effect is not documented: File System Backup (Kopia PodVolumeBackup/PodVolumeRestore) runs in the NodeAgent pod on the node of the workload pod. If loadAffinity selects a subset of nodes, pod volumes on other nodes cannot use File System Backup.

This adds a note to docs/scheduling_and_node_affinity.md that explains the difference from Velero and the File System Backup impact, and that per-StorageClass entries result in the union of all entries for the DaemonSet. No behavior change.

How found: live testing on OCP 5.1 EC. With nodeAgent.loadAffinity selecting one of three workers, node-agent ran on one worker only. Data mover backups/restores worked, but File System Backup could not run for pods on the other workers.

How to test the changes made

Docs only. Review the rendered docs/scheduling_and_node_affinity.md, section "b. Configure NodeAgent Load Affinity".

Note

Responses generated with Claude (model: Claude Opus 5.5)

Summary by CodeRabbit

  • Documentation
    • Clarified how node affinity applies to NodeAgent DaemonSet and DataMover pods, including its impact on File System Backups for workloads on non-matching nodes.
    • Explained that the DaemonSet runs across the combined node affinity requirements for all StorageClasses.

OADP applies nodeAgent.loadAffinity to the NodeAgent DaemonSet, unlike
upstream Velero which applies it to data mover pods only. Pod volumes on
nodes outside loadAffinity cannot use File System Backup.

Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>
Co-Authored-By: Claude Code (model: Claude Opus 5.5) <noreply@anthropic.com>
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Pipeline controller notification

This PR uses the pipeline controller for second-stage tests. Selection and triggering follow the repository configuration.

Use /test ? to list jobs and /pipeline help for commands.

@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 25, 2026
@openshift-ci

openshift-ci Bot commented Oct 25, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Central YAML; Path: .coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 4e1986ef-7e0d-48bd-a4ec-9752b593546c
Commits

Reviewing files that changed from the base of the PR and between 1612be0 and 4ef633a.

Files selected for processing: 1
  • docs/scheduling_and_node_affinity.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 9 remain after this review.

Walkthrough

The scheduling guide now explains that OADP applies nodeAgent.loadAffinity to both NodeAgent and DataMover pods. It also describes the resulting File System Backup limitation and how per-StorageClass affinity entries affect DaemonSet placement.

Changes

Node affinity documentation

Layer / File(s) Summary
Document OADP affinity behavior
docs/scheduling_and_node_affinity.md
The guide distinguishes OADP’s affinity behavior from upstream Velero. It states that File System Backup cannot back up or restore volumes on excluded nodes and that DaemonSet placement uses the union of per-StorageClass affinity entries.

Priority: Low

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

Change: Other

Merge Risk: Minimal · up to 4ef63

The documentation update is mergeable as described.

Pre-merge checks: Passed 15
Check name Status Explanation
Title check Passed The title names the main change: a documentation note that nodeAgent.loadAffinity also limits File System Backup. The raw summary and PR objectives confirm the change is a docs-only addition to docs/s…
Description check Passed The description follows the repository template. It has a 'Why the changes were made' section that explains the OADP behavior, the Velero difference, the File System Backup impact, and the test eviden…
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…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names Passed The pull request changes only docs/scheduling_and_node_affinity.md. The two added lines are documentation text; they add no Ginkgo test titles or test code. Therefore, the check has no applicable fa…
Test Structure And Quality Passed The pull request changes only docs/scheduling_and_node_affinity.md. It adds documentation and no Ginkgo test code or It() blocks. Therefore the listed test-structure requirements do not apply.
Microshift Test Compatibility Passed PASS: The pull request changes only docs/scheduling_and_node_affinity.md (+2 lines). It adds no Ginkgo e2e tests or test code, so the MicroShift test compatibility check does not apply.
Single Node Openshift (Sno) Test Compatibility Passed The pull request changes only docs/scheduling_and_node_affinity.md. It adds documentation about nodeAgent.loadAffinity; it adds no Ginkgo e2e tests or test code that could assume a multi-node clus…
Topology-Aware Scheduling Compatibility Passed The pull request changes only docs/scheduling_and_node_affinity.md. It adds documentation about existing nodeAgent.loadAffinity behavior and introduces no deployment manifest, operator code, contr…
Ote Binary Stdout Contract Passed PASS: The pull request changes only docs/scheduling_and_node_affinity.md. It adds documentation and introduces no executable OTE binary code or process-level stdout writes.
Ipv6 And Disconnected Network Test Compatibility Passed The pull request changes only docs/scheduling_and_node_affinity.md. It adds documentation and no Ginkgo e2e tests, IPv4 assumptions, or external connectivity requirements.
No-Weak-Crypto Passed PASS. The PR changes only docs/scheduling_and_node_affinity.md and adds a scheduling/File System Backup note. The added text introduces no MD5, SHA-1, DES, RC4, 3DES, Blowfish, ECB usage, custom cry…
Container-Privileges Passed The pull request changes only docs/scheduling_and_node_affinity.md. The added text documents node affinity and File System Backup behavior. It does not add or modify a container or Kubernetes manife…
No-Sensitive-Data-In-Logs Passed PASS — The pull request changes only docs/scheduling_and_node_affinity.md. The added documentation contains configuration guidance and workload-placement behavior. It adds no logging or sensitive da…
Full details: Title check

Explanation

The title names the main change: a documentation note that nodeAgent.loadAffinity also limits File System Backup. The raw summary and PR objectives confirm the change is a docs-only addition to docs/scheduling_and_node_affinity.md describing this effect, so the title matches the changeset.

Full details: Description check

Explanation

The description follows the repository template. It has a 'Why the changes were made' section that explains the OADP behavior, the Velero difference, the File System Backup impact, and the test evidence. It has a 'How to test the changes made' section that says to review the rendered docs section 'b. Configure NodeAgent Load Affinity'. The template asks for commands and pictures in the testing section, and this docs-only change has none, which is acceptable here. It links code and design references but no issue number, so the 'link related issues' item is not addressed. These are minor gaps.

Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

Full details: Stable And Deterministic Test Names

Explanation

The pull request changes only docs/scheduling_and_node_affinity.md. The two added lines are documentation text; they add no Ginkgo test titles or test code. Therefore, the check has no applicable failure.

Full details: Single Node Openshift (Sno) Test Compatibility

Explanation

The pull request changes only docs/scheduling_and_node_affinity.md. It adds documentation about nodeAgent.loadAffinity; it adds no Ginkgo e2e tests or test code that could assume a multi-node cluster.

Full details: Topology-Aware Scheduling Compatibility

Explanation

The pull request changes only docs/scheduling_and_node_affinity.md. It adds documentation about existing nodeAgent.loadAffinity behavior and introduces no deployment manifest, operator code, controller, replica, affinity, topology spread, selector, or PDB change. The topology-aware scheduling check is therefore not applicable.

Full details: No-Weak-Crypto

Explanation

PASS. The PR changes only docs/scheduling_and_node_affinity.md and adds a scheduling/File System Backup note. The added text introduces no MD5, SHA-1, DES, RC4, 3DES, Blowfish, ECB usage, custom cryptography, or secret/token comparison.

Full details: Container-Privileges

Explanation

The pull request changes only docs/scheduling_and_node_affinity.md. The added text documents node affinity and File System Backup behavior. It does not add or modify a container or Kubernetes manifest, and it introduces none of the checked settings: privileged: true, host namespaces, SYS_ADMIN, running as root, or allowPrivilegeEscalation: true.

Full details: No-Sensitive-Data-In-Logs

Explanation

PASS — The pull request changes only docs/scheduling_and_node_affinity.md. The added documentation contains configuration guidance and workload-placement behavior. It adds no logging or sensitive data such as passwords, tokens, API keys, PII, session IDs, hostnames, or customer data.

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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

@openshift-ci

openshift-ci Bot commented Oct 25, 2026

Copy link
Copy Markdown

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant