Bug 2067291 - EUS-to-EUS upgrade docs should require oc 4.9 or later
Summary: EUS-to-EUS upgrade docs should require oc 4.9 or later
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.8
Hardware: Unspecified
OS: Unspecified
medium
high
Target Milestone: ---
: 4.11.0
Assignee: Latha S
QA Contact: liujia
Latha S
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-03-23 18:09 UTC by Scott Dodson
Modified: 2022-04-07 13:40 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-04-07 13:40:50 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift openshift-docs pull 43712 0 None open Bug 2067291: EUS-to-EUS upgrade procedure requires oc 4.9 or later 2022-03-23 18:34:04 UTC

Description Scott Dodson 2022-03-23 18:09:35 UTC
Document URL: https://docs.openshift.com/container-platform/4.10/updating/preparing-eus-eus-upgrade.html

Section Number and Name: Prerequisites

Describe the issue: The oc command version 4.8 and earlier doesn't offer the `oc adm upgrade channel` command, and worse if used it provides no indication that the command failed.

Suggestions for improvement: We should detail both in Prerequisites, and on first use, that they need to use oc version 4.9 or later when starting the EUS-to-EUS upgrade. This is particularly prudent right now since they're going to be upgrading from 4.8 to 4.10.

Additional information: I'll put in a PR for this.

Comment 1 liujia 2022-03-25 00:46:52 UTC
> Describe the issue: The oc command version 4.8 and earlier doesn't offer the `oc adm upgrade channel` command, and worse if used it provides no indication that the command failed.

Hi Scott

It seems we already have such Prerequisites described in the doc[1]:
```
Prerequisites
Install the OpenShift CLI (oc) that matches the version for your updated version.
```
According to above, the user(for eus upgrade) should update `oc` to v4.9 before updating cluster from v4.8 to v4.9, and then update `oc` to v4.10 before updating cluster from v4.9 to v4.10. The upgrade steps for EUS-to-EUS is also `upgrade with cli`. Do you think we need add this Prerequisites again?

[1] https://docs.openshift.com/container-platform/4.8/updating/updating-cluster-cli.html#update-upgrading-cli_updating-cluster-cli

Comment 2 Scott Dodson 2022-03-25 16:17:56 UTC
Jia,

I think that's a valid point, the EUS-to-EUS upgrade docs however are written as a freestanding procedure so I think we should make reference to the need to use at least a 4.9 CLI in this page and given the nature of EUS-to-EUS upgrade we should probably try to clarify whether that'd be 4.9 or 4.10. I chose 4.9 because it should offer the best compatibility between 4.8, 4.9, and 4.10. I'm sure that using 4.10 would work for at least initiating the upgrade.

My biggest concern right now is that the docs as written may lead someone to use 4.8 and there's no error message generated by `oc adm upgrade channel eus-4.10` command when that's the case because it's an unknown command. If they were running 4.9 it would tell them that the channel is not yet available and I want to make sure we get that change made sooner rather than later.  Once we're past 4.8 to 4.10 we can revert back to just saying that the CLI should be updated using version generic language.


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