Bug 1872850 - OCS 4.5: Upgrade documentation should cover details about z-stream upgrades as well
Summary: OCS 4.5: Upgrade documentation should cover details about z-stream upgrades a...
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: ---
: ---
Assignee: Agil Antony
QA Contact: Neha Berry
URL:
Whiteboard:
Depends On:
Blocks: 1885167
TreeView+ depends on / blocked
 
Reported: 2020-08-26 17:56 UTC by Neha Berry
Modified: 2020-10-19 06:50 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-10-19 06:50:10 UTC
Embargoed:


Attachments (Terms of Use)

Description Neha Berry 2020-08-26 17:56:35 UTC
Describe the issue:
--------------------------

Current Upgrade docs for OCS 4.5 has the following "Prerequisites"


>>Switch the Red Hat OpenShift Container Storage channel from stable-4.4 to >>stable-4.5. For details about channels, see OpenShift Container Platform >>upgrade channels and releases.

But, some of the releases have z-stream updates as well, e.g. 4.5.0 to 4.5.1 upgrade. For that, one doesn't need to change the channel.

We need to document this as a Note or as a Step. Content can be decided later.



Suggestions for improvement:

Document URL: https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html-single/managing_openshift_container_storage/index?lb_target=preview#updating-openshift-container-storage-in-internal-mode_rhocs

Chapter/Section Number and Title: 10. Updating OpenShift Container Storage

Product Version: OCS 4.5

Environment Details: NA

Any other versions of this document that also needs this update: OCS 4.4, OCS 4.3(it probably did not have a z-stream release), OCS 4.2

Additional information:

Comment 2 Neha Berry 2020-08-26 17:58:28 UTC
Hi Anjana,

Since this change is needed for almost all the OCS docs, starting from 4.2 through 4.5, do we really want to clone 4 bugs out of it ? Or can the change be tracked in a single BZ ( As it is more of adding a Note/Step and less of testing explicitly)

Comment 3 Neha Berry 2020-08-26 18:00:21 UTC
Also, in all these docs, we are using a mix of "upgrading" and "updating" keywords. We should confirm and stick to one terminology. @Umanga WDYT?

e.g.

10.1. "Updating" OpenShift Container Storage in internal mode
Use the following procedures to "upgrade" your OpenShift Container Storage cluster deployed in internal mode.

Comment 4 umanga 2020-09-02 07:47:45 UTC
We should use "Upgrade" for version upgrades.

Comment 8 Neha Berry 2020-10-09 08:37:05 UTC
(In reply to umanga from comment #4)
> We should use "Upgrade" for version upgrades.

@Umanga, does that mean we should replace"updating" with "Upgrading" in the entire Upgrade section of managing guide for all 4.3, 4.4 and 4.5, 4.6 docs? Or are there some particular places we need to change to "upgrade"? Please clarify


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