Skip to content

Commit 0f2e134

Browse files
author
Lisa Pettyjohn
committed
STOR-1275#Remove vSphere opt-in for migration
1 parent be5f3ea commit 0f2e134

File tree

3 files changed

+31
-73
lines changed

3 files changed

+31
-73
lines changed

modules/persistent-storage-csi-migration-vsphere.adoc

Lines changed: 23 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -9,79 +9,41 @@
99
== New installations of {product-title}
1010
For new installations of {product-title} 4.13, or later, automatic migration is enabled by default.
1111

12-
[id="upgrading-openshift_{context}"]
13-
== Upgrading {product-title}
14-
When upgrading from {product-title} 4.12, or earlier, to 4.13, automatic CSI migration for vSphere only occurs if you opt in.
12+
[id="updating-openshift_from_4.13_{context}"]
13+
== Updating from {product-title} 4.13 to 4.14
14+
If you are using vSphere in-tree persistent volumes (PVs) and want to update from {product-title} 4.13 to 4.14, update vSphere vCenter and ESXI host to 7.0 Update 3L or 8.0 Update 2, otherwise the {product-title} update is blocked. After updating vSphere, your {product-title} update can occur and automatic migration is enabled by default.
1515

16-
[IMPORTANT]
17-
====
18-
Carefully review the following consequences before opting in to migration:
19-
20-
* link:https://access.redhat.com/node/7011683[There are known issues that can occur that can cause the migration to fail].
21-
22-
* Enabling migration cannot be undone.
16+
Alternatively, if you do not want to update vSphere, you can proceed with an {product-title} update by performing an administrator acknowledgment:
2317

24-
* Migration can take awhile to complete depending on how many nodes are on the cluster.
18+
[source, cli]
19+
----
20+
oc -n openshift-config patch cm admin-acks --patch '{"data":{"ack-4.13-kube-127-vsphere-migration-in-4.14":"true"}}' --type=merge
21+
----
2522

26-
* Migration is a disruptive process. The Machine Config Operator (MCO) has to update kubelet, which means degrading each node as it rolls out the new MachineConfig to each machine.
23+
[IMPORTANT]
24+
====
25+
If you do *not* update to vSphere 7.0 Update 3L or 8.0 Update 2 and use an administrator acknowledgment to update to {product-title} 4.14, known issues can occur due to CSI migration being enabled by default in {product-title} 4.14. link:https://access.redhat.com/node/7011683[Before proceeding with the administrator acknowledgement, carefully read this knowledge base article].
2726
====
2827

29-
=== Using the web console to opt in to automatic CSI migration
30-
31-
==== Prerequisites
32-
33-
* Access to the {product-title} web console.
34-
35-
* Access to the cluster with cluster-admin privileges.
36-
37-
===== Procedure
38-
39-
To opt in to automatic CSI migration for vSphere:
40-
41-
. Log in to the web console.
42-
43-
. Click *Administration* -> *CustomResourceDefinitions*.
44-
45-
. On the *CustomResourceDefinitions* page, type "Storage" to find the `Storage` custom resource (CR).
46-
47-
. Click the *Storage* CR.
48-
49-
. On the *storages.operator.openshift.io* page, click the *Instances* tab.
28+
[id="updating-openshift_from_4.12_{context}"]
29+
== Updating from {product-title} 4.12 to 4.14
30+
If you are using vSphere in-tree persistent volumes (PVs) and want to update from {product-title} 4.12 to 4.14, update vSphere vCenter and ESXI host to 7.0 Update 3L or 8.0 Update 2, otherwise the {product-title} update is blocked. After updating vSphere, your {product-title} update can occur and automatic migration is enabled by default.
5031

51-
. Click the name of the desired instance, and then click the *YAML* tab.
32+
Alternatively, if you do not want to update vSphere, you can proceed with an {product-title} update by performing an administrator acknowledgment by running *both* of the following commands:
5233

53-
. Set the `spec.vsphereStorageDriver` parameter to `CSIWithMigrationDriver`, as shown in the following example:
54-
+
55-
[source, yaml]
34+
[source, terminal]
5635
----
57-
....
58-
spec:
59-
logLevel: Normal
60-
managementState: Managed
61-
operatorLogLevel: Normal
62-
vsphereStorageDriver: CSIWithMigrationDriver <1>
63-
...
36+
oc -n openshift-config patch cm admin-acks --patch '{"data":{"ack-4.12-kube-126-vsphere-migration-in-4.14":"true"}}' --type=merge
6437
----
65-
<1> `spec.vsphereStorageDriver` parameter set to `CSIWithMigrationDriver`
66-
67-
. Click *Save*.
68-
69-
=== Using the CLI to opt in to automatic CSI migration
7038

71-
==== Prerequisites
72-
73-
* Access to the cluster with cluster-admin privileges.
74-
75-
==== Procedure
76-
77-
To opt in to automatic CSI migration for vSphere, run the following command:
78-
79-
[source, cli]
39+
[source, terminal]
8040
----
81-
oc patch storage cluster --type=merge -p '{"spec":{"vsphereStorageDriver":"CSIWithMigrationDriver"}}'
41+
oc -n openshift-config patch cm admin-acks --patch '{"data":{"ack-4.13-kube-127-vsphere-migration-in-4.14":"true"}}' --type=merge
8242
----
8343

84-
[NOTE]
44+
[IMPORTANT]
8545
====
86-
You can determine when migration is complete by verifying that the `VSphereMigrationControllerAvailable` condition is set to "true" in the `Storage` object.
46+
If you do *not* update to vSphere 7.0 Update 3L or 8.0 Update 2 and use an administrator acknowledgment to update to {product-title} 4.14, known issues can occur due to CSI migration being enabled by default in {product-title} 4.14. link:https://access.redhat.com/node/7011683[Before proceeding with the administrator acknowledgement, carefully read this knowledge base article].
8747
====
48+
49+
Updating from {product-title} 4.12 to 4.14 is an Extended Update Support (EUS)-to-EUS update. To understand the ramifications for this type of update and how to perform it, see the _EUS-to-EUS update_ link in the _Additional resources_ section below.

storage/container_storage_interface/persistent-storage-csi-migration.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,7 @@ include::modules/persistent-storage-csi-migration-sc.adoc[leveloffset=+1]
1414
To change the default storage class, see xref:../../storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc#change-default-storage-class_persistent-storage-csi-sc-manage[Changing the default storage class].
1515

1616
include::modules/persistent-storage-csi-migration-vsphere.adoc[leveloffset=+1]
17+
18+
[role="_additional-resources"]
19+
.Additional resources
20+
* xref:../../updating/updating_a_cluster/eus-eus-update.adoc#eus-eus-update[Performing an EUS-to-EUS update]

storage/container_storage_interface/persistent-storage-csi-vsphere.adoc

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,15 @@ To create CSI-provisioned persistent volumes (PVs) that mount to vSphere storage
1616

1717
* *vSphere CSI Driver Operator*: The Operator provides a storage class, called `thin-csi`, that you can use to create persistent volumes claims (PVCs). The vSphere CSI Driver Operator supports dynamic volume provisioning by allowing storage volumes to be created on-demand, eliminating the need for cluster administrators to pre-provision storage. You can disable this default storage class if desired (see xref:../../storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc#persistent-storage-csi-sc-manage[Managing the default storage class]).
1818

19-
* *vSphere CSI driver*: The driver enables you to create and mount vSphere PVs. In {product-title} 4.13, the driver version is 3.0.1. The vSphere CSI driver supports all of the file systems supported by the underlying Red Hat Core OS release, including XFS and Ext4. For more information about supported file systems, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/managing_file_systems/assembly_overview-of-available-file-systems_managing-file-systems[Overview of available file systems].
19+
* *vSphere CSI driver*: The driver enables you to create and mount vSphere PVs. In {product-title} 4.14, the driver version is 3.0.2. The vSphere CSI driver supports all of the file systems supported by the underlying Red Hat Core OS release, including XFS and Ext4. For more information about supported file systems, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/managing_file_systems/assembly_overview-of-available-file-systems_managing-file-systems[Overview of available file systems].
2020

2121
//Please update driver version as needed with each major OCP release starting with 4.13.
2222

2323
//Listing the VMWare driver version here because it has a more variable set of features. The Operator version does not change independently (is parallel).
2424

2525
[IMPORTANT]
2626
====
27-
For vSphere:
28-
29-
* For new installations of {product-title} 4.13, or later, automatic migration is enabled by default.
30-
+
31-
CSI automatic migration should be seamless. Migration does not change how you use all existing API objects, such as persistent volumes, persistent volume claims, and storage classes. For more information about migration, see xref:../../storage/container_storage_interface/persistent-storage-csi-migration.adoc#persistent-storage-csi-migration[CSI automatic migration].
32-
33-
* When upgrading from {product-title} 4.12, or earlier, to 4.13, automatic CSI migration for vSphere only occurs if you opt in. If you do not opt in, {product-title} defaults to using the in-tree (non-CSI) plugin to provision vSphere storage. xref:../../storage/container_storage_interface/persistent-storage-csi-migration.adoc#upgrading-openshift_persistent-storage-csi-migration[Carefully review the indicated consequences before opting in to migration].
34-
35-
After full migration, in-tree plugins will eventually be removed in future versions of {product-title}.
27+
{product-title} defaults to using the CSI plugin to provision vSphere storage.
3628
====
3729

3830
[NOTE]
@@ -93,12 +85,12 @@ include::modules/persistent-storage-csi-vsphere-top-aware-post-install.adoc[leve
9385
[role="_additional-resources"]
9486
.Additional resources
9587
* xref:../../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on vSphere]
96-
* https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-16422FF7-235B-4A44-92E2-532F6AED0923.html?hWord=N4IghgNiBcIC5gOYgL5A[VMware vSphere tag documenation]
88+
* https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-16422FF7-235B-4A44-92E2-532F6AED0923.html?hWord=N4IghgNiBcIC5gOYgL5A[VMware vSphere tag documentation]
9789

9890
include::modules/persistent-storage-csi-vsphere-top-aware-infra-top.adoc[leveloffset=+2]
9991
[role="_additional-resources"]
10092
.Additional resources
101-
* https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-16422FF7-235B-4A44-92E2-532F6AED0923.html?hWord=N4IghgNiBcIC5gOYgL5A[VMware vSphere tag documenation]
93+
* https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-16422FF7-235B-4A44-92E2-532F6AED0923.html?hWord=N4IghgNiBcIC5gOYgL5A[VMware vSphere tag documentation]
10294

10395
include::modules/persistent-storage-csi-vsphere-top-aware-results.adoc[leveloffset=+2]
10496

0 commit comments

Comments
 (0)