Merge pull request #55377 from lpettyjo/OSDOCS-3791

lpettyjo · web-flow · commit 185a10ada6e9 · 2023-04-20T21:01:22.000-04:00
OSDOCS-3791:Disable default SC
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -1515,6 +1515,8 @@ Topics:
     File: persistent-storage-csi-snapshots
   - Name: CSI volume cloning
     File: persistent-storage-csi-cloning
+  - Name: Managing the default storage class
+    File: persistent-storage-csi-sc-manage
   - Name: CSI automatic migration
     File: persistent-storage-csi-migration
   - Name: Detach CSI volumes after non-graceful node shutdown
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -200,6 +200,8 @@ Topics:
   Topics:
   - Name: Configuring CSI volumes
     File: persistent-storage-csi
+  - Name: Managing the default storage class
+    File: persistent-storage-csi-sc-manage
   - Name: AWS Elastic Block Store CSI Driver Operator
     File: persistent-storage-csi-ebs
   - Name: AWS Elastic File Service CSI Driver Operator
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -293,6 +293,8 @@ Topics:
   Topics:
   - Name: Configuring CSI volumes
     File: persistent-storage-csi
+  - Name: Managing the default storage class
+    File: persistent-storage-csi-sc-manage
   - Name: AWS Elastic Block Store CSI Driver Operator
     File: persistent-storage-csi-ebs
   - Name: AWS Elastic File Service CSI Driver Operator
diff --git a/modules/persistent-storage-csi-sc-managing-cli.adoc b/modules/persistent-storage-csi-sc-managing-cli.adoc
@@ -0,0 +1,23 @@
+// Module included in the following assemblies:
+//
+// * storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc
+//
+
+:_content-type: PROCEDURE
+[id="persistent-storage-csi-sc-managing-cli_{context}"]
+= Managing the default storage class using the CLI
+
+.Prerequisites
+* Access to the cluster with cluster-admin privileges.
+
+.Procedure
+
+To manage the storage class using the CLI, run the following command:
+
+[source, terminal]
+----
+oc patch clustercsidriver $DRIVERNAME --type=merge -p "{\"spec\":{\"storageClassState\":\"${STATE}\"}}" <1>
+----
+<1> Where `${STATE}` is "Removed" or "Managed" or "Unmanaged". 
++
+Where `$DRIVERNAME` is the provisioner name. You can find the provisioner name by running the command `oc get sc`.
diff --git a/modules/persistent-storage-csi-sc-managing.adoc b/modules/persistent-storage-csi-sc-managing.adoc
@@ -0,0 +1,47 @@
+// Module included in the following assemblies:
+//
+// * storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc
+//
+
+:_content-type: PROCEDURE
+[id="persistent-storage-csi-sc-managing_{context}"]
+= Managing the default storage class using the web console
+
+.Prerequisites
+* Access to the {product-title} web console.
+
+* Access to the cluster with cluster-admin privileges.
+
+.Procedure
+
+To manage the default storage class using the web console:
+
+. Log in to the web console.
+
+. Click *Administration* > *CustomResourceDefinitions*.
+
+. On the *CustomResourceDefinitions* page, type `clustercsidriver` to find the `ClusterCSIDriver` object.
+
+. Click *ClusterCSIDriver*, and then click the *Instances* tab.
+
+. Click the name of the desired instance, and then click the *YAML* tab.
+
+. Add the `spec.storageClassState` field with a value of `Managed`, `Unmanaged`, or `Removed`.
++
+.Example
+[source, yaml]
+----
+...
+spec:
+  driverConfig:
+    driverType: ''
+  logLevel: Normal
+  managementState: Managed
+  observedConfig: null
+  operatorLogLevel: Normal
+  storageClassState: Unmanaged <1>
+...
+----
+<1> `spec.storageClassState` field set to "Unmanaged"
+
+. Click *Save*.
diff --git a/storage/container_storage_interface/persistent-storage-csi-alicloud-disk.adoc b/storage/container_storage_interface/persistent-storage-csi-alicloud-disk.adoc
@@ -14,7 +14,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned PVs that mount to AliCloud Disk storage assets, {product-title} installs the AliCloud Disk CSI Driver Operator and the AliCloud Disk CSI driver, by default, in the `openshift-cluster-csi-drivers` namespace.
 
-* The _AliCloud Disk CSI Driver Operator_ provides a storage class (`alicloud-disk`) that you can use to create persistent volume claims (PVCs). The AliCloud Disk 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.
+* The _AliCloud Disk CSI Driver Operator_ provides a storage class (`alicloud-disk`) that you can use to create persistent volume claims (PVCs). The AliCloud Disk 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]).
 
 * The _AliCloud Disk CSI driver_ enables you to create and mount AliCloud Disk PVs.
 
diff --git a/storage/container_storage_interface/persistent-storage-csi-azure-file.adoc b/storage/container_storage_interface/persistent-storage-csi-azure-file.adoc
@@ -13,7 +13,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned PVs that mount to Azure File storage assets, {product-title} installs the Azure File CSI Driver Operator and the Azure File CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
 
-* The _Azure File CSI Driver Operator_ provides a storage class that is named `azurefile-csi` that you can use to create persistent volume claims (PVCs).
+* The _Azure File CSI Driver Operator_ provides a storage class that is named `azurefile-csi` that you can use to create persistent volume claims (PVCs). 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]).
 
 * The _Azure File CSI driver_ enables you to create and mount Azure File PVs. The Azure File CSI driver supports dynamic volume provisioning by allowing storage volumes to be created on-demand, eliminating the need for cluster administrators to pre-provision storage.
 
diff --git a/storage/container_storage_interface/persistent-storage-csi-azure.adoc b/storage/container_storage_interface/persistent-storage-csi-azure.adoc
@@ -14,7 +14,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned PVs that mount to Azure Disk storage assets, {product-title} installs the Azure Disk CSI Driver Operator and the Azure Disk CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
 
-* The _Azure Disk CSI Driver Operator_ provides a storage class named `managed-csi` that you can use to create persistent volume claims (PVCs). The Azure Disk 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.
+* The _Azure Disk CSI Driver Operator_ provides a storage class named `managed-csi` that you can use to create persistent volume claims (PVCs). The Azure Disk 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]).
 
 * The _Azure Disk CSI driver_ enables you to create and mount Azure Disk PVs.
 
diff --git a/storage/container_storage_interface/persistent-storage-csi-cinder.adoc b/storage/container_storage_interface/persistent-storage-csi-cinder.adoc
@@ -14,7 +14,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned PVs that mount to OpenStack Cinder storage assets, {product-title} installs the OpenStack Cinder CSI Driver Operator and the OpenStack Cinder CSI driver in the `openshift-cluster-csi-drivers` namespace.
 
-* The _OpenStack Cinder CSI Driver Operator_ provides a CSI storage class that you can use to create PVCs.
+* The _OpenStack Cinder CSI Driver Operator_ provides a CSI storage class that you can use to create PVCs. 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]).
 
 * The _OpenStack Cinder CSI driver_ enables you to create and mount OpenStack Cinder PVs.
 
diff --git a/storage/container_storage_interface/persistent-storage-csi-ebs.adoc b/storage/container_storage_interface/persistent-storage-csi-ebs.adoc
@@ -14,7 +14,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned PVs that mount to AWS EBS storage assets, {product-title} installs the AWS EBS CSI Driver Operator and the AWS EBS CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
 
-* The _AWS EBS CSI Driver Operator_ provides a StorageClass by default that you can use to create PVCs. You also have the option to create the AWS EBS StorageClass as described in xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using AWS Elastic Block Store].
+* The _AWS EBS CSI Driver Operator_ provides a StorageClass by default that you can use to create PVCs. 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]). You also have the option to create the AWS EBS StorageClass as described in xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using AWS Elastic Block Store]. 
 
 * The _AWS EBS CSI driver_ enables you to create and mount AWS EBS PVs.
 
diff --git a/storage/container_storage_interface/persistent-storage-csi-gcp-pd.adoc b/storage/container_storage_interface/persistent-storage-csi-gcp-pd.adoc
@@ -16,7 +16,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned persistent volumes (PVs) that mount to GCP PD storage assets, {product-title} installs the GCP PD CSI Driver Operator and the GCP PD CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
 
-* *GCP PD CSI Driver Operator*: By default, the Operator provides a storage class that you can use to create PVCs. You also have the option to create the GCP PD storage class as described in xref:../../storage/persistent_storage/persistent-storage-gce.adoc#persistent-storage-using-gce[Persistent storage using GCE Persistent Disk].
+* *GCP PD CSI Driver Operator*: By default, the Operator provides a storage class that you can use to create PVCs. 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]). You also have the option to create the GCP PD storage class as described in xref:../../storage/persistent_storage/persistent-storage-gce.adoc#persistent-storage-using-gce[Persistent storage using GCE Persistent Disk].
 
 * *GCP PD driver*: The driver enables you to create and mount GCP PD PVs.
 
diff --git a/storage/container_storage_interface/persistent-storage-csi-ibm-vpc-block.adoc b/storage/container_storage_interface/persistent-storage-csi-ibm-vpc-block.adoc
@@ -13,7 +13,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned PVs that mount to IBM VPC Block storage assets, {product-title} installs the IBM VPC Block CSI Driver Operator and the IBM VPC Block CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
 
-* The _IBM VPC Block CSI Driver Operator_ provides three storage classes named `ibmc-vpc-block-10iops-tier` (default), `ibmc-vpc-block-5iops-tier`, and `ibmc-vpc-block-custom` for different tiers that you can use to create persistent volume claims (PVCs). The IBM VPC Block 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.
+* The _IBM VPC Block CSI Driver Operator_ provides three storage classes named `ibmc-vpc-block-10iops-tier` (default), `ibmc-vpc-block-5iops-tier`, and `ibmc-vpc-block-custom` for different tiers that you can use to create persistent volume claims (PVCs). The IBM VPC Block 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]).
 
 * The _IBM VPC Block CSI driver_ enables you to create and mount IBM VPC Block PVs.
 
diff --git a/storage/container_storage_interface/persistent-storage-csi-ovirt.adoc b/storage/container_storage_interface/persistent-storage-csi-ovirt.adoc
@@ -14,7 +14,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned PVs that mount to {rh-virtualization} storage assets, {product-title} installs the oVirt CSI Driver Operator and the oVirt CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
 
-* The _oVirt CSI Driver Operator_ provides a default `StorageClass` object that you can use to create Persistent Volume Claims (PVCs).
+* The _oVirt CSI Driver Operator_ provides a default `StorageClass` object that you can use to create Persistent Volume Claims (PVCs). 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]).
 
 * The _oVirt CSI driver_ enables you to create and mount oVirt PVs.
 
diff --git a/storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc b/storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc
@@ -0,0 +1,52 @@
+:_content-type: ASSEMBLY
+[id="persistent-storage-csi-sc-manage"]
+= Managing the default storage class
+include::_attributes/common-attributes.adoc[]
+:context: persistent-storage-csi-sc-manage
+
+toc::[]
+
+== Overview
+
+Managing the default storage class allows you to accomplish several different objectives:
+
+* Enforcing static provisioning by disabling dynamic provisioning.
+
+* When you have other preferred storage classes, preventing the storage operator from re-creating the initial default storage class.
+
+* Renaming, or otherwise changing, the default storage class
+
+To accomplish these objectives, you change the setting for the `spec.storageClassState` field in the `ClusterCSIDriver` object. The possible settings for this field are:
+
+* *Managed*: (Default) The Container Storage Interface (CSI) operator is actively managing its default storage class, so that most manual changes made by a cluster administrator to the default storage class are removed, and the default storage class is continuously re-created if you attempt to manually delete it.
+
+* *Unmanaged*: You can modify the default storage class. The CSI operator is not actively managing storage classes, so that it is not reconciling the default storage class it creates automatically. 
+
+* *Removed*: The CSI operators deletes the default storage class.
+
+ifndef::openshift-rosa,openshift-dedicated[]
+Managing the default storage classes is supported by the following Container Storage Interface (CSI) driver operators:
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-alicloud-disk.adoc#persistent-storage-csi-alicloud-disk[AliCloud Disk]
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-ebs.adoc#persistent-storage-csi-ebs[Amazon Web Services (AWS) Elastic Block Storage (EBS)]
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-azure.adoc#persistent-storage-csi-azure-disk[Azure Disk]
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-azure-file.adoc#persistent-storage-csi-azure-file[Azure File]
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-gcp-pd.adoc#persistent-storage-csi-gcp-pd[Google Cloud Platform (GCP) Persistent Disk (PD)]
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-ibm-vpc-block.adoc#persistent-storage-csi-ibm-vpc-block[IBM VPC Block]
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-cinder.adoc#persistent-storage-csi-cinder[OpenStack Cinder]
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-ovirt.adoc#persistent-storage-csi-ovirt[Red Hat Virtualization]
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-vsphere[VMWare vSphere]
+endif::openshift-rosa,openshift-dedicated[]
+
+include::modules/persistent-storage-csi-sc-managing.adoc[leveloffset=+1]
+include::modules/persistent-storage-csi-sc-managing-cli.adoc[leveloffset=+1]
+include::modules/persistent-storage-csi-sc-multiple-none.adoc[leveloffset=+1]
+include::modules/dynamic-provisioning-change-default-class.adoc[leveloffset=+1]
diff --git a/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc b/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
@@ -14,7 +14,7 @@ Familiarity with xref:../../storage/understanding-persistent-storage.adoc#unders
 
 To create CSI-provisioned persistent volumes (PVs) that mount to vSphere storage assets, {product-title} installs the vSphere CSI Driver Operator and the vSphere CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
 
-* *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.
+* *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.12, the driver version is 2.6.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].
 
