Bug 1932224 - OCS 4.6 docs: oc debug command in some of the guides is incorrect
Summary: OCS 4.6 docs: oc debug command in some of the guides is incorrect
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenShift Container Storage
Classification: Red Hat Storage
Component: documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: OCS 4.6.z Async
Assignee: Olive Lakra
QA Contact: Mugdha Soni
URL:
Whiteboard:
: 1950979 (view as bug list)
Depends On:
Blocks: 1921782
TreeView+ depends on / blocked
 
Reported: 2021-02-24 09:56 UTC by Rachael
Modified: 2022-01-24 17:56 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-01-24 17:56:46 UTC
Embargoed:


Attachments (Terms of Use)

Description Rachael 2021-02-24 09:56:58 UTC
Describe the issue:

The oc debug command mentioned in some of the guides mentioned below are incorrect.

Example:
"i. Create a debug pod and chroot to the host on the storage node.

$ oc debug node <node name>
$ chroot /host"

$ oc debug node compute-0
Error from server (NotFound): pods "node" not found

The correct command is : 

$ oc debug node/<node name>
$ chroot /host


Chapter/Section Number and Title:

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html/deploying_openshift_container_storage_using_amazon_web_services/assembly_uninstalling-openshift-container-storage_rhocs#uninstalling-openshift-container-storage-in-internal-mode_rhocs
  - Procedure, Step 6.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_openshift_container_storage_on_vmware_vsphere/index#uninstalling-openshift-container-storage-in-internal-mode_rhocs
  - Procedure, Step 6.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_openshift_container_storage_using_bare_metal_infrastructure/index#uninstalling-openshift-container-storage-in-internal-mode_rhocs
  - Procedure, Step 6.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_openshift_container_storage_using_microsoft_azure/index
  - 3.1. Uninstalling OpenShift Container Storage in Internal mode, Procedure, Step 6.i
  - 8.2. Scaling up storage by adding capacity to your OpenShift Container Storage nodes on Microsoft Azure infrastructure, Verification, Last point (a)
  - 13.1. Replacing operational nodes on Azure installer-provisioned infrastructure, Verification, step 5.i
  - 13.2. Replacing failed nodes on Azure installer-provisioned infrastructure, Verification, Step 5.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_google_cloud/index
  - 3.1. Uninstalling OpenShift Container Storage in Internal mode, Procedure, Step 6.i
  - 8.2. Scaling up storage by adding capacity to your OpenShift Container Storage nodes on Google Cloud infrastructure, Verification, Last point (a)
  - 13.1. Replacing operational nodes on Google Cloud installer-provisioned infrastructure, Verification, step 5.i
  - 13.2. Replacing failed nodes on Google Cloud installer-provisioned infrastructure, Verification, Step 5.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_red_hat_virtualization_platform/index
  -  3.1. Uninstalling OpenShift Container Storage in Internal mode, Procedure, Step 6.i
  - 8.2. Scaling up storage by adding capacity to your OpenShift Container Storage nodes using local storage devices, Verification, Last point (a)
  - 13.1. Replacing an operational node on Red Hat Virtualization installer-provisioned infrastructure, Verification, step 5.i
  - 13.2 Replacing failed nodes on Red Hat Virtualization installer-provisioned infrastructure, Verification, step 5.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_red_hat_openstack_platform/index
  - 1.4.1. Uninstalling OpenShift Container Storage in Internal mode, Procedure, Step 6.i
  - 7.2. Scaling up storage by adding capacity to your OpenShift Container Storage nodes on Red Hat OpenStack Platform infrastructure, Verification, Last point (a)
  - 12.1. Replacing operational nodes on Red Hat OpenStack Platform installer-provisioned infrastructure, Verification, step 5.i
  - 12.2. Replacing failed nodes on Red Hat OpenStack Platform installer-provisioned infrastructure, Verification, step 5.i
  - 13.1. Replacing operational or failed storage devices on Red Hat OpenStack Platform installer-provisioned infrastructure, 
    - Procedure, step 6, i
    - Verification, Step c.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_ibm_z/index
  - 3.1. Uninstalling OpenShift Container Storage in Internal-attached devices mode, Procedure, Step 6.i
  - 5.1. Replacing operational nodes on IBM Z, Verification, step 5.i
  - 5.2. Replacing failed nodes on IBM Z, Procedure, Step 13.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_ibm_power_systems/index
  - 4.1. Uninstalling OpenShift Container Storage on Internal mode, Procedure, Step 6.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/replacing_devices/index
  - 2.1. Replacing operational or failed storage devices on VMware user-provisioned infrastructure, 
    - Procedure, Step 6.i
    - Verification, Step c.i
  - 4.3. Replacing operational or failed storage devices on clusters backed by local storage devices, 
    - Procedure, Step 6.i
    - Verification, Step 3.i

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/replacing_nodes/index
  - Verification, Step 5.i in sections 1.1, 1.2, 1.3, 1.4, 2.1, 2.2, 3.1, 3.2, 4.1.1, 4.1.2, 4.2.1, 4.2.2, 4.2.3, 4.2.4, 4.3.1, 4.3.2

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/scaling_storage/index
  - Verification, Last point (a) in sections 2.1, 2.2 and 2.3 


Product Version: 4.6

Comment 5 Mugdha Soni 2021-04-05 15:29:23 UTC
Hi Olive

Could you please provide preview link to view latest changes in documentations ?


Thanks 
Mugdha

Comment 6 Olive Lakra 2021-04-06 03:57:09 UTC
OCS 4.6 docs for review followed by OCS 4.7 links ---> 
-------------------------

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html/deploying_openshift_container_storage_using_amazon_web_services/assembly_uninstalling-openshift-container-storage_rhocs#uninstalling-openshift-container-storage-in-internal-mode_rhocs

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_openshift_container_storage_on_vmware_vsphere/index#uninstalling-openshift-container-storage-in-internal-mode_rhocs

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_openshift_container_storage_using_bare_metal_infrastructure/index#uninstalling-openshift-container-storage-in-internal-mode_rhocs

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_openshift_container_storage_using_microsoft_azure/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_google_cloud/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_red_hat_virtualization_platform/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_red_hat_openstack_platform/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_ibm_z/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/deploying_and_managing_openshift_container_storage_using_ibm_power_systems/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/replacing_devices/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/replacing_nodes/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.6/html-single/scaling_storage/index



OCS 4.7 docs ---->
------------

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html/deploying_openshift_container_storage_using_amazon_web_services/assembly_uninstalling-openshift-container-storage_rhocs#uninstalling-openshift-container-storage-in-internal-mode_rhocs

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/deploying_openshift_container_storage_on_vmware_vsphere/index#uninstalling-openshift-container-storage-in-internal-mode_rhocs

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/deploying_openshift_container_storage_using_bare_metal_infrastructure/index#uninstalling-openshift-container-storage-in-internal-mode_rhocs

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/deploying_openshift_container_storage_using_microsoft_azure/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/deploying_and_managing_openshift_container_storage_using_google_cloud/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/deploying_and_managing_openshift_container_storage_using_red_hat_virtualization_platform/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/deploying_and_managing_openshift_container_storage_using_red_hat_openstack_platform/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/deploying_and_managing_openshift_container_storage_using_ibm_z/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/deploying_and_managing_openshift_container_storage_using_ibm_power_systems/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/replacing_devices/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/replacing_nodes/index

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/scaling_storage/index

Comment 7 Mugdha Soni 2021-04-06 11:24:02 UTC
Hi Olive 

I still see some places in OCS 4.6 docs the changes have not been made . Tried to get at least the documentations where the change is needed .

"https://docs.google.com/document/d/14moLvC9vLSCH8QuuGNDvFl36wpbqSD2ebdgC90fQBGg/edit#"

Comment 10 Olive Lakra 2021-04-19 11:36:53 UTC
*** Bug 1950979 has been marked as a duplicate of this bug. ***

Comment 11 Mugdha Soni 2021-04-21 10:50:41 UTC
The changes have not been made in some OCS 4.6 documents completely . The 4.7 documents LGTM. 
Hence re assigning the bug.


Thanks 
Mugdha Soni

Comment 14 Mugdha Soni 2021-04-27 07:46:51 UTC
The changes have been made in all the OCS 4.6 and 4.7 documentations except IBM related documents . For IBM documentations new bug will be filed .
Hence , moving this bug to verified state .


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