Skip to content

feat: add GitOps installation procedures #3141

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 1 commit into from
Aug 5, 2026
Merged

feat: add GitOps installation procedures #3141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion ...es/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ $ {orch-cli} label secret self-signed-certificate app.kubernetes.io/part-of=che.

.Additional resources

* xref:install:installing-che.adoc[]
* xref:install:con_installation-overview.adoc[]
2 changes: 1 addition & 1 deletion modules/discover/examples/snip_che-supported-platforms.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ The following options are available for the local installation:

.Additional resources

* xref:install:installing-che.adoc[]
* xref:install:con_installation-overview.adoc[]
2 changes: 1 addition & 1 deletion modules/discover/pages/che-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ On a cluster with the {prod-short} operator, it is possible to create a `CheClus
.Additional resources

* xref:administration-guide:understanding-the-checluster-custom-resource.adoc[]
* xref:install:installing-che.adoc[]
* xref:install:con_installation-overview.adoc[]
* xref:devworkspace-operator.adoc[]
* xref:gateway.adoc[]
* xref:dashboard.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion modules/discover/pages/roles-and-tasks.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Platform administrators deploy, configure, secure, upgrade, and monitor {prod-sh

Common tasks include:

* Deploy {prod-short} on a cluster. See xref:install:installing-che.adoc[].
* Deploy {prod-short} on a cluster. See xref:install:con_installation-overview.adoc[].
* Configure the `CheCluster` custom resource. See xref:administration-guide:understanding-the-checluster-custom-resource.adoc[].
* Set up OAuth for Git providers. See xref:administration-guide:configuring-oauth-for-git-providers.adoc[].
* Control workspace start times with image caching. See xref:optimize:caching-images-for-faster-workspace-start.adoc[].
Expand Down
40 changes: 21 additions & 19 deletions modules/install/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,27 @@
** xref:running-at-scale.adoc[]
** xref:installing-the-chectl-management-tool.adoc[]
// Installing
* xref:installing-che.adoc[]
** Deploy on OpenShift
*** xref:proc_installing-che-on-openshift-using-cli.adoc[]
*** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[]
*** xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
** Deploy on {kubernetes}
*** xref:installing-che-on-microsoft-azure.adoc[]
*** xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[]
*** xref:proc_installing-che-on-the-virtual-kubernetes-cluster.adoc[]
** Deploy locally
*** xref:proc_installing-che-on-red-hat-openshift-local.adoc[]
*** xref:proc_installing-che-on-minikube.adoc[]
*** xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[]
** Deploy in a restricted environment
*** xref:proc_installing-che-in-a-restricted-environment.adoc[]
** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
** Permissions
*** xref:ref_permissions-to-install-che-on-openshift-using-cli.adoc[]
*** xref:ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc[]
* Deploy using GitOps
** xref:proc_deploying-che-using-gitops.adoc[]
** xref:proc_deploying-che-using-gitops-in-a-restricted-environment.adoc[]
* Deploy on OpenShift
** xref:proc_installing-che-on-openshift-using-cli.adoc[]
** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[]
** xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
* Deploy on {kubernetes}
** xref:installing-che-on-microsoft-azure.adoc[]
** xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[]
** xref:proc_installing-che-on-the-virtual-kubernetes-cluster.adoc[]
* Deploy locally
** xref:proc_installing-che-on-red-hat-openshift-local.adoc[]
** xref:proc_installing-che-on-minikube.adoc[]
** xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[]
* Deploy in a restricted environment
** xref:proc_installing-che-in-a-restricted-environment.adoc[]
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
* Permissions
** xref:ref_permissions-to-install-che-on-openshift-using-cli.adoc[]
** xref:ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc[]
* xref:proc_verifying-the-installation.adoc[]
* xref:proc_finding-the-fully-qualified-domain-name-fqdn.adoc[]
* xref:con_next-steps-after-installation.adoc[]
Expand Down
2 changes: 2 additions & 0 deletions modules/install/pages/calculating-che-resource-requirements.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
[role="_abstract"]
Size your cluster by calculating the CPU and memory requirements for the {prod-short} Operator, {devworkspace} Controller, and user workspaces so that your cluster can handle the expected number of concurrent users.

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

The {prod-short} Operator, {devworkspace} Controller, and user workspaces consist of a set of pods.
The pods contribute to the resource consumption in CPU and memory limits and requests.

Expand Down
14 changes: 11 additions & 3 deletions modules/install/pages/con_installation-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,36 @@
[role="_abstract"]
{prod-short} deploys on {orch-name} as an Operator that manages a gateway, dashboard, server, and plug-in registry. The installation method you choose depends on your cluster environment and need for configuration control.

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

{prod-short} consists of an Operator, a user dashboard, a gateway, and a plug-in registry. The Operator manages the full lifecycle of all server components. You deploy {prod-short} by installing the Operator and creating a `CheCluster` custom resource.

== Installation methods

Argo CD (GitOps):: Store the Operator subscription and `CheCluster` configuration in a Git repository and let Argo CD reconcile the deployment. Choose this method for production deployments where every configuration change must be tracked in Git, auditable, and automatically reconciled.

`{prod-cli}` command-line tool:: Choose this method when you need to quickly deploy {prod-short} for evaluation, customize the `CheCluster` configuration during installation, or manage {prod-short} from scripts.

{orch-name} web console:: Choose this method when you prefer a graphical workflow through OperatorHub and do not need advanced configuration options during deployment.

Both methods produce the same result: an Operator subscription and a `CheCluster` custom resource. For step-by-step deployment instructions, see Additional resources.
All methods produce the same result: an Operator subscription and a `CheCluster` custom resource. For step-by-step deployment instructions, see Additional resources.

== Deployment scenarios

Standard deployment:: Your {orch-name} cluster has internet access. Both installation methods are available. The Operator pulls container images directly from `registry.redhat.io`.
Standard deployment:: Your {orch-name} cluster has internet access. All installation methods are available. The Operator pulls container images directly from `registry.redhat.io`.

GitOps deployment:: Your organization manages cluster configuration declaratively through Argo CD. Store the Operator subscription and `CheCluster` configuration in a Git repository and let Argo CD reconcile the desired state. Available for both connected and air-gapped clusters.

Air-gapped deployment:: Your cluster has no internet access. Mirror the required container images and Operator catalogs to a private registry before installation.
Air-gapped deployment:: Your cluster has no internet access. Mirror the required container images and Operator catalogs to a private registry before installation. Both GitOps and CLI methods are available.

External identity provider:: Your organization manages authentication through an existing identity system such as {keycloak}. Deploy {prod-short} with an external OIDC provider instead of the default {orch-name} OAuth.

[role="_additional-resources"]
.Additional resources

* xref:proc_deploying-che-using-gitops.adoc[]
* xref:proc_installing-che-on-openshift-using-cli.adoc[]
* xref:proc_installing-che-on-openshift-using-the-web-console.adoc[]
* xref:proc_deploying-che-using-gitops-in-a-restricted-environment.adoc[]
* xref:proc_installing-che-in-a-restricted-environment.adoc[]
* xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
2 changes: 2 additions & 0 deletions modules/install/pages/con_next-steps-after-installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
[role="_abstract"]
Prepare {prod-short} for your team by completing these configuration tasks before inviting developers: customize the `CheCluster` resource, connect Git providers for credential-free repository access, and verify end-to-end functionality with a first workspace.

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

* Verify the platform end-to-end, configure Git provider OAuth, and share the dashboard URL with developers. For a walkthrough of each verification step, see Additional resources.
* Customize the `CheCluster` custom resource to adjust {prod-short} behavior for your environment. For field-by-field configuration guidance, see Additional resources.
* Create your first cloud development environment from a Git repository URL. For a step-by-step workspace creation walkthrough, see Additional resources.
Expand Down
2 changes: 2 additions & 0 deletions modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
[role="_abstract"]
To provide cloud development environments on AWS, deploy {prod-short} on an Amazon EKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider.

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

.Prerequisites

* You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm].
Expand Down
2 changes: 2 additions & 0 deletions modules/install/pages/installing-che-on-microsoft-azure.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
[role="_abstract"]
To provide cloud development environments on Microsoft Azure, deploy {prod-short} on an AKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider.

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

.Prerequisites

* You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm].
Expand Down
2 changes: 2 additions & 0 deletions modules/install/pages/installing-the-chectl-management-tool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
[role="_abstract"]
Set up `{prod-cli}` on Linux, macOS, or Windows so that you can deploy, update, and manage {prod-short} from the command line.

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

include::example$proc_{project-context}-installing-the-chectl-management-tool-on-windows.adoc[leveloffset=+1]

include::example$proc_{project-context}-installing-the-chectl-management-tool-on-linux-or-macos.adoc[leveloffset=+1]
Expand Down
Loading
Loading