OADP-4750: configure OADP NodeAgents on nodes with worker, infra or custom labels

anarnold97 · PrasadJoshi12 · anarnold97 · commit e3ad26db5ab7 · 2024-09-05T16:51:56.000+01:00
Signed-off-by: A.Arnold &lt;anarnold@redhat.com&gt;

Update modules/oadp-configuring-node-agents.adoc

Co-authored-by: Prasad Joshi &lt;p.joshi86753@gmail.com&gt;
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
@@ -32,13 +32,19 @@ include::modules/oadp-secrets-for-different-credentials.adoc[leveloffset=+2]
 You can configure the Data Protection Application by setting Velero resource allocations or enabling self-signed CA certificates.
 
 include::modules/oadp-setting-resource-limits-and-requests.adoc[leveloffset=+2]
+
+include::snippets/oadp-nodeselector-snippet.adoc[]
+
+For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#oadp-configuring-node-agents_installing-oadp-aws[Configuring node agents and node labels].
+
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
 
 include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
+include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
 include::modules/oadp-configuring-dpa-multiple-bsl.adoc[leveloffset=+1]
 include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
-include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] 
+include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
@@ -29,12 +29,18 @@ include::modules/oadp-secrets-for-different-credentials.adoc[leveloffset=+2]
 You can configure the Data Protection Application by setting Velero resource allocations or enabling self-signed CA certificates.
 
 include::modules/oadp-setting-resource-limits-and-requests.adoc[leveloffset=+2]
+
+include::snippets/oadp-nodeselector-snippet.adoc[]
+
+For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc#oadp-configuring-node-agents_installing-oadp-azure[Configuring node agents and node labels].
+
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
 
 include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
+include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
 include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
-include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] 
+include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
@@ -29,13 +29,19 @@ include::modules/oadp-secrets-for-different-credentials.adoc[leveloffset=+2]
 You can configure the Data Protection Application by setting Velero resource allocations or enabling self-signed CA certificates.
 
 include::modules/oadp-setting-resource-limits-and-requests.adoc[leveloffset=+2]
+
+include::snippets/oadp-nodeselector-snippet.adoc[]
+
+For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc#oadp-configuring-node-agents_installing-oadp-gcp[Configuring node agents and node labels].
+
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
 
 include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-gcp-wif-cloud-authentication.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
+include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
 include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
-include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] 
+include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc
@@ -43,6 +43,7 @@ include::modules/install-and-configure-oadp-kubevirt.adoc[leveloffset=+1]
 * xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
 
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
+include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
 
 [IMPORTANT]
 ====
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
@@ -36,12 +36,18 @@ include::modules/oadp-secrets-for-different-credentials.adoc[leveloffset=+2]
 You can configure the Data Protection Application by setting Velero resource allocations or enabling self-signed CA certificates.
 
 include::modules/oadp-setting-resource-limits-and-requests.adoc[leveloffset=+2]
+
+include::snippets/oadp-nodeselector-snippet.adoc[]
+
+For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#oadp-configuring-node-agents_installing-oadp-mcg[Configuring node agents and node labels].
+
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
 
 include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
+include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
 include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
-include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] 
+include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2]
 
 [discrete]
 [role="_additional-resources"]
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
@@ -38,14 +38,20 @@ include::modules/oadp-secrets-for-different-credentials.adoc[leveloffset=+2]
 You can configure the Data Protection Application by setting Velero resource allocations or enabling self-signed CA certificates.
 
 include::modules/oadp-setting-resource-limits-and-requests.adoc[leveloffset=+2]
+
+include::snippets/oadp-nodeselector-snippet.adoc[]
+
+For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc#oadp-configuring-node-agents_installing-oadp-ocs[Configuring node agents and node labels].
+
 include::modules/oadp-odf-cpu-memory-requirements.adoc[leveloffset=+3]
 include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
 
 include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
 include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
+include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
 include::modules/oadp-creating-object-bucket-claim.adoc[leveloffset=+2]
 include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
-include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2] 
+include::modules/oadp-about-disable-node-agent-dpa.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
diff --git a/backup_and_restore/application_backup_and_restore/oadp-api.adoc b/backup_and_restore/application_backup_and_restore/oadp-api.adoc
@@ -201,6 +201,7 @@ link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ResticCo
 |`nodeSelector`
 |map [ link:https://pkg.go.dev/builtin#string[string] ] link:https://pkg.go.dev/builtin#string[string]
 |Defines the `nodeSelector` to be supplied to a `Velero` `podSpec` or a `Restic` `podSpec`.
+For more details, see xref:../../backup_and_restore/application_backup_and_restore/oadp-api.adoc#oadp-configuring-node-agents_oadp-api[Configuring node agents and node labels].
 
 |`tolerations`
 |[]link:https://pkg.go.dev/k8s.io/api/core/v1#Toleration[Toleration]
@@ -215,6 +216,8 @@ link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ResticCo
 |Labels to add to pods.
 |===
 
+include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
+
 link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#PodConfig[Complete schema definitions for the type `PodConfig`].
 
 .Features
diff --git a/modules/oadp-configuring-node-agents.adoc b/modules/oadp-configuring-node-agents.adoc
@@ -0,0 +1,50 @@
+// Module included in the following assemblies:
+//
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc
+// * backup_and_restore/application_backup_and_restore/oadp-api.adoc
+// * virt/backup_restore/virt-backup-restore-overview.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="oadp-configuring-node-agents_{context}"]
+= Configuring node agents and node labels
+
+The DPA of {oadp-short} uses the `nodeSelector` field to select which nodes can run the node agent. The `nodeSelector` field is the simplest recommended form of node selection constraint.
+
+Any label specified must match the labels on each node.
+
+The correct way to run the node agent on any node you choose is for you to label the nodes with a custom label:
+
+[source,terminal]
+----
+$ oc label node/<node_name> node-role.kubernetes.io/nodeAgent=""
+----
+
+Use the same custom label in the `DPA.spec.configuration.nodeAgent.podConfig.nodeSelector`, which you used for labeling nodes. For example:
+
+[source,terminal]
+----
+configuration:
+  nodeAgent:
+    enable: true
+    podConfig:
+      nodeSelector:
+        node-role.kubernetes.io/nodeAgent: ""
+----
+
+The following example is an anti-pattern of `nodeSelector` and does not work unless both labels, `'node-role.kubernetes.io/infra: ""'` and `'node-role.kubernetes.io/worker: ""'`, are on the node:
+
+[source,terminal]
+----
+    configuration:
+      nodeAgent:
+        enable: true
+        podConfig:
+          nodeSelector:
+            node-role.kubernetes.io/infra: ""
+            node-role.kubernetes.io/worker: ""
+----
diff --git a/modules/oadp-setting-resource-limits-and-requests.adoc b/modules/oadp-setting-resource-limits-and-requests.adoc
@@ -33,7 +33,7 @@ spec:
   configuration:
     velero:
       podConfig:
-        nodeSelector: <node selector> <1>
+        nodeSelector: <node_selector> <1>
         resourceAllocations: <2>
           limits:
             cpu: "1"
diff --git a/snippets/oadp-nodeselector-snippet.adoc b/snippets/oadp-nodeselector-snippet.adoc
@@ -0,0 +1,11 @@
+// Module included in the following assemblies:
+//
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
+// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
+
+:_mod-docs-content-type: SNIPPET
+
+Use the `nodeSelector` field to select which nodes can run the node agent. The `nodeSelector` field is the simplest recommended form of node selection constraint. Any label specified must match the labels on each node.
