Bug 2258621 - Improve the section " Creating an OpenShift Data Foundation Cluster for external IBM FlashSystem storage"
Summary: Improve the section " Creating an OpenShift Data Foundation Cluster for exter...
Keywords:
Status: NEW
Alias: None
Product: Red Hat OpenShift Data Foundation
Classification: Red Hat Storage
Component: documentation
Version: 4.14
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: ---
Assignee: Kusuma
QA Contact: Neha Berry
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2024-01-16 15:11 UTC by Bipin Kunal
Modified: 2024-01-18 07:48 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Embargoed:


Attachments (Terms of Use)

Description Bipin Kunal 2024-01-16 15:11:31 UTC
Describe the issue: The section "3.2. Creating an OpenShift Data Foundation Cluster for external IBM FlashSystem storage" in the External Mode doc[1] is not complete in the sense that it doesn't give all the needed details for anyone to understand what is expected from this deployment. 

[1] https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.13/html/deploying_openshift_data_foundation_in_external_mode/deploy-openshift-data-foundation-using-ibm-flashsystem#creating-an-openshift-data-foundation-cluster-for-ibm-flashsystem-storage_ibmfs-external

Describe the task you were trying to accomplish:
 - I was trying to understand the difference wrt to External ceph and Internal mode deployment
 I was trying to understand what all pods will be available after the deployment.

Suggestions for improvement:

- Add some details at the beginning to help the reader understand what external IBM flashsystem deployment means and how it works. 

- In the deployment procedure section, point 4 says
--------------------------------
  i. Enter a name for the storage class.

  When creating block storage persistent volumes, select the storage class 
  <storage_class_name> for best performance. The storage class allows direct I/O 
  path to the FlashSystem.

--------------------------------

  Not sure if "<storage_class_name>" needs to be replaced with the correct name. As a reader, I am expecting that but I am not sure what is technically correct here. 

- The list of pods in the section "Verification Steps" is not complete. I expect a lot many more pods to be created after storgesystem creation done in the previous step. 





Document URL: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.13/html/deploying_openshift_data_foundation_in_external_mode/deploy-openshift-data-foundation-using-ibm-flashsystem#creating-an-openshift-data-foundation-cluster-for-ibm-flashsystem-storage_ibmfs-external

Chapter/Section Number and Title:
3.2. Creating an OpenShift Data Foundation Cluster for external IBM FlashSystem storage

Product Version: All active versions


Note You need to log in before you can comment on or make changes to this bug.