1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00

Merge pull request #82233 from openshift-cherrypick-robot/cherry-pick-80535-to-enterprise-4.17

[enterprise-4.17] OSDOCS-10878#Disable storage vSphere
This commit is contained in:
Lisa Pettyjohn
2024-09-20 14:26:25 -04:00
committed by GitHub
4 changed files with 95 additions and 0 deletions

View File

@@ -0,0 +1,33 @@
// Module included in the following assemblies:
//
// * storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
//
:_mod-docs-content-type: CONCEPT
[id="persistent-storage-csi-vsphere-disable-storage-consequences_{context}"]
= Consequences of disabling and enabling storage on vSphere
The consequences of disabling and enabling storage on vSphere are described in the following table.
.Consequences of disabling/enabling storage on vSphere
|===
|Disabling | Enabling
a| * vSphere CSI Driver Operator un-installs the CSI driver.
* Storage container orchestration (CO) should be healthy.
* vSphere-problem-detector continues running, but does not emit alerts or events, and checks less frequently (once per 24 hours).
* All existing persistent volumes (PVs), persistent volume claims (PVCs), and vSphere storage policies are unchanged:
** vSphere PVs cannot be used in new pods.
** vSphere PVs stay mounted and attached forever to existing nodes for existing pods. These pods remain in terminating state indefinitely after deletion.
* Storage classes are removed
|* vSphere CSI Driver Operator re-installs the CSI driver.
* If necessary, the vSphere CSI Driver Operator creates the vSphere storage policy.
|===

View File

@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
//
:_mod-docs-content-type: CONCEPT
[id="persistent-storage-csi-vsphere-disable-storage-overview_{context}"]
= Disabling and enabling storage on vSphere
Cluster administrators might want to disable the VMWare vSphere Container Storage Interface (CSI) Driver as a Day 2 operation, so the vSphere CSI Driver does not interface with your vSphere setup.

View File

@@ -0,0 +1,43 @@
// Module included in the following assemblies:
//
// * storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
//
:_mod-docs-content-type: PROCEDURE
[id="persistent-storage-csi-vsphere-disable-storage-procedure_{context}"]
= Disabling and enabling storage on vSphere
[IMPORTANT]
====
Before running this procedure, carefully review the preceding "Consequences of disabling and enabling storage on vSphere" table and potential impacts to your environment.
====
.Procedure
To disable or enable storage on vSphere:
. Click *Administration* > *CustomResourceDefinitions*.
. On the *CustomResourceDefinitions* page next to the *Name* dropdown box, type "clustercsidriver".
. Click *CRD ClusterCSIDriver*.
. Click the *Instances* tab.
. Click *csi.vsphere.vmware.com*.
. Click the *YAML* tab.
. For `spec.managementState`, change the value to `Removed` or `Managed`:
+
* `Removed`: storage is disabled
* `Managed`: storage is enabled
. Click *Save*.
. If you are disabling storage, confirm that the driver has been removed:
.. Click *Workloads* > *Pods*.
.. On the *Pods* page, in the *Name* filter box type "vmware-vsphere-csi-driver".
+
The only item that should appear is the operator. For example: "
vmware-vsphere-csi-driver-operator-559b97ffc5-w99fm"

View File

@@ -106,6 +106,15 @@ include::modules/persistent-storage-csi-vsphere-top-aware-results.adoc[leveloffs
include::modules/persistent-storage-csi-vsphere-change-max-snapshot.adoc[leveloffset=+1]
include::modules/persistent-storage-csi-vsphere-disable-storage-overview.adoc[leveloffset=+1]
:FeatureName: Disabling and enabling storage on vSphere
include::snippets/technology-preview.adoc[leveloffset=+2]
include::modules/persistent-storage-csi-vsphere-disable-storage-consequences.adoc[leveloffset=+2]
include::modules/persistent-storage-csi-vsphere-disable-storage-procedure.adoc[leveloffset=+2]
== Additional resources
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]