Skip to content

Commit 08f287f

Browse files
authored
Merge pull request #80535 from lpettyjo/OSDOCS-10878
OSDOCS-10878#Disable storage vSphere
2 parents 11a6893 + e84341c commit 08f287f

4 files changed

+95
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
4+
//
5+
6+
:_mod-docs-content-type: CONCEPT
7+
[id="persistent-storage-csi-vsphere-disable-storage-consequences_{context}"]
8+
= Consequences of disabling and enabling storage on vSphere
9+
10+
The consequences of disabling and enabling storage on vSphere are described in the following table.
11+
12+
.Consequences of disabling/enabling storage on vSphere
13+
|===
14+
|Disabling | Enabling
15+
16+
a| * vSphere CSI Driver Operator un-installs the CSI driver.
17+
18+
* Storage container orchestration (CO) should be healthy.
19+
20+
* vSphere-problem-detector continues running, but does not emit alerts or events, and checks less frequently (once per 24 hours).
21+
22+
* All existing persistent volumes (PVs), persistent volume claims (PVCs), and vSphere storage policies are unchanged:
23+
24+
** vSphere PVs cannot be used in new pods.
25+
26+
** vSphere PVs stay mounted and attached forever to existing nodes for existing pods. These pods remain in terminating state indefinitely after deletion.
27+
28+
* Storage classes are removed
29+
30+
|* vSphere CSI Driver Operator re-installs the CSI driver.
31+
32+
* If necessary, the vSphere CSI Driver Operator creates the vSphere storage policy.
33+
|===
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
4+
//
5+
6+
:_mod-docs-content-type: CONCEPT
7+
[id="persistent-storage-csi-vsphere-disable-storage-overview_{context}"]
8+
= Disabling and enabling storage on vSphere
9+
10+
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.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
4+
//
5+
6+
:_mod-docs-content-type: PROCEDURE
7+
[id="persistent-storage-csi-vsphere-disable-storage-procedure_{context}"]
8+
= Disabling and enabling storage on vSphere
9+
10+
[IMPORTANT]
11+
====
12+
Before running this procedure, carefully review the preceding "Consequences of disabling and enabling storage on vSphere" table and potential impacts to your environment.
13+
====
14+
15+
.Procedure
16+
17+
To disable or enable storage on vSphere:
18+
19+
. Click *Administration* > *CustomResourceDefinitions*.
20+
21+
. On the *CustomResourceDefinitions* page next to the *Name* dropdown box, type "clustercsidriver".
22+
23+
. Click *CRD ClusterCSIDriver*.
24+
25+
. Click the *Instances* tab.
26+
27+
. Click *csi.vsphere.vmware.com*.
28+
29+
. Click the *YAML* tab.
30+
31+
. For `spec.managementState`, change the value to `Removed` or `Managed`:
32+
+
33+
* `Removed`: storage is disabled
34+
* `Managed`: storage is enabled
35+
36+
. Click *Save*.
37+
38+
. If you are disabling storage, confirm that the driver has been removed:
39+
.. Click *Workloads* > *Pods*.
40+
.. On the *Pods* page, in the *Name* filter box type "vmware-vsphere-csi-driver".
41+
+
42+
The only item that should appear is the operator. For example: "
43+
vmware-vsphere-csi-driver-operator-559b97ffc5-w99fm"

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,15 @@ include::modules/persistent-storage-csi-vsphere-top-aware-results.adoc[leveloffs
106106

107107
include::modules/persistent-storage-csi-vsphere-change-max-snapshot.adoc[leveloffset=+1]
108108

109+
include::modules/persistent-storage-csi-vsphere-disable-storage-overview.adoc[leveloffset=+1]
110+
111+
:FeatureName: Disabling and enabling storage on vSphere
112+
include::snippets/technology-preview.adoc[leveloffset=+2]
113+
114+
include::modules/persistent-storage-csi-vsphere-disable-storage-consequences.adoc[leveloffset=+2]
115+
116+
include::modules/persistent-storage-csi-vsphere-disable-storage-procedure.adoc[leveloffset=+2]
117+
109118
== Additional resources
110119
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]
111120

0 commit comments

Comments
 (0)