Bug 1859117 - Proposal for a new Structure for Deplyoment Guide at-least from OCS 4.5 onwards
Summary: Proposal for a new Structure for Deplyoment Guide at-least from OCS 4.5 onwards
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenShift Container Storage
Classification: Red Hat Storage
Component: documentation
Version: 4.5
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: OCS 4.5.0
Assignee: Olive Lakra
QA Contact: Neha Berry
URL:
Whiteboard:
Depends On:
Blocks: 1826397
TreeView+ depends on / blocked
 
Reported: 2020-07-21 09:48 UTC by Neha Berry
Modified: 2020-09-16 07:43 UTC (History)
12 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-09-16 07:42:52 UTC
Embargoed:


Attachments (Terms of Use)

Description Neha Berry 2020-07-21 09:48:19 UTC
Description of problem (please be detailed as possible and provide log
snippests):
---------------------------------------------------------------------
Deployment GUide for reference: https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.4/html-single/deploying_openshift_container_storage/index

Some pain points:
1. Following sections are common and needed for all kinds of Deployments - i.e. Converged (Dynamic Provisioned, LSO) and External. Hence, it should not just be added for current Chapter #1 (as it is applicable for LSO as well)

>> Installing Red Hat OpenShift Container Storage Operator using the Operator Hub
 and 
>> Enabling file system access for containers on Red Hat Enterprise Linux based nodes

2. Under LSO section 2, we have "Install Red Hat OpenShift Container Storage Operator." but it is not added in the navigation pane as 2.2. This can lead to confusions and at times, users may miss to Install the Operator from Operator Hub before proceeding with deployment of OCS cluster  service.

3. The verifications of Deployment will change based on converged and External Mode.

Me, Bipin, Olive got together on a call and came up with a proposed hirarchy & structure for the deployment Guide

https://docs.google.com/document/d/1MHBnOgWddSWtRiNws_PKj3rrsxJ_R5Awmb36j15MGzI/edit?ts=5f169d7a#heading=h.cx0db6sbx149

Please review and let us know if we can change the current OCS 4.5 deployment guide to reflect this new Structure. Feel free to share your comments in the gdoc.

P.S: some changes already sugggested and part of : https://bugzilla.redhat.com/show_bug.cgi?id=1840831


Note: As of now, it would be good to have the suggested changes only in OCS 4.5 docs onwards. Re-structuring the whole OCS 4.4 docs may be an overhead.. Lets decide


Version of all relevant components (if applicable):
--------------------------------------------
Atleast from OCS 4.5 onwards.

Comment 14 Neha Berry 2020-08-18 19:27:33 UTC
@olive

While updating for changes in the external mode g-doc [1], it is seen that it anyways doesn't have the latest content of preview link .. There have been quite a few changes already.

Wont it be confusing if we continue to update on older g-doc ? Please let me know.

https://docs.google.com/document/d/1LzAqBcwoonp4pcfjylpfcG1bt8Dr7QEM_8k9c-XBhT0/edit#

Comment 16 Neha Berry 2020-08-26 20:56:28 UTC
Hi Olive,

DEPLOYING OPENSHIFT CONTAINER STORAGE ON VMWARE VSPHERE
https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage_on_vmware_vsphere/index?lb_target=stage

>>for Uninstall section  Removing OpenShift Container Platform registry from OpenShift Container Storage, please change the After editing to below mentioned output

Procedure

After editing

.
.
storage:
  emptyDir: {}
.
.


DEPLOYING OPENSHIFT CONTAINER STORAGE USING BARE METAL INFRASTRUCTURE
https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage_using_bare_metal_infrastructure/index?lb_target=stage

>>for Uninstall section  Removing OpenShift Container Platform registry from OpenShift Container Storage, please change the After editing to below mentioned output

Procedure

After editing

.
.
storage:
  emptyDir: {}
.
.

DEPLOYING OPENSHIFT CONTAINER STORAGE IN EXTERNAL MODE
https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/deploying_openshift_container_storage_in_external_mode/index?lb_target=stage

Procedure

After editing

.
.
storage:
  emptyDir: {}

Comment 24 Neha Berry 2020-09-02 07:24:43 UTC
Thank You JC for the valuable inputs. The change needed for RGW pods is updated in the gdoc for both VMW and BM


Regarding this:

````

- Chapter 2.1
NOTE
When you need to override the cluster-wide default node selector for OpenShift
Container Storage, you can perform the following steps through the command line
interface:

This has been stated before in Chapter 1.3 and does not belong to this chapter
imho. It is too late at this point to mention this this way.

```

When this content was decided based on a engg bug, it was added in 2 places for 2 different use case: 

Added in 1.3 for people who are yet to deploy their OCS and can set this setting beforehand
Added in Verifying PODS section for those who already have OCS installed without this setting and their CSI pods might be in CLBO. To come  out of it, one needs to run the commands of section 2.1 to bring up the CSI pods. 

I agree the reason for having it in 2 places should have been explicitly state in the sections.

Comment 31 Martin Bukatovic 2020-09-15 08:38:39 UTC
Dropping needinfo request on myself.


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