From 62fad07b6c75b61fb7b26f33254e8bcdbdffe10a Mon Sep 17 00:00:00 2001 From: Lisa Pettyjohn Date: Tue, 16 May 2023 14:20:45 -0400 Subject: [PATCH] STOR-1275#Remove vSphere opt-in for migration --- ...sistent-storage-csi-migration-vsphere.adoc | 98 ++++++------------- .../persistent-storage-csi-migration.adoc | 4 + .../persistent-storage-csi-vsphere.adoc | 16 +-- 3 files changed, 38 insertions(+), 80 deletions(-) diff --git a/modules/persistent-storage-csi-migration-vsphere.adoc b/modules/persistent-storage-csi-migration-vsphere.adoc index cdeda0de2a..2bd9a73432 100644 --- a/modules/persistent-storage-csi-migration-vsphere.adoc +++ b/modules/persistent-storage-csi-migration-vsphere.adoc @@ -9,79 +9,41 @@ == New installations of {product-title} For new installations of {product-title} 4.13, or later, automatic migration is enabled by default. -[id="upgrading-openshift_{context}"] -== Upgrading {product-title} -When upgrading from {product-title} 4.12, or earlier, to 4.13, automatic CSI migration for vSphere only occurs if you opt in. +[id="updating-openshift_from_4.13_{context}"] +== Updating from {product-title} 4.13 to 4.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. -[IMPORTANT] -==== -Carefully review the following consequences before opting in to migration: - -* link:https://access.redhat.com/node/7011683[There are known issues that can occur that can cause the migration to fail]. - -* Enabling migration cannot be undone. - -* Migration can take awhile to complete depending on how many nodes are on the cluster. - -* 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. -==== - -=== Using the web console to opt in to automatic CSI migration - -==== Prerequisites - -* Access to the {product-title} web console. - -* Access to the cluster with cluster-admin privileges. - -===== Procedure - -To opt in to automatic CSI migration for vSphere: - -. Log in to the web console. - -. Click *Administration* -> *CustomResourceDefinitions*. - -. On the *CustomResourceDefinitions* page, type "Storage" to find the `Storage` custom resource (CR). - -. Click the *Storage* CR. - -. On the *storages.operator.openshift.io* page, click the *Instances* tab. - -. Click the name of the desired instance, and then click the *YAML* tab. - -. Set the `spec.vsphereStorageDriver` parameter to `CSIWithMigrationDriver`, as shown in the following example: -+ -[source, yaml] ----- -.... -spec: - logLevel: Normal - managementState: Managed - operatorLogLevel: Normal - vsphereStorageDriver: CSIWithMigrationDriver <1> -... ----- -<1> `spec.vsphereStorageDriver` parameter set to `CSIWithMigrationDriver` - -. Click *Save*. - -=== Using the CLI to opt in to automatic CSI migration - -==== Prerequisites - -* Access to the cluster with cluster-admin privileges. - -==== Procedure - -To opt in to automatic CSI migration for vSphere, run the following command: +Alternatively, if you do not want to update vSphere, you can proceed with an {product-title} update by performing an administrator acknowledgment: [source, cli] ---- -oc patch storage cluster --type=merge -p '{"spec":{"vsphereStorageDriver":"CSIWithMigrationDriver"}}' +oc -n openshift-config patch cm admin-acks --patch '{"data":{"ack-4.13-kube-127-vsphere-migration-in-4.14":"true"}}' --type=merge ---- -[NOTE] +[IMPORTANT] ==== -You can determine when migration is complete by verifying that the `VSphereMigrationControllerAvailable` condition is set to "true" in the `Storage` object. +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]. ==== + +[id="updating-openshift_from_4.12_{context}"] +== Updating from {product-title} 4.12 to 4.14 +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. + +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: + +[source, terminal] +---- +oc -n openshift-config patch cm admin-acks --patch '{"data":{"ack-4.12-kube-126-vsphere-migration-in-4.14":"true"}}' --type=merge +---- + +[source, terminal] +---- +oc -n openshift-config patch cm admin-acks --patch '{"data":{"ack-4.13-kube-127-vsphere-migration-in-4.14":"true"}}' --type=merge +---- + +[IMPORTANT] +==== +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]. +==== + +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. \ No newline at end of file diff --git a/storage/container_storage_interface/persistent-storage-csi-migration.adoc b/storage/container_storage_interface/persistent-storage-csi-migration.adoc index 12b2727a5a..5c37b7a265 100644 --- a/storage/container_storage_interface/persistent-storage-csi-migration.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-migration.adoc @@ -14,3 +14,7 @@ include::modules/persistent-storage-csi-migration-sc.adoc[leveloffset=+1] 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]. include::modules/persistent-storage-csi-migration-vsphere.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources +* xref:../../updating/updating_a_cluster/eus-eus-update.adoc#eus-eus-update[Performing an EUS-to-EUS update] \ No newline at end of file diff --git a/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc b/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc index 82bb5ae507..ae6a11ee8f 100644 --- a/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc @@ -16,7 +16,7 @@ To create CSI-provisioned persistent volumes (PVs) that mount to vSphere storage * *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]). -* *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]. +* *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]. //Please update driver version as needed with each major OCP release starting with 4.13. @@ -24,15 +24,7 @@ To create CSI-provisioned persistent volumes (PVs) that mount to vSphere storage [IMPORTANT] ==== -For vSphere: - -* For new installations of {product-title} 4.13, or later, automatic migration is enabled by default. -+ -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]. - -* 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]. - -After full migration, in-tree plugins will eventually be removed in future versions of {product-title}. +{product-title} defaults to using the CSI plugin to provision vSphere storage. ==== [NOTE] @@ -93,12 +85,12 @@ include::modules/persistent-storage-csi-vsphere-top-aware-post-install.adoc[leve [role="_additional-resources"] .Additional resources * 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] -* 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] +* 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] include::modules/persistent-storage-csi-vsphere-top-aware-infra-top.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* 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] +* 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] include::modules/persistent-storage-csi-vsphere-top-aware-results.adoc[leveloffset=+2]