Skip to content

chore: promote Upgrade to top-level Antora module (JTBD Phase 2) #3133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtrivedi88 merged 3 commits into from
Jul 2, 2026
Merged

chore: promote Upgrade to top-level Antora module (JTBD Phase 2) #3133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e43db21
chore: promote Upgrade to top-level Antora module (JTBD Phase 2)
gtrivedi88 Jun 29, 2026
d6a324f
feat: add persona callouts to Upgrade module using local partials
gtrivedi88 Jul 2, 2026
8436a1f
fix: add install: prefix to cross-module xref for chectl management tool
gtrivedi88 Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ nav:
- modules/discover/nav.adoc
- modules/install/nav.adoc
- modules/end-user-guide/nav.adoc
- modules/upgrade/nav.adoc
- modules/administration-guide/nav.adoc
- modules/extensions/nav.adoc
- modules/glossary/nav.adoc
Expand Down
7 changes: 0 additions & 7 deletions modules/administration-guide/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,3 @@
** xref:manage-extension-installation.adoc[]
** xref:editor-configurations-for-microsoft-visual-studio-code.adoc[]
* xref:managing-workloads-using-the-che-server-api.adoc[]
* xref:upgrading-che.adoc[]
** xref:upgrading-the-chectl-management-tool.adoc[]
** xref:specifying-the-update-approval-strategy.adoc[]
** xref:upgrading-che-using-the-web-console.adoc[]
** xref:upgrading-che-using-the-cli-management-tool.adoc[]
** xref:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc[]
** xref:repairing-the-devworkspace-operator-on-openshift.adoc[]
13 changes: 0 additions & 13 deletions modules/administration-guide/pages/upgrading-che.adoc
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion modules/install/partials/snip_preparing-images-for-a-restricted-environment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

* An active `skopeo` session with administrative access to the private Docker registry. link:https://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry], and link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp4-ver}/html/disconnected_environments/installing-mirroring-disconnected-about[Mirroring images for a disconnected installation].

* `{prod-cli}` for {prod-short} version {prod-ver}. See xref:installing-the-chectl-management-tool.adoc[].
* `{prod-cli}` for {prod-short} version {prod-ver}. See xref:install:installing-the-chectl-management-tool.adoc[].

.Procedure

Expand Down
0 ...upgrading-the-chectl-management-tool.adoc → ...upgrading-the-chectl-management-tool.adoc
View file
Open in desktop
File renamed without changes.
8 changes: 8 additions & 0 deletions modules/upgrade/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.Upgrade
* xref:upgrading-che.adoc[]
** xref:specifying-the-update-approval-strategy.adoc[]
** xref:upgrading-che-using-the-web-console.adoc[]
** xref:upgrading-che-using-the-cli-management-tool.adoc[]
** xref:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc[]
** xref:upgrading-the-chectl-management-tool.adoc[]
** xref:repairing-the-devworkspace-operator-on-openshift.adoc[]
8 changes: 5 additions & 3 deletions ...e-devworkspace-operator-on-openshift.adoc → ...e-devworkspace-operator-on-openshift.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
:_content-type: PROCEDURE
:description: Repairing the {devworkspace} Operator on OpenShift
:keywords: devworkspace, operator, repair
:navtitle: Repairing the {devworkspace} Operator on OpenShift
:page-aliases:
:navtitle: Fix a duplicate {devworkspace} Operator after a cluster upgrade
:page-aliases: administration-guide:repairing-the-devworkspace-operator-on-openshift.adoc

[id="repairing-the-devworkspace-operator-on-openshift"]
= 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[]

.Prerequisites

* An active `{orch-cli}` session as a cluster administrator to the destination OpenShift cluster. See {orch-cli-link}.
Expand Down
8 changes: 5 additions & 3 deletions ...cifying-the-update-approval-strategy.adoc → ...cifying-the-update-approval-strategy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
:_content-type: ASSEMBLY
:description: Specifying the update approval strategy
:keywords: administration guide, upgrading-che-using-operatorhub
:navtitle: Specifying the update approval strategy
:page-aliases: installation-guide:upgrading-che-using-operatorhub.adoc
:navtitle: Choose how updates are applied
:page-aliases: administration-guide:specifying-the-update-approval-strategy.adoc, installation-guide:upgrading-che-using-operatorhub.adoc

[id="specifying-the-{prod-id-short}-operator-update-approval-strategy-using-the-web-console"]
= Specifying the update approval strategy for the {prod} Operator
= Choose how updates are applied


The {prod} Operator supports two upgrade strategies:

include::partial$snip_persona-admin.adoc[]

`Automatic`::
The Operator installs new updates when they become available.

Expand Down
8 changes: 5 additions & 3 deletions ...ement-tool-in-restricted-environment.adoc → ...ement-tool-in-restricted-environment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
:_content-type: PROCEDURE
:description: Upgrading {prod-short} in a restricted environment
:keywords: Upgrading {prod-short} in a restricted environment
:navtitle: Upgrading {prod-short} in a restricted environment
:page-aliases: installation-guide:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc, installation-guide:upgrading-che-in-restricted-environment.adoc
: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"]
= Upgrading {prod-short} using the CLI management tool in a 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[]

.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[].
Expand Down
8 changes: 5 additions & 3 deletions ...ng-che-using-the-cli-management-tool.adoc → ...ng-che-using-the-cli-management-tool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
:_content-type: PROCEDURE
:description: Upgrading {prod-short} using the CLI management tool
:keywords: administration guide, upgrading-che-using-the-cli-management-tool
:navtitle: Upgrading {prod-short} using the CLI management tool
:page-aliases: installation-guide:upgrading-che-using-the-cli-management-tool.adoc
: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

[id="upgrading-{prod-id-short}-using-the-cli-management-tool"]
= Upgrading {prod-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[]

.Prerequisites

* An administrative account on {platforms-name}.
Expand Down
8 changes: 5 additions & 3 deletions .../upgrading-che-using-the-web-console.adoc → .../upgrading-che-using-the-web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
:_content-type: ASSEMBLY
:description: Upgrading {prod-short} using the OpenShift web console
:keywords: administration guide, upgrading-che-using-operatorhub
:navtitle: Upgrading {prod-short} using the OpenShift web console
:page-aliases:
:navtitle: Approve a pending upgrade in the web console
:page-aliases: administration-guide:upgrading-che-using-the-web-console.adoc

[id="upgrading-{prod-id-short}-using-the-openshift-web-console"]
= Upgrading {prod-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[]

.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].
Expand Down
15 changes: 15 additions & 0 deletions modules/upgrade/pages/upgrading-che.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:_content-type: ASSEMBLY
:description: Keep your {prod-short} deployment current by upgrading to the latest version.
: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


[id="upgrading-{prod-id-short}"]
= 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.

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.

6 changes: 4 additions & 2 deletions ...upgrading-the-chectl-management-tool.adoc → ...upgrading-the-chectl-management-tool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
:_content-type: PROCEDURE
:description: Upgrading the chectl management tool
:keywords: overview, upgrading, chectl, cli
:navtitle: Upgrading the chectl management tool
:page-aliases:
:navtitle: Update 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[]

include::example$snip_{project-context}-upgrading-the-chectl-management-tool.adoc[]
0 ...ted-environment-additional-resources.adoc → ...ted-environment-additional-resources.adoc
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions modules/upgrade/partials/snip_persona-admin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[].
Loading