CNV-8902: node placement for HPP

Author: ousleyp

modules/virt-about-node-placement-virtualization-components.adoc

@@ -11,18 +11,27 @@ You might want to customize where {VirtProductName} deploys its components to en
 * Operators only deploy on infrastructure nodes.
 * Certain nodes are unaffected by {VirtProductName}. For example, you have workloads unrelated to virtualization running on your cluster, and you want those workloads to be isolated from {VirtProductName}.
 
-You can specify node placement rules for the {VirtProductName} Operators that Operator Lifecycle Manager (OLM) deploys by editing the OLM `Subscription` object.
+[id="how-to-apply-node-placement-rules-virt-components"]
+== How to apply node placement rules to virtualization components
 
-To specify node placement rules for components that the {VirtProductName} Operators deploy, edit the HyperConverged Cluster custom resource (CR).
+You can specify node placement rules for a component by editing the corresponding object directly or by using the web console.
 
-[id="about-node-placement-rules_{context}"]
-== About node placement rules
+* For the {VirtProductName} Operators that Operator Lifecycle Manager (OLM) deploys, edit the OLM `Subscription` object directly. Currently, you cannot configure node placement rules for the `Subscription` object by using the web console.
+* For components that the {VirtProductName} Operators deploy, edit the `HyperConverged` object directly or configure it by using the web console during {VirtProductName} installation.
+* For the hostpath provisioner, edit the `HostPathProvisioner` object directly or configure it by using the web console.
++
+[WARNING]
+====
+You must schedule the hostpath provisioner and the virtualization components on the same nodes. Otherwise, virtualization pods that use the hostpath provisioner cannot run.
+====
+
+Depending on the object, you can use one or more of the following rule types:
 
 `nodeSelector`:: Allows pods to be scheduled on nodes that are labeled with the key-value pair or pairs that you specify in this field. The node must have labels that exactly match all listed pairs.
 `affinity`:: Enables you to use more expressive syntax to set rules that match nodes with pods. Affinity also allows for more nuance in how the rules are applied. For example, you can specify that a rule is a preference, rather than a hard requirement, so that pods are still scheduled if the rule is not satisfied.
 `tolerations`:: Allows pods to be scheduled on nodes that have matching taints. If a taint is applied to a node, that node only accepts pods that tolerate the taint.
 
-[id="node-placement-olm-subscription-object_{context}"]
+[id="node-placement-olm-subscription_{context}"]
 == Node placement in the OLM Subscription object
 
 To specify the nodes where OLM deploys the {VirtProductName} Operators, edit the `Subscription` object during {VirtProductName} installation. You can include node placement rules in the `spec.config` field, as shown in the following example:
@@ -44,8 +53,8 @@ spec:
 ----
 <1> The `config` field supports `nodeSelector` and `tolerations`, but it does not support `affinity`.
 
-[id="node-placement-hco-cluster-cr_{context}"]
-== Node placement in the HyperConverged Cluster CR
+[id="node-placement-hco_{context}"]
+== Node placement in the HyperConverged object
 
 To specify the nodes where {VirtProductName} deploys its components, you can include the `nodePlacement` object in the HyperConverged Cluster custom resource (CR) file that you create during {VirtProductName} installation. You can include `nodePlacement` under the `spec.infra` and `spec.workloads` fields, as shown in the following example:
 
@@ -64,3 +73,23 @@ spec:
     nodePlacement:
 ----
 <1> The `nodePlacement` field supports `nodeSelector`, `affinity`, and `tolerations` fields.
+
+[id="node-placement-hpp_{context}"]
+== Node placement in the HostPathProvisioner object
+
+You can configure node placement rules in the `spec.workload` field of the `HostPathProvisioner` object that you create when you install the hostpath provisioner.
+
+[source,yaml]
+----
+apiVersion: hostpathprovisioner.kubevirt.io/v1beta1
+kind: HostPathProvisioner
+metadata:
+  name: hostpath-provisioner
+spec:
+  imagePullPolicy: IfNotPresent
+  pathConfig:
+    path: "</path/to/backing/directory>"
+    useNamingPrefix: false
+  workload: <1>
+----
+<1> The `workload` field supports `nodeSelector`, `affinity`, and `tolerations` fields.

modules/virt-example-node-placement-node-selector-hpp.adoc

@@ -0,0 +1,24 @@
+// Module included in the following assemblies:
+//
+// * virt/install/virt-specifying-nodes-for-virtualization-components.adoc
+
+[id="virt-example-node-placement-node-selector-hpp_{context}"]
+= Example: Node placement with nodeSelector in the HostPathProvisioner object
+
+In this example, `nodeSelector` is configured so that workloads are placed on nodes labeled with `example.io/example-workloads-key = example-workloads-value`.
+
+[source,yaml]
+----
+apiVersion: hostpathprovisioner.kubevirt.io/v1beta1
+kind: HostPathProvisioner
+metadata:
+  name: hostpath-provisioner
+spec:
+  imagePullPolicy: IfNotPresent
+  pathConfig:
+    path: "</path/to/backing/directory>"
+    useNamingPrefix: false
+  workload:
+    nodeSelector:
+      example.io/example-workloads-key: example-workloads-value
+----

modules/virt-using-hostpath-provisioner.adoc

@@ -50,10 +50,12 @@ spec:
   pathConfig:
     path: "</path/to/backing/directory>" <1>
     useNamingPrefix: false <2>
+  workload: <3>
 ----
 <1> Specify the backing directory where you want the provisioner to create PVs.
 <2> Change this value to `true` if you want to use the name of the persistent volume claim (PVC)
 that is bound to the created PV as the prefix of the directory name.
+<3> Optional: You can use the `spec.workload` field to configure node placement rules for the hostpath provisioner.
 +
 [NOTE]
 ====

virt/install/installing-virt-web.adoc

@@ -11,11 +11,6 @@ You can use the {product-title} {product-version}
 xref:../../web_console/web-console.adoc#web-console-overview_web-console[web console]
 to subscribe to and deploy the {VirtProductName} Operators.
 
-[NOTE]
-====
-To specify the nodes where you want {VirtProductName} to install its components, xref:../../virt/install/virt-specifying-nodes-for-virtualization-components.adoc#virt-specifying-nodes-for-virtualization-components[configure node placement rules].
-====
-
 [id="prerequisites_{context}"]
 == Prerequisites
 * Install {product-title} {product-version} on your cluster.

virt/install/virt-specifying-nodes-for-virtualization-components.adoc

@@ -5,7 +5,7 @@ include::modules/common-attributes.adoc[]
 :context: virt-specifying-nodes-for-virtualization-components
 toc::[]
 
-Specify the nodes where you want to deploy {VirtProductName} Operators, workloads, and controllers by configuring node placement rules during xref:../../virt/install/installing-virt-cli.adoc#installing-virt-cli[installation].
+Specify the nodes where you want to deploy {VirtProductName} Operators, workloads, and controllers by configuring node placement rules.
 
 [NOTE]
 ====
@@ -17,24 +17,40 @@ include::modules/virt-about-node-placement-virtualization-components.adoc[levelo
 [id="additional-resources_{context}"]
 === Additional resources
 
+[id="node-placement-resources_{context}"]
+==== Node placement rules
 * xref:../../nodes/scheduling/nodes-scheduler-node-selectors.html#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors]
 * xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity[Controlling pod placement on nodes using node affinity rules]
 * xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
 
+[id="installation-resources_{context}"]
+==== Installing {VirtProductName}
+* xref:../../virt/install/installing-virt-cli.adoc#installing-virt-cli[Installing {VirtProductName} using the CLI]
+* xref:../../virt/install/installing-virt-web.adoc#installing-virt-web[Installing {VirtProductName} using the web console]
+
+[id="hostpath-provisioner-resources_{context}"]
+==== Configuring the hostpath provisioner
+* xref:../../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-configuring-local-storage-for-vms[Configuring local storage for virtual machines]
+
 [id="example-manifests_{context}"]
 == Example manifests
 
-The following example YAML snippets use `nodePlacement`, `affinity`, and `tolerations` objects to customize node placement for {VirtProductName} components.
+The following example YAML files use `nodePlacement`, `affinity`, and `tolerations` objects to customize node placement for {VirtProductName} components.
 
 [id="olm-subscription-examples_{context}"]
-=== Operator Lifecycle Manager Subscription examples
+=== Operator Lifecycle Manager Subscription object
 
-include::modules/virt-example-node-placement-tolerations-olm-subscription.adoc[leveloffset=+3]
 include::modules/virt-example-node-placement-node-selector-olm-subscription.adoc[leveloffset=+3]
+include::modules/virt-example-node-placement-tolerations-olm-subscription.adoc[leveloffset=+3]
 
 [id="hyperconverged-cluster-cr-examples_{context}"]
-=== HyperConverged Cluster CR examples
+=== HyperConverged object
 
 include::modules/virt-example-node-placement-node-selector-hyperconverged-cr.adoc[leveloffset=+3]
 include::modules/virt-example-node-placement-affinity-hyperconverged-cr.adoc[leveloffset=+3]
-include::modules/virt-example-node-placement-tolerations-hyperconverged-cr.adoc[leveloffset=+3]
+include::modules/virt-example-node-placement-tolerations-hyperconverged-cr.adoc[leveloffset=+3]
+
+[id="hpp-object-examples_{context}"]
+=== HostPathProvisioner object
+
+include::modules/virt-example-node-placement-node-selector-hpp.adoc[leveloffset=+3]

virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc

@@ -4,7 +4,6 @@ include::modules/virt-document-attributes.adoc[]
 :context: virt-configuring-local-storage-for-vms
 toc::[]
 
-
 You can configure local storage for your virtual machines by using the hostpath
 provisioner feature.
 
@@ -14,4 +13,8 @@ include::modules/virt-configuring-selinux-hpp-on-rhcos8.adoc[leveloffset=+1]
 
 include::modules/virt-using-hostpath-provisioner.adoc[leveloffset=+1]
 
+[id="virt-local-storage-resources"]
+=== Additional resources
+* xref:../../../virt/install/virt-specifying-nodes-for-virtualization-components.adoc#virt-specifying-nodes-for-virtualization-components[Specifying nodes for virtualization components]
+
 include::modules/virt-creating-storage-class.adoc[leveloffset=+1]