Skip to content

Commit

Permalink
fix: Prerequisites and Procedure (#2071)
Browse files Browse the repository at this point in the history
* Replaced OpenShift with platforms-name

* [2654] fix

Based on comments in eclipse-che/che#18514
1. replaced OpenShift with {platforms-name}
in Prerequisites,
2. added the `update` step,
3. rewrote the upgrade step description.

Bug: https://issues.redhat.com/browse/RHDEVDOCS-2654

* [2654] fix

Removed italics and angle brackets from the following command block:
$ chectl server:update -n eclipse-che

Bug: https://issues.redhat.com/browse/RHDEVDOCS-2654

* [2654] fix

removed the redundant word 'instance' from the following line in Prerequisites:
* And administrative account on an OpenShift instance.
* An administrative account on an instance of {platforms-name}.

Bug: https://issues.redhat.com/browse/RHDEVDOCS-2654

* rewrote step 3 in the procedure

* aligned the code block in step 3

* added ifeval for step 3

* rephrased

* mmaler-review

Signed-off-by: Michal Maléř <mmaler@redhat.com>

Co-authored-by: Michal Maléř <mmaler@redhat.com>
  • Loading branch information
max-cx and MichalMaler authored Jul 30, 2021
1 parent 9995675 commit 12a1236
Showing 1 changed file with 16 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,36 @@
[id="upgrading-{prod-id-short}-using-the-cli-management-tool_{context}"]
= Upgrading {prod-short} using the CLI management tool

This section describes how to upgrade from previous minor version using the CLI management tool.
This section describes how to upgrade from the previous minor version using the CLI management tool.

.Prerequisites

* And administrative account on an OpenShift instance.
* An administrative account on {platforms-name}.

* A running instance of a previous minor version of {prod}, installed using the CLI management tool on the same instance of OpenShift, in the `__<{prod-namespace}>__` project.
* A running instance of a previous minor version of {prod}, installed using the CLI management tool on the same instance of {platforms-name}, in the `__<{prod-namespace}>__` project.

* `{prod-cli}` is available and updated. See xref:using-the-chectl-management-tool.adoc[].

* An installation of the `{prod-cli}` {prod-ver} version management tool. See xref:overview:using-the-chectl-management-tool.adoc[].

.Procedure

. In all running workspaces in the {prod-short} {prod-prev-ver} instance, save and push changes back to the Git repositories.
. Save and push changes back to the Git repositories for all running {prod-short} {prod-prev-ver} workspaces.

. Shut down all workspaces in the {prod-short} {prod-prev-ver} instance.

. Run the following command:
ifeval::["{project-context}" == "che"]
. Update to the latest version of `{prod-cli}`:
+
----
$ chectl update
----
endif::[]

. Upgrade {prod-short}:
+
[subs="+attributes,+quotes"]
----
$ {prod-cli} server:update -n __<{prod-namespace}>__
$ {prod-cli} server:update -n {prod-namespace}
----

[NOTE]
Expand Down

0 comments on commit 12a1236

Please sign in to comment.