diff --git a/modules/upgrade/examples/snip_che-upgrading-the-chectl-management-tool.adoc b/modules/upgrade/examples/snip_che-upgrading-the-chectl-management-tool.adoc index 68b0e5992b..4303f35ad7 100644 --- a/modules/upgrade/examples/snip_che-upgrading-the-chectl-management-tool.adoc +++ b/modules/upgrade/examples/snip_che-upgrading-the-chectl-management-tool.adoc @@ -1,18 +1,18 @@ :_content-type: SNIPPET -This section describes how to upgrade the `{prod-cli}` management tool. +Upgrade the `{prod-cli}` management tool to the latest version so that you can use the latest commands and bug fixes. .Prerequisites -* `{prod-cli}`. See: xref:install:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:install:installing-the-chectl-management-tool.adoc[]. .Procedure * Run the following command in the terminal to update `{prod-cli}` to the latest version. + -[subs="+attributes"] +[source,bash,subs="+attributes"] ---- -# {prod-cli} update +$ {prod-cli} update ---- + The command updates `{prod-cli}` based on its current channel. @@ -26,12 +26,13 @@ Two update channels are available for `{prod-cli}`: `stable` and `next`. To move to a different channel, start the update with the name of the channel as an optional argument. -[subs="+attributes"] +[source,bash,subs="+attributes"] ---- -# {prod-cli} update [next|stable] +$ {prod-cli} update [next|stable] ---- ==== +[role="_additional-resources"] .Additional resources * {link-prod-cli-documentation} diff --git a/modules/upgrade/pages/repairing-the-devworkspace-operator-on-openshift.adoc b/modules/upgrade/pages/repairing-the-devworkspace-operator-on-openshift.adoc index fd3eb98de7..8bf8a4cb62 100644 --- a/modules/upgrade/pages/repairing-the-devworkspace-operator-on-openshift.adoc +++ b/modules/upgrade/pages/repairing-the-devworkspace-operator-on-openshift.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -:description: Repairing the {devworkspace} Operator on OpenShift +:description: Fix a duplicate {devworkspace} Operator after a cluster upgrade :keywords: devworkspace, operator, repair :navtitle: Fix a duplicate {devworkspace} Operator after a cluster upgrade :page-aliases: administration-guide:repairing-the-devworkspace-operator-on-openshift.adoc @@ -7,15 +7,14 @@ [id="repairing-the-devworkspace-operator-on-openshift"] = Fix a duplicate {devworkspace} Operator after a cluster upgrade -Under certain conditions, such as link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/understanding/olm/olm-understanding-olm.html[OLM] restart or cluster upgrade, the {prod2} Operator for {prod-short} might automatically install the {devworkspace} Operator even when it is already present on the cluster. In that case, you can repair the {devworkspace} Operator on OpenShift as follows: - -include::partial$snip_persona-admin.adoc[] +[role="_abstract"] +Fix a duplicate {devworkspace} Operator installation that can occur when an link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/understanding/olm/olm-understanding-olm.html[OLM] restart or cluster upgrade leaves multiple Operator entries in a *Replacing* or *Pending* loop. .Prerequisites -* An active `{orch-cli}` session as a cluster administrator to the destination OpenShift cluster. See {orch-cli-link}. +* You have an active `{orch-cli}` session as a cluster administrator to the destination OpenShift cluster. See {orch-cli-link}. -* On the *Installed Operators* page of the {platforms-name} web console, you see multiple entries for the {devworkspace} Operator or one entry that is stuck in a loop of *Replacing* and *Pending*. +* You see multiple entries for the {devworkspace} Operator on the *Installed Operators* page of the {platforms-name} web console, or you see one entry that is stuck in a loop of *Replacing* and *Pending*. .Procedure @@ -35,10 +34,11 @@ status: + TIP: You can find and edit the `DevWorkspace` and `DevWorkspaceTemplate` CRDs in the *Administrator* perspective of the OpenShift web console by searching for `DevWorkspace` in menu:Administration[CustomResourceDefinitions]. + -NOTE: The `DevWorkspaceOperatorConfig` and `DevWorkspaceRouting` CRDs have the conversion strategy set to `None` by default. +NOTE: The `DevWorkspaceOperatorConfig` and `DevWorkspaceRouting` CRDs have the conversion strategy set to `None` by default. . Remove the {devworkspace} Operator subscription: + +[source,bash,subs="+quotes"] ---- $ oc delete sub devworkspace-operator \ -n openshift-operators <1> @@ -47,13 +47,14 @@ $ oc delete sub devworkspace-operator \ . Get the {devworkspace} Operator CSVs in the ____ format: + +[source,bash] ---- $ oc get csv | grep devworkspace ---- . Remove each {devworkspace} Operator CSV: + -[subs="+quotes"] +[source,bash,subs="+quotes"] ---- $ oc delete csv ____ \ -n openshift-operators <1> @@ -62,7 +63,7 @@ $ oc delete csv ____ \ . Re-create the {devworkspace} Operator subscription: + -[subs="+attributes"] +[source,bash,subs="+attributes"] ---- $ cat < Approve]. -. In the *Administrator* perspective of the OpenShift web console, go to menu:Operators[Installed Operators] and verify the *Succeeded* status of the *{devworkspace} Operator*. +.Verification + +* In the *Administrator* perspective of the OpenShift web console, go to menu:Operators[Installed Operators] and verify the *Succeeded* status of the *{devworkspace} Operator*. diff --git a/modules/upgrade/pages/specifying-the-update-approval-strategy.adoc b/modules/upgrade/pages/specifying-the-update-approval-strategy.adoc index 20fbc70663..ad6337b6e3 100644 --- a/modules/upgrade/pages/specifying-the-update-approval-strategy.adoc +++ b/modules/upgrade/pages/specifying-the-update-approval-strategy.adoc @@ -1,5 +1,5 @@ -:_content-type: ASSEMBLY -:description: Specifying the update approval strategy +:_content-type: PROCEDURE +:description: Choose how updates are applied :keywords: administration guide, upgrading-che-using-operatorhub :navtitle: Choose how updates are applied :page-aliases: administration-guide:specifying-the-update-approval-strategy.adoc, installation-guide:upgrading-che-using-operatorhub.adoc @@ -7,24 +7,22 @@ [id="specifying-the-{prod-id-short}-operator-update-approval-strategy-using-the-web-console"] = Choose how updates are applied +[role="_abstract"] +Choose between automatic and manual update approval for the {prod} Operator so that you control when new versions are installed on your cluster. The {prod} Operator supports two upgrade strategies: -include::partial$snip_persona-admin.adoc[] - `Automatic`:: The Operator installs new updates when they become available. `Manual`:: New updates need to be manually approved before installation begins. -You can specify the update approval strategy for the {prod} Operator by using the OpenShift web console. - .Prerequisites -* An OpenShift web console session by a cluster administrator. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/web-console.html[Accessing the web console]. +* You have an OpenShift web console session as a cluster administrator. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/web-console.html[Accessing the web console]. -* An instance of {prod-short} that was installed by using Red Hat Ecosystem Catalog. +* You have an instance of {prod-short} installed by using Red Hat Ecosystem Catalog. .Procedure @@ -36,6 +34,7 @@ You can specify the update approval strategy for the {prod} Operator by using th . Configure the *Update approval* strategy to `Automatic` or `Manual`. +[role="_additional-resources"] .Additional resources * link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/admin/olm-upgrading-operators.html#olm-changing-update-channel_olm-upgrading-operators[Changing the update channel for an Operator] diff --git a/modules/upgrade/pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc b/modules/upgrade/pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc index 1e10babdc0..3fa81c6797 100644 --- a/modules/upgrade/pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc +++ b/modules/upgrade/pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc @@ -1,19 +1,20 @@ :_content-type: PROCEDURE -:description: Upgrading {prod-short} in a restricted environment -:keywords: Upgrading {prod-short} in a restricted environment +:description: Upgrade in an air-gapped environment +:keywords: upgrade, restricted environment, air-gapped :navtitle: Upgrade in an air-gapped environment :page-aliases: administration-guide:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc, installation-guide:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc, installation-guide:upgrading-che-in-restricted-environment.adoc [id="upgrading-{prod-id-short}-using-the-cli-management-tool-in-restricted-environment"] = Upgrade in an air-gapped environment -This section describes how to upgrade {prod} and perform minor version updates by using the CLI management tool in a restricted environment. - -include::partial$snip_persona-admin.adoc[] +[role="_abstract"] +Upgrade {prod-short} on a cluster with no internet access by mirroring updated container images and Operator catalogs to your private registry before running the upgrade. .Prerequisites -* The {prod-short} instance was installed on OpenShift using the `{prod-cli} --installer operator` method in the `{prod-namespace}` project. See xref:install:proc_installing-che-in-a-restricted-environment.adoc[]. +* You have the {prod-short} instance installed on OpenShift using the `{prod-cli} --installer operator` method in the `{prod-namespace}` project. See xref:install:proc_installing-che-in-a-restricted-environment.adoc[]. + +.Procedure include::install:partial$snip_preparing-images-for-a-restricted-environment.adoc[] @@ -23,12 +24,12 @@ include::install:partial$snip_preparing-images-for-a-restricted-environment.adoc . Run the following command: + -[subs="+attributes,+quotes"] +[source,bash,subs="+attributes,+quotes"] ---- $ {prod-cli} server:update --che-operator-image="$TAG" -n {prod-namespace} --k8spodwaittimeout=1800000 ---- -.Verification steps +.Verification . Navigate to the {prod-short} instance. diff --git a/modules/upgrade/pages/upgrading-che-using-the-cli-management-tool.adoc b/modules/upgrade/pages/upgrading-che-using-the-cli-management-tool.adoc index 265b353251..3dcf7958fd 100644 --- a/modules/upgrade/pages/upgrading-che-using-the-cli-management-tool.adoc +++ b/modules/upgrade/pages/upgrading-che-using-the-cli-management-tool.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -:description: Upgrading {prod-short} using the CLI management tool +:description: Upgrade {prod-short} from the command line :keywords: administration guide, upgrading-che-using-the-cli-management-tool :navtitle: Upgrade {prod-short} from the command line :page-aliases: administration-guide:upgrading-che-using-the-cli-management-tool.adoc, installation-guide:upgrading-che-using-the-cli-management-tool.adoc @@ -7,17 +7,16 @@ [id="upgrading-{prod-id-short}-using-the-cli-management-tool"] = Upgrade {prod-short} from the command line -This section describes how to upgrade from the previous minor version using the CLI management tool. - -include::partial$snip_persona-admin.adoc[] +[role="_abstract"] +Upgrade {prod-short} from the previous minor version using the `{prod-cli}` management tool so that your deployment receives the latest bug fixes, security patches, and features. .Prerequisites -* An administrative account on {platforms-name}. +* You have an administrative account on {platforms-name}. -* A running instance of a previous minor version of {prod-prev-short}, installed using the CLI management tool on the same instance of {platforms-name}, in the `{prod-namespace}` {platforms-namespace}. +* You have a running instance of a previous minor version of {prod-prev-short}, installed using the CLI management tool on the same instance of {platforms-name}, in the `{prod-namespace}` {platforms-namespace}. -* `{prod-cli}` for {prod-short} version {prod-ver}. See: xref:install:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` for {prod-short} version {prod-ver}. See xref:install:installing-the-chectl-management-tool.adoc[]. .Procedure @@ -27,7 +26,7 @@ include::partial$snip_persona-admin.adoc[] . Upgrade {prod-short}: + -[subs="+attributes,+quotes"] +[source,bash,subs="+attributes,+quotes"] ---- $ {prod-cli} server:update -n {prod-namespace} ---- @@ -37,7 +36,7 @@ $ {prod-cli} server:update -n {prod-namespace} For slow systems or internet connections, add the `--k8spodwaittimeout=1800000` flag option to extend the Pod timeout period to 1800000 ms or longer. ==== -.Verification steps +.Verification . Navigate to the {prod-short} instance. diff --git a/modules/upgrade/pages/upgrading-che-using-the-web-console.adoc b/modules/upgrade/pages/upgrading-che-using-the-web-console.adoc index 263681c71e..8cb1799a93 100644 --- a/modules/upgrade/pages/upgrading-che-using-the-web-console.adoc +++ b/modules/upgrade/pages/upgrading-che-using-the-web-console.adoc @@ -1,5 +1,5 @@ -:_content-type: ASSEMBLY -:description: Upgrading {prod-short} using the OpenShift web console +:_content-type: PROCEDURE +:description: Approve a pending upgrade in the web console :keywords: administration guide, upgrading-che-using-operatorhub :navtitle: Approve a pending upgrade in the web console :page-aliases: administration-guide:upgrading-che-using-the-web-console.adoc @@ -7,28 +7,28 @@ [id="upgrading-{prod-id-short}-using-the-openshift-web-console"] = Approve a pending upgrade in the web console -You can manually approve an upgrade from an earlier minor version using the {prod} Operator from the Red Hat Ecosystem Catalog in the OpenShift web console. - -include::partial$snip_persona-admin.adoc[] +[role="_abstract"] +Approve a pending {prod} Operator upgrade in the {platforms-name} web console so that your deployment receives the latest features, bug fixes, and security patches at the time you choose. .Prerequisites -* An OpenShift web console session by a cluster administrator. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/web-console.html[Accessing the web console]. +* You have an OpenShift web console session as a cluster administrator. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/web-console.html[Accessing the web console]. -* An instance of {prod-short} that was installed by using the Red Hat Ecosystem Catalog. +* You have an instance of {prod-short} installed by using the Red Hat Ecosystem Catalog. -* The approval strategy in the subscription is `Manual`. See xref:specifying-the-update-approval-strategy.adoc[]. +* You have the approval strategy in the subscription set to `Manual`. See xref:specifying-the-update-approval-strategy.adoc[]. .Procedure * Manually approve the pending {prod} Operator upgrade. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/admin/olm-upgrading-operators.html#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator upgrade]. -.Verification steps +.Verification . Navigate to the {prod-short} instance. . The {prod-ver} version number is visible at the bottom of the page. +[role="_additional-resources"] .Additional resources * link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/admin/olm-upgrading-operators.html#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator upgrade] diff --git a/modules/upgrade/pages/upgrading-che.adoc b/modules/upgrade/pages/upgrading-che.adoc index e4080283fc..3863ffff6d 100644 --- a/modules/upgrade/pages/upgrading-che.adoc +++ b/modules/upgrade/pages/upgrading-che.adoc @@ -1,5 +1,5 @@ :_content-type: ASSEMBLY -:description: Keep your {prod-short} deployment current by upgrading to the latest version. +:description: Upgrade {prod-short} :keywords: upgrade, update, migrate :navtitle: Upgrade {prod-short} :page-aliases: administration-guide:upgrading-che.adoc, installation-guide:upgrading-che.adoc, installation-guide:upgrading-che-known-issues.adoc, installation-guide:rolling-back-a-che-upgrade.adoc, installation-guide:upgrading-che-namespace-strategies-other-than-per-user.adoc, upgrading-che-namespace-strategies-other-than-per-user.adoc, upgrading-che-7-41-on-openshift.adoc @@ -9,7 +9,9 @@ = Upgrade {prod-short} [role="_abstract"] -Keep your {prod-short} deployment current by upgrading to the latest version. Upgrading delivers bug fixes, security patches, and new capabilities to your developers with minimal disruption. +Upgrade your {prod-short} deployment to the latest version to receive bug fixes, security patches, and new capabilities with minimal disruption. + +This guide is for platform administrators who keep {prod-short} current with the latest release. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. Before you upgrade, save and push all work in running workspaces, then stop all workspaces. The Operator handles the server component upgrade automatically. Workspaces resume normally after the upgrade completes. diff --git a/modules/upgrade/pages/upgrading-the-chectl-management-tool.adoc b/modules/upgrade/pages/upgrading-the-chectl-management-tool.adoc index 340f057163..fdd93e035e 100644 --- a/modules/upgrade/pages/upgrading-the-chectl-management-tool.adoc +++ b/modules/upgrade/pages/upgrading-the-chectl-management-tool.adoc @@ -1,12 +1,10 @@ :_content-type: PROCEDURE -:description: Upgrading the chectl management tool -:keywords: overview, upgrading, chectl, cli -:navtitle: Update the {prod-cli} management tool +:description: Upgrade the {prod-cli} management tool +:keywords: upgrade, chectl, cli +:navtitle: Upgrade the {prod-cli} management tool :page-aliases: administration-guide:upgrading-the-chectl-management-tool.adoc [id="upgrading-the-{prod-cli}-management-tool"] -= Upgrading the {prod-cli} management tool - -include::partial$snip_persona-admin.adoc[] += Upgrade the {prod-cli} management tool include::example$snip_{project-context}-upgrading-the-chectl-management-tool.adoc[] diff --git a/modules/upgrade/partials/snip_installing-che-in-a-restricted-environment-additional-resources.adoc b/modules/upgrade/partials/snip_installing-che-in-a-restricted-environment-additional-resources.adoc index 72880389fe..9ad91a40d2 100644 --- a/modules/upgrade/partials/snip_installing-che-in-a-restricted-environment-additional-resources.adoc +++ b/modules/upgrade/partials/snip_installing-che-in-a-restricted-environment-additional-resources.adoc @@ -1,5 +1,6 @@ :_content-type: SNIPPET +[role="_additional-resources"] .Additional resources * link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/understanding/olm-rh-catalogs.html[Red Hat-provided Operator catalogs]