chectl server:update requires chectl to be updated first

[sunix]

Describe the bug

I have been trying to upgrade Che with chectl following https://www.eclipse.org/che/docs/che-7/installation-guide/upgrading-che-using-the-cli-management-tool/.
First the describe command are not working out of the box:

$ chectl -n che server:update
> Error: command -n not found

and then the platform is required

Then, It wasn't completly clear that I needed to update chectl as well. Should tell the user how to upgrade chectl.

Che version

• 7.20.1

Runtime

• kubernetes (GKE)

Installation method

• chectl

Environment

• Cloud
  • GCE

[l0rd]

First the describe command are not working out of the box

@sunix what do you mean? That when an error occurs we should show the "usage" message?

Then, It wasn't completely clear that I needed to update chectl as well. Should tell the user how to upgrade chectl.

That's fair. chectl server:update -p k8s won't do the update if you don't have a newer version of the operator yaml files. Upgrading chectl is one option, probably the easiest one. But we could also just fetch the latest deployment yaml files.

[sunix]

First the describe command are not working out of the box

@sunix what do you mean? That when an error occurs we should show the "usage" message?

No just neeed to fix in our doc, -n option is placed before the command, should be command first

[tolusha]

doc PR eclipse-che/che-docs#1729
chectl PR to improve messages and notify user to update chectl eclipse-che/che-docs#1729

[sunix]

I am reopening this issue as it is not clear at all
https://www.eclipse.org/che/docs/che-7/installation-guide/upgrading-che-using-the-cli-management-tool/

Prerequisites

• And administrative account on an OpenShift instance.

Should not be openshift but kubernetes

• A running instance of a previous minor version of Eclipse Che, installed using the CLI management tool on the same instance of OpenShift, in the project.

should not be openshift but kubernetes

• An installation of the chectl 7.25 version management tool. See Using the chectl management tool.

This is absolutely error prone. So in any case, the user will have to update chectl. So why not simply providing the right procedure. Something like:

Run the following commands:

  $ chectl update
  $ chectl server:update -n <eclipse-che>

[yhontyk]

Docs team Jira issue https://issues.redhat.com/browse/RHDEVDOCS-2654

[max-cx]

@sunix I'm fixing the docs.
Do you happen to know if the upgrade command should instead be presented in the text as
$ chectl server:update -n eclipse-che
rather than
$ chectl server:update -n <_eclipse-che_> as is now in
https://www.eclipse.org/che/docs/che-7/installation-guide/upgrading-che-using-the-cli-management-tool/
Angle brackets and italics are used where user input may vary. I know little about this software, but is it safe to assume that eclipse-che will remain in this command without any variations or replacements?

[tolusha]

It must be chectl server:update -n eclipse-che

[max-cx]

@tolusha Great, thank you! That answers my question. I'll fix it then.

[tolusha]

Fixed by eclipse-che/che-docs#2071