Skip to content

Commit 5689cc7

Browse files
authored
Merge pull request #57422 from aspauldi/CNV-23499_doc
CNV-23499: 4.10+ HPP CSI only - content
2 parents 3c194c7 + e11c23c commit 5689cc7

File tree

6 files changed

+14
-39
lines changed

6 files changed

+14
-39
lines changed
Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,11 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc
3+
44

55
:_content-type: CONCEPT
66
[id="virt-about-hostpath-provisioner_{context}"]
77
= About the hostpath provisioner
88

99
When you install the {VirtProductName} Operator, the Hostpath Provisioner (HPP) Operator is automatically installed. The HPP is a local storage provisioner designed for {VirtProductName} that is created by the Hostpath Provisioner Operator. To use the HPP, you must create an HPP custom resource (CR).
1010

11-
[IMPORTANT]
12-
====
13-
In {VirtProductName} 4.10, the HPP Operator configures the Kubernetes CSI driver. The Operator also recognizes the existing (legacy) format of the HPP CR.
14-
15-
The legacy HPP and the Container Storage Interface (CSI) driver are supported in parallel for a number of releases. However, at some point, the legacy HPP will no longer be supported. If you use the HPP, plan to create a storage class for the CSI driver as part of your migration strategy.
16-
====
17-
18-
If you upgrade to {VirtProductName} version 4.10 on an existing cluster, the HPP Operator is upgraded and the system performs the following actions:
19-
20-
* The CSI driver is installed.
21-
* The CSI driver is configured with the contents of your legacy HPP CR.
22-
23-
If you install {VirtProductName} version 4.10 on a new cluster, you must perform the following actions:
24-
25-
* Create an HPP CR with a basic storage pool.
26-
* Create a storage class for the CSI driver.
2711

28-
Optional: You can create a storage pool with a PVC template for multiple HPP volumes.

modules/virt-creating-storage-class-csi-driver.adoc

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@
88

99
You create a storage class custom resource (CR) for the hostpath provisioner (HPP) CSI driver.
1010

11-
.Prerequisites
12-
13-
* You must have {VirtProductName} 4.10 or later.
14-
1511
.Procedure
1612

1713
. Create a `storageclass_csi.yaml` file to define the storage class:
@@ -21,17 +17,17 @@ You create a storage class custom resource (CR) for the hostpath provisioner (HP
2117
apiVersion: storage.k8s.io/v1
2218
kind: StorageClass
2319
metadata:
24-
name: hostpath-csi <1>
20+
name: hostpath-csi
2521
provisioner: kubevirt.io.hostpath-provisioner
26-
reclaimPolicy: Delete <2>
27-
volumeBindingMode: WaitForFirstConsumer <3>
22+
reclaimPolicy: Delete <1>
23+
volumeBindingMode: WaitForFirstConsumer <2>
2824
parameters:
29-
storagePool: my-storage-pool <4>
25+
storagePool: my-storage-pool <3>
3026
----
31-
<1> Assign any meaningful name to the storage class. In this example, `csi` is used to specify that the class is using the CSI provisioner instead of the legacy provisioner. Choosing descriptive names for storage classes, based on legacy or CSI driver provisioning, eases implementation of your migration strategy.
32-
<2> The two possible `reclaimPolicy` values are `Delete` and `Retain`. If you do not specify a value, the default value is `Delete`.
33-
<3> The `volumeBindingMode` parameter determines when dynamic provisioning and volume binding occur. Specify `WaitForFirstConsumer` to delay the binding and provisioning of a persistent volume (PV) until after a pod that uses the persistent volume claim (PVC) is created. This ensures that the PV meets the pod's scheduling requirements.
34-
<4> Specify the name of the storage pool defined in the HPP CR.
27+
28+
<1> The two possible `reclaimPolicy` values are `Delete` and `Retain`. If you do not specify a value, the default value is `Delete`.
29+
<2> The `volumeBindingMode` parameter determines when dynamic provisioning and volume binding occur. Specify `WaitForFirstConsumer` to delay the binding and provisioning of a persistent volume (PV) until after a pod that uses the persistent volume claim (PVC) is created. This ensures that the PV meets the pod's scheduling requirements.
30+
<3> Specify the name of the storage pool defined in the HPP CR.
3531

3632
. Save the file and exit.
3733

virt/install/installing-virt-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ include::modules/virt-deploying-operator-cli.adoc[leveloffset=+1]
3434

3535
You might want to additionally configure the following components:
3636

37-
* The xref:../../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-about-hostpath-provisioner_virt-configuring-local-storage-for-vms[hostpath provisioner] is a local storage provisioner designed for {VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first.
37+
* The xref:../../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-creating-hpp-basic-storage-pool_virt-configuring-local-storage-for-vms[hostpath provisioner] is a local storage provisioner designed for {VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first.

virt/install/installing-virt-web.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ include::modules/virt-installing-virt-operator.adoc[leveloffset=+1]
1818

1919
You might want to additionally configure the following components:
2020

21-
* The xref:../../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-about-hostpath-provisioner_virt-configuring-local-storage-for-vms[hostpath provisioner] is a local storage provisioner designed for {VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first.
21+
* The xref:../../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-creating-hpp-basic-storage-pool_virt-configuring-local-storage-for-vms[hostpath provisioner] is a local storage provisioner designed for {VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first.

virt/virt-architecture.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ image::cnv_components_main.png[CNV Deployments]
1818
1919
* xref:../virt/virt-using-the-cli-tools.adoc#virt-virtctl-commands_virt-using-the-cli-tools[Virtctl client commands]
2020
21-
* xref:../virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc#virt-about-hostpath-provisioner_virt-configuring-local-storage-for-vms[About the hostpath provisioner]
22-
2321
include::modules/virt-about-hco-operator.adoc[leveloffset=+1]
2422

2523
include::modules/virt-about-cdi-operator.adoc[leveloffset=+1]

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,16 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can configure local storage for virtual machines by using the hostpath provisioner (HPP).
9+
You can configure local storage for virtual machines by using the hostpath provisioner (HPP).
1010

11-
include::modules/virt-about-hostpath-provisioner.adoc[leveloffset=+1]
11+
When you install the {VirtProductName} Operator, the Hostpath Provisioner (HPP) Operator is automatically installed. The HPP is a local storage provisioner designed for {VirtProductName} that is created by the Hostpath Provisioner Operator. To use the HPP, you must create an HPP custom resource (CR).
1212

1313
include::modules/virt-creating-hpp-basic-storage-pool.adoc[leveloffset=+1]
1414

15-
include::modules/virt-about-creating-storage-classes.adoc[leveloffset=+1]
15+
include::modules/virt-about-creating-storage-classes.adoc[leveloffset=+2]
1616

1717
include::modules/virt-creating-storage-class-csi-driver.adoc[leveloffset=+2]
1818

19-
include::modules/virt-creating-storage-class-legacy-hpp.adoc[leveloffset=+2]
20-
2119
include::modules/virt-about-storage-pools-pvc-templates.adoc[leveloffset=+1]
2220

2321
include::modules/virt-creating-storage-pool-pvc-template.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)