Bug 1866809

Summary: [Doc Troubleshooting Guide]OCS uninstall : Document workaround when openshift-project is stuck in Terminating state
Product: [Red Hat Storage] Red Hat OpenShift Container Storage Reporter: Neha Berry <nberry>
Component: documentationAssignee: Agil Antony <agantony>
Status: CLOSED CURRENTRELEASE QA Contact: Anna Sandler <asandler>
Severity: high Docs Contact:
Priority: high    
Version: 4.5CC: agantony, bkunal, ebenahar, jarrpa, jelopez, ocs-bugs, rtalur
Target Milestone: ---   
Target Release: OCS 4.5.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1826397    

Description Neha Berry 2020-08-06 12:52:23 UTC
Description of problem (please be detailed as possible and provide log
snippests):
------------------------------------------------------------------------
Currently in OCS docs, we have the following Note in case deletion of oenshift-storage project is not successful and is stuck in terminating state


""""""

[NOTE]

While uninstalling OpenShift Container Storage, if namespace is not deleted completely and remains in Terminating state, perform the steps in the article https://access.redhat.com/solutions/3881901 to identify objects that are blocking the namespace from being terminated. OpenShift objects such as Cephcluster, StorageCluster, NooBaa, and PVC that have the finalizers might be the cause for the namespace to be in Terminating state. If PVC has a finalizer, force delete the associated pod to remove the finalizer.

"""""

The steps to mitigate the issue in https://access.redhat.com/solutions/3881901 are not clear enough and it would be better to have a separate section in Troubleshooting guide to explain the problem and the workaround. With some common examples.

Then we can link to the Troubleshooting guide, instead of the above article.

Some details -  Bug 1856083 - UNINSTALLING OPENSHIFT CONTAINER STORAGE - CRD cephclients and finalizers




Version of all relevant components (if applicable):
---------------------------

Atleast from OCS 4.5 onwards.

Comment 3 Jose A. Rivera 2020-08-11 17:41:23 UTC
Talur, could you verify these changes?

Comment 5 Neha Berry 2020-08-17 07:38:38 UTC
After a meeting with Agil and Bipin on Thursday, we came up with consolidated steps for the troubleshooting Guide here [1]

https://docs.google.com/document/d/1A8Lc4n50ZGJsPNoo-4-cr0bTnomrpsdIJ_asejJM-9c/edit?userstoinvite=agantony%40redhat.com&ts=5f33f727&actionButton=1

Comment 8 Agil Antony 2020-08-18 10:14:46 UTC
I have incorporated the review comments. Please cross check the draft in comment #6.

Comment 13 Neha Berry 2020-08-19 08:50:42 UTC
(In reply to Agil Antony from comment #11)
> Hi, 
> 
> @all 
> 
> 
> Here is the preview link : 
> 
> https://access.redhat.com/documentation/en-us/
> red_hat_openshift_container_storage/4.5/html-single/
> troubleshooting_openshift_container_storage/
> index?lb_target=preview#troubleshooting-and-deleting-remaining-resources-
> during-uninstall_rhocs
> 
> [gitlab]: 
> https://gitlab.cee.redhat.com/red-hat-openshift-container-storage-
> documentation/red-hat-openshift-container-storage-4.5/-/merge_requests/110/
> diffs
> 
> Please use the draft to put in your comments and suggestions (if any).
> [comment #6]
> 
> Thanks,

Requesting one more round of review from JC and Bipin

Comment 16 Neha Berry 2020-08-19 20:10:17 UTC
@Agil,

Few more suggestions for adding "extra line before Output" added in the gdoc https://docs.google.com/document/d/1_6VzcV_uaPaXUSaRSb9CDapfrwFsu6Klqbs-By6KCKw/edit

Comment 18 Anna Sandler 2020-08-24 07:06:53 UTC
The troubleshooting guide  is clear.

Comment 20 Neha Berry 2020-09-03 04:57:12 UTC
Hi Agil, 

can we add a small change in the docs for Step 2 . It is a little urgent as at times, one needs to look for both the messages

Current current: 2. Check for the NamespaceFinalizersRemaining messages in the STATUS section of the command output and perform the next step for each of the listed resources.

Suggested statement: 2. Check for the NamespaceFinalizersRemaining and NamespaceContentRemaining messages in the STATUS section of the command output and perform the next step for each of the listed resources.