OSDOCS-11443: Remove duplicated content from Storage section in posti…

…nstallation guide
openshift · Jul 25, 2024 · 63d4a60 · 63d4a60
1 parent 0bc794c
commit 63d4a60
Show file tree

Hide file tree

Showing 22 changed files with 19 additions and 77 deletions.
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -624,7 +624,7 @@ Topics:
 - Name: Network configuration
   File: network-configuration
 - Name: Storage configuration
-  File: storage-configuration
+  File: post-install-storage-configuration
 - Name: Preparing for users
   File: preparing-for-users
 - Name: Changing the cloud provider credentials configuration

diff --git a/modules/available-persistent-storage-options.adoc b/modules/available-persistent-storage-options.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // * storage/optimizing-storage.adoc
-// * post_installation_configuration/storage-configuration.adoc
 
 [id="available-persistent-storage-options_{context}"]
 = Available persistent storage options

diff --git a/modules/dynamic-provisioning-about.adoc b/modules/dynamic-provisioning-about.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 // * microshift_storage/dynamic-provisioning-microshift.adoc
 
 :_mod-docs-content-type: CONCEPT

diff --git a/modules/dynamic-provisioning-annotations.adoc b/modules/dynamic-provisioning-annotations.adoc
@@ -1,10 +1,8 @@
 // Module included in the following assemblies
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 // * microshift_storage/dynamic-provisioning-microshift.adoc
 
-
 [id="storage-class-annotations_{context}"]
 = Storage class annotations
 

diff --git a/modules/dynamic-provisioning-available-plugins.adoc b/modules/dynamic-provisioning-available-plugins.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 
 [id="available-plug-ins_{context}"]
 = Available dynamic provisioning plugins

diff --git a/modules/dynamic-provisioning-aws-definition.adoc b/modules/dynamic-provisioning-aws-definition.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 
 [id="aws-definition_{context}"]
 = AWS Elastic Block Store (EBS) object definition

diff --git a/modules/dynamic-provisioning-azure-disk-definition.adoc b/modules/dynamic-provisioning-azure-disk-definition.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 
 [id="azure-disk-definition_{context}"]
 = Azure Disk object definition

diff --git a/modules/dynamic-provisioning-azure-file-considerations.adoc b/modules/dynamic-provisioning-azure-file-considerations.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // storage/persistent_storage/persistent-storage-azure-file.adoc
-// * post_installation_configuration/storage-configuration.adoc
 
 [id="azure-file-considerations_{context}"]
 = Considerations when using Azure File

diff --git a/modules/dynamic-provisioning-azure-file-definition.adoc b/modules/dynamic-provisioning-azure-file-definition.adoc
@@ -1,8 +1,6 @@
 // Module included in the following assemblies
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
-
 
 :_mod-docs-content-type: PROCEDURE
 [id="azure-file-definition_{context}"]

diff --git a/modules/dynamic-provisioning-change-default-class.adoc b/modules/dynamic-provisioning-change-default-class.adoc
@@ -1,10 +1,8 @@
 // Module included in the following assemblies:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 // * microshift_storage/dynamic-provisioning-microshift.adoc
 
-
 [id="change-default-storage-class_{context}"]
 = Changing the default storage class
 
@@ -47,7 +45,7 @@ $ oc patch storageclass standard -p '{"metadata": {"annotations": {"storageclass
 +
 [NOTE]
 ====
-You can have multiple default storage classes for a short time. However, you should ensure that only one default storage class exists eventually. 
+You can have multiple default storage classes for a short time. However, you should ensure that only one default storage class exists eventually.
 
 With multiple default storage classes present, any persistent volume claim (PVC) requesting the default storage class (`pvc.spec.storageClassName`=nil) gets the most recently created default storage class, regardless of the default status of that storage class, and the administrator receives an alert in the alerts dashboard that there are multiple default storage classes, `MultipleDefaultStorageClasses`.
 

diff --git a/modules/dynamic-provisioning-cinder-definition.adoc b/modules/dynamic-provisioning-cinder-definition.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 
 [id="openstack-cinder-storage-class_{context}"]
 = {rh-openstack} Cinder object definition

diff --git a/modules/dynamic-provisioning-defining-storage-class.adoc b/modules/dynamic-provisioning-defining-storage-class.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 // * microshift_storage/dynamic-provisioning-microshift.adoc
 
 

diff --git a/modules/dynamic-provisioning-gce-definition.adoc b/modules/dynamic-provisioning-gce-definition.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 
 [id="gce-persistentdisk-storage-class_{context}"]
 = GCE PersistentDisk (gcePD) object definition

diff --git a/modules/dynamic-provisioning-storage-class-definition.adoc b/modules/dynamic-provisioning-storage-class-definition.adoc
@@ -1,7 +1,6 @@
 // Module included in the following assemblies:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
 // * microshift_storage/dynamic-provisioning-microshift.adoc
 
 

diff --git a/modules/dynamic-provisioning-vsphere-definition.adoc b/modules/dynamic-provisioning-vsphere-definition.adoc
@@ -1,8 +1,6 @@
 // Module included in the following definitions:
 //
 // * storage/dynamic-provisioning.adoc
-// * post_installation_configuration/storage-configuration.adoc
-
 
 [id="vsphere-definition_{context}"]
 = VMware vSphere object definition
@@ -19,4 +17,4 @@ provisioner: csi.vsphere.vmware.com <2>
 <1> Name of the storage class. The persistent volume claim uses this storage class for provisioning the associated persistent volumes.
 <2> For more information about using VMware vSphere CSI with {product-title},
 see the
-link:https://kubernetes.io/docs/concepts/storage/volumes/#vsphere-csi-migration[Kubernetes documentation].
+link:https://kubernetes.io/docs/concepts/storage/volumes/#vsphere-csi-migration[Kubernetes documentation].
diff --git a/post_installation_configuration/cluster-tasks.adoc b/post_installation_configuration/cluster-tasks.adoc
@@ -664,7 +664,7 @@ include::modules/dr-restoring-cluster-state.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
-
+* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 * xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal]
 * xref:../installing/index.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node]
 

diff --git a/post_installation_configuration/index.adoc b/post_installation_configuration/index.adoc
@@ -63,7 +63,7 @@ The following lists details these configurations:
 ** Network policy
 ** Enabling the cluster-wide proxy
 
-* xref:../post_installation_configuration/storage-configuration.adoc#post-install-storage-configuration[Configure storage]:
+* xref:../post_installation_configuration/post-install-storage-configuration.adoc#post-install-storage-configuration[Configure storage]:
 By default, containers operate by using the ephemeral storage or transient local storage. The ephemeral storage has a lifetime limitation. To store the data for a long time, you must configure persistent storage. You can configure storage by using one of the following methods:
 
 ** *Dynamic provisioning*: You can dynamically provision storage on demand by defining and creating storage classes that control different levels of storage, including storage access.

diff --git a/..._configuration/storage-configuration.adoc → ...n/post-install-storage-configuration.adoc b/..._configuration/storage-configuration.adoc → ...n/post-install-storage-configuration.adoc
@@ -26,61 +26,23 @@ cluster to your requirements, including storage configuration.
 [id="post-install-dynamic-provisioning"]
 == Dynamic provisioning
 
-include::modules/dynamic-provisioning-about.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-available-plugins.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-defining-storage-class.adoc[leveloffset=+1]
-
-include::modules/dynamic-provisioning-storage-class-definition.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-annotations.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-cinder-definition.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-aws-definition.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-azure-disk-definition.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-azure-file-definition.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-azure-file-considerations.adoc[leveloffset=+3]
-
-include::modules/dynamic-provisioning-gce-definition.adoc[leveloffset=+2]
+Dynamic Provisioning allows you to create storage volumes on-demand, eliminating the need for cluster administrators to pre-provision storage. See xref:../storage/dynamic-provisioning.adoc#dynamic-provisioning[Dynamic provisioning].
 
 // include::modules/dynamic-provisioning-gluster-definition.adoc[leveloffset=+2]
 
 // include::modules/dynamic-provisioning-ceph-rbd-definition.adoc[leveloffset=+2]
 
-include::modules/dynamic-provisioning-vsphere-definition.adoc[leveloffset=+2]
-
-include::modules/dynamic-provisioning-change-default-class.adoc[leveloffset=+1]
-
-[id="post-install-optimizing-storage"]
-== Optimizing storage
-
-Optimizing storage helps to minimize storage use across all resources. By
-optimizing storage, administrators help ensure that existing storage resources
-are working in an efficient manner.
-
-include::modules/available-persistent-storage-options.adoc[leveloffset=+1]
-
 include::modules/recommended-configurable-storage-technology.adoc[leveloffset=+1]
 
-[role="_additional-resources"]
-.Additional resources
-
-* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
-
-
 [id="post-install-deploy-OCS"]
 == Deploy Red Hat OpenShift Data Foundation
 // This section is sourced from storage/persistent_storage/persistent-storage-ocs.adoc
-{rh-storage-first} is a provider of agnostic persistent storage for {product-title} supporting file, block, and object storage, either in-house or in hybrid clouds. As a Red Hat storage solution, {rh-storage-first} is completely integrated with {product-title} for deployment, management, and monitoring.
 
-include::modules/deploy-red-hat-openshift-container-storage.adoc[leveloffset=+1]
+{rh-storage-first} is a provider of agnostic persistent storage for {product-title} supporting file, block, and object storage, either in-house or in hybrid clouds. As a Red Hat storage solution, {rh-storage-first} is completely integrated with {product-title} for deployment, management, and monitoring. For more information, see the link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation[{rh-storage-first} documentation].
+
+[IMPORTANT]
+====
+{rh-storage} on top of Red Hat Hyperconverged Infrastructure (RHHI) for Virtualization, which uses hyperconverged nodes that host virtual machines installed with {product-title}, is not a supported configuration. For more information about supported platforms, see the link:https://access.redhat.com/articles/4731161[Red Hat OpenShift Data Foundation Supportability and Interoperability Guide].
+====
 
-[role="_additional-resources"]
-[id="admission-plug-ins-additional-resources"]
-== Additional resources
-* xref:../observability/logging/log_storage/logging-config-es-store.adoc#logging-config-es-store[Configuring the Elasticsearch log store]
+include::modules/deploy-red-hat-openshift-container-storage.adoc[leveloffset=+2]
diff --git a/storage/persistent_storage/persistent-storage-ocs.adoc b/storage/persistent_storage/persistent-storage-ocs.adoc
@@ -6,9 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-{rh-storage-first} is a provider of agnostic persistent storage for {product-title} supporting file, block, and object storage, either in-house or in hybrid clouds. As a Red Hat storage solution, {rh-storage-first} is completely integrated with {product-title} for deployment, management, and monitoring.
-
-{rh-storage-first} provides its own documentation library. The complete set of {rh-storage-first} documentation is available at https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation.
+{rh-storage-first} is a provider of agnostic persistent storage for {product-title} supporting file, block, and object storage, either in-house or in hybrid clouds. As a Red Hat storage solution, {rh-storage-first} is completely integrated with {product-title} for deployment, management, and monitoring. For more information, see the link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation[{rh-storage-first} documentation].
 
 [IMPORTANT]
 ====

diff --git a/virt/post_installation_configuration/virt-post-install-storage-config.adoc b/virt/post_installation_configuration/virt-post-install-storage-config.adoc
@@ -9,7 +9,7 @@ toc::[]
 The following storage configuration tasks are mandatory:
 
 ifndef::openshift-rosa,openshift-dedicated[]
-* You must configure a xref:../../post_installation_configuration/storage-configuration.adoc#defining-storage-classes_post-install-storage-configuration[default storage class] for your cluster. Otherwise, the cluster cannot receive automated boot source updates.
+* You must configure a xref:../../storage/dynamic-provisioning.adoc#defining-storage-classes_dynamic-provisioning[default storage class] for your cluster. Otherwise, the cluster cannot receive automated boot source updates.
 endif::openshift-rosa,openshift-dedicated[]
 * You must configure xref:../../virt/storage/virt-configuring-storage-profile.adoc#virt-configuring-storage-profile[storage profiles] if your storage provider is not recognized by CDI. A storage profile provides recommended storage settings based on the associated storage class.
 

diff --git a/virt/storage/virt-automatic-bootsource-updates.adoc b/virt/storage/virt-automatic-bootsource-updates.adoc
@@ -31,13 +31,13 @@ _Custom_ boot sources that are not provided by {VirtProductName} are not control
 ifndef::openshift-rosa,openshift-dedicated[]
 [IMPORTANT]
 ====
-You must configure a storage class. Otherwise, the cluster cannot receive automated updates for custom boot sources. See xref:../../post_installation_configuration/storage-configuration.adoc#defining-storage-classes_post-install-storage-configuration[Defining a storage class] for details. 
+You must configure a storage class. Otherwise, the cluster cannot receive automated updates for custom boot sources. See xref:../../storage/dynamic-provisioning.adoc#defining-storage-classes_dynamic-provisioning[Defining a storage class] for details. 
 ====
 endif::openshift-rosa,openshift-dedicated[]
 ifdef::openshift-rosa,openshift-dedicated[]
 [IMPORTANT]
 ====
-You must configure a storage profile. Otherwise, the cluster cannot receive automated updates for custom boot sources. See xref:../../virt/storage/virt-configuring-storage-profile.adoc#virt-configuring-storage-profile[Configure storage profiles] for details. 
+You must configure a storage profile. Otherwise, the cluster cannot receive automated updates for custom boot sources. See xref:../../virt/storage/virt-configuring-storage-profile.adoc#virt-configuring-storage-profile[Configure storage profiles] for details.
 ====
 endif::openshift-rosa,openshift-dedicated[]
 

diff --git a/virt/storage/virt-storage-config-overview.adoc b/virt/storage/virt-storage-config-overview.adoc
@@ -14,7 +14,7 @@ You can configure a default storage class, storage profiles, Containerized Data
 The following storage configuration tasks are mandatory:
 
 ifndef::openshift-rosa,openshift-dedicated[]
-xref:../../post_installation_configuration/storage-configuration.adoc#defining-storage-classes_post-install-storage-configuration[Configure a default storage class]::
+xref:../../storage/dynamic-provisioning.adoc#defining-storage-classes_dynamic-provisioning[Configure a default storage class]::
 
 You must configure a default storage class for your cluster. Otherwise, the cluster cannot receive automated boot source updates.
 endif::openshift-rosa,openshift-dedicated[]
@@ -68,4 +68,4 @@ You can perform the following boot source update configuration task:
 
 xref:../../virt/storage/virt-automatic-bootsource-updates.adoc#virt-automatic-bootsource-updates[Manage automatic boot source updates]::
 
-Boot sources can make virtual machine (VM) creation more accessible and efficient for users. If automatic boot source updates are enabled, CDI imports, polls, and updates the images so that they are ready to be cloned for new VMs. By default, CDI automatically updates Red Hat boot sources. You can enable automatic updates for custom boot sources.
+Boot sources can make virtual machine (VM) creation more accessible and efficient for users. If automatic boot source updates are enabled, CDI imports, polls, and updates the images so that they are ready to be cloned for new VMs. By default, CDI automatically updates Red Hat boot sources. You can enable automatic updates for custom boot sources.