Bug 2052541 - Document how to use must-gather in a disconnected environment
Summary: Document how to use must-gather in a disconnected environment
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenShift Data Foundation
Classification: Red Hat Storage
Component: documentation
Version: 4.9
Hardware: Unspecified
OS: Unspecified
urgent
unspecified
Target Milestone: ---
: ODF 4.9.3
Assignee: Agil Antony
QA Contact: Daniel Horák
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-02-09 14:21 UTC by khartsoe@redhat.com
Modified: 2023-08-09 16:43 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-03-09 12:47:11 UTC
Embargoed:


Attachments (Terms of Use)

Description khartsoe@redhat.com 2022-02-09 14:21:31 UTC
Describe the issue:
ODF 4.9 documentation does not provide instructions for how to use must-gather in a disconnected environment

Describe the task you were trying to accomplish:
See Nokia support case 03135079

Suggestions for improvement:
Add instructions for how to use must-gather in a disconnected environment

Document URL:
https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html-single/troubleshooting_openshift_data_foundation#downloading-log-files-and-diagnostic-information_rhodf

Chapter/Section Number and Title:
Chapter 2. Downloading log files and diagnostic information using must-gather

Product Version:
4.9 

Environment Details:
See Nokia support case 03135079

Any other versions of this document that also needs this update:
4.9 is the priority to be updated first; should be applied to ODF 4.10 as well

Additional information:
Required documentation updates are provided in the following gdoc:

https://docs.google.com/document/d/18ZOCJYUJJczqwkLX79sMn-Dd3Cx6ITFi6v62IUjk9TI/edit?usp=sharing

Comment 10 Daniel Horák 2022-02-11 10:57:26 UTC
I have few technical questions and notes:

* The first step about mirroring the must-gather image mentions documentation
  *Mirroring the OpenShift Container Platform image repository*[1], but if I
  understand it correctly, that is for mirroring the OCP release related
  images, not individual images. AFAIK mirroring individual images should be
  done via `oc image mirror ...` command. Something like this should work:

  $ oc image mirror registry.redhat.io/odf4/ocs-must-gather-rhel8:v4.9 <MIROR-REGISTRY>/odf4/ocs-must-gather-rhel8:v4.9

  It might also require `--registry-config ...` and `--insecure=true` parameters.

* I think, that the ocs-must-gather-rhel8 image is automatically mirrored
  during preparation fort the disconnected ODF deployment (it is/should be
  listed between relatedImages together with all other ODF related images).
  Wouldn't be possible to use it directly without requiring additional steps
  for mirroring? But it is probably not tagged by the v4.9 tag, so it is not
  directly available as "<MIROR-REGISTRY>/odf4/ocs-must-gather-rhel8:v4.9".

And two cosmetics/visual notes:

* Wouldn't be better to put the section *For a disconnected environment* before
  the *Procedure*, so it will be something like pre-requisite and user could
  decide if it applies to his environment or not before he actually try to run
  the general `oc adm must-gather ...` command, which will fail?

* If the section stay where it is, is it intended to be a subsection of the
  *Procedure* - shouldn't it be on the same level as *Procedure* and *Command
  variations* sections? (It visually looks, like it belongs to the third bullet:
  * _Output of some standard Ceph commands like Status, Cluster health, and others._)

[1] https://access.redhat.com/documentation/en-us/openshift_container_platform/4.9/html-single/installing/index#installation-mirror-repository_installing-mirroring-installation-images

Comment 15 Daniel Horák 2022-02-17 16:05:05 UTC
Moving back to ASSIGNED as there is still ongoing discussion about this topic.


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