From 9a746a69573326c56b2ab4d052e581739e619c80 Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Fri, 15 May 2026 02:29:13 +0530 Subject: [PATCH 1/2] chore: promote Install to top-level Antora module Move all installation pages, partials, and examples from administration-guide to a new modules/install/ module, matching the downstream JTBD category structure. Create installation overview, verification, and next-steps pages. Update all cross-module xrefs and includes across admin-guide, overview, and end-user-guide. Delete dissolved wrapper pages (preparing-the-installation, permissions-to-install-che). Register discover, plan, and install module navs in antora.yml. Depends on: PR #3098 (Discover), PR #3099 (Plan) Co-Authored-By: Claude Opus 4.6 --- antora.yml | 1 + .../proc_che-configuring-ingresses.adoc | 2 +- ...ncealing-editors-additional-resources.adoc | 2 +- .../snip_che-supported-platforms.adoc | 2 +- modules/administration-guide/nav.adoc | 26 +--------- .../pages/che-operator.adoc | 2 +- .../pages/configuring-che-hostname.adoc | 2 +- ...ring-che-with-self-signed-certificate.adoc | 2 +- .../pages/configuring-storage-classes.adoc | 4 +- .../pages/configuring-storage-sizes.adoc | 2 +- .../configuring-the-storage-strategy.adoc | 2 +- ...onfiguring-workspace-target-namespace.adoc | 2 +- .../configuring-workspaces-nodeselector.adoc | 2 +- ...itories-with-self-signed-certificates.adoc | 2 +- .../pages/permissions-to-install-che.adoc | 14 ----- .../pages/preparing-the-installation.adoc | 16 ------ .../provisioning-namespaces-in-advance.adoc | 2 +- ...user-data-in-compliance-with-the-gdpr.adoc | 2 +- .../pages/security-best-practices.adoc | 2 +- .../pages/show-deprecated-editors.adoc | 2 +- .../pages/the-woopra-telemetry-plugin.adoc | 2 +- ...gement-tool-in-restricted-environment.adoc | 4 +- .../partials/con_logging-http-traffic.adoc | 2 +- .../partials/proc_configuring-routes.adoc | 2 +- .../proc_configuring-server-logging.adoc | 2 +- ...-configmap-as-a-file-into-a-container.adoc | 2 +- ...nfigmap-as-a-subpath-into-a-container.adoc | 2 +- ...environment-variable-into-a-container.adoc | 2 +- .../troubleshooting-slow-workspaces.adoc | 2 +- .../snip_che-installation-instructions.adoc | 0 .../examples/snip_che-installing-che.adoc | 0 modules/install/nav.adoc | 31 +++++++++++ .../pages/con_installation-overview.adoc | 35 +++++++++++++ .../con_next-steps-after-installation.adoc | 20 +++++++ ...-on-amazon-elastic-kubernetes-service.adoc | 2 +- .../installing-che-on-microsoft-azure.adoc | 0 .../pages/installing-che.adoc | 6 +-- ...-the-fully-qualified-domain-name-fqdn.adoc | 4 +- ...lling-che-in-a-restricted-environment.adoc | 6 +-- ...talling-che-on-minikube-keycloak-oidc.adoc | 4 +- .../proc_installing-che-on-minikube.adoc | 4 +- ...installing-che-on-openshift-using-cli.adoc | 6 +-- ...he-on-openshift-using-the-web-console.adoc | 4 +- ...he-on-openshift-with-keycloak-as-oidc.adoc | 0 ...alling-che-on-red-hat-openshift-local.adoc | 2 +- ...che-on-the-virtual-kubernetes-cluster.adoc | 2 +- .../pages/proc_uninstalling-che.adoc | 19 +++++-- .../proc_verifying-the-installation.adoc | 52 +++++++++++++++++++ ...to-install-che-on-openshift-using-cli.adoc | 6 +-- ...he-on-openshift-using-the-web-console.adoc | 6 +-- ...r-custom-resource-during-installation.adoc | 6 +-- ...for-amazon-elastic-kubernetes-service.adoc | 0 ...-on-amazon-elastic-kubernetes-service.adoc | 0 ...-on-amazon-elastic-kubernetes-service.adoc | 0 ...oc_configuring-dns-on-microsoft-azure.adoc | 0 ...-on-amazon-elastic-kubernetes-service.adoc | 0 ...ertificate-for-che-on-microsoft-azure.adoc | 0 ...-on-amazon-elastic-kubernetes-service.adoc | 0 ...on-microsoft-azure-kubernetes-service.adoc | 0 ...-on-amazon-elastic-kubernetes-service.adoc | 0 ...on-microsoft-azure-kubernetes-service.adoc | 0 ...-on-amazon-elastic-kubernetes-service.adoc | 0 ...-on-amazon-elastic-kubernetes-service.adoc | 0 ...on-microsoft-azure-kubernetes-service.adoc | 0 ...ng-microsoft-azure-for-installing-che.adoc | 0 ...tering-application-on-microsoft-azure.adoc | 0 ...g-images-for-a-restricted-environment.adoc | 4 +- .../pages/introduction-to-eclipse-che.adoc | 2 +- 68 files changed, 213 insertions(+), 119 deletions(-) delete mode 100644 modules/administration-guide/pages/permissions-to-install-che.adoc delete mode 100644 modules/administration-guide/pages/preparing-the-installation.adoc rename modules/{administration-guide => install}/examples/snip_che-installation-instructions.adoc (100%) rename modules/{administration-guide => install}/examples/snip_che-installing-che.adoc (100%) create mode 100644 modules/install/nav.adoc create mode 100644 modules/install/pages/con_installation-overview.adoc create mode 100644 modules/install/pages/con_next-steps-after-installation.adoc rename modules/{administration-guide => install}/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc (94%) rename modules/{administration-guide => install}/pages/installing-che-on-microsoft-azure.adoc (100%) rename modules/{administration-guide => install}/pages/installing-che.adoc (64%) rename modules/{administration-guide => install}/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc (78%) rename modules/{administration-guide => install}/pages/proc_installing-che-in-a-restricted-environment.adoc (76%) rename modules/{administration-guide => install}/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc (98%) rename modules/{administration-guide => install}/pages/proc_installing-che-on-minikube.adoc (90%) rename modules/{administration-guide => install}/pages/proc_installing-che-on-openshift-using-cli.adoc (76%) rename modules/{administration-guide => install}/pages/proc_installing-che-on-openshift-using-the-web-console.adoc (88%) rename modules/{administration-guide => install}/pages/proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc (100%) rename modules/{administration-guide => install}/pages/proc_installing-che-on-red-hat-openshift-local.adoc (95%) rename modules/{administration-guide => install}/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc (99%) rename modules/{administration-guide => install}/pages/proc_uninstalling-che.adoc (69%) create mode 100644 modules/install/pages/proc_verifying-the-installation.adoc rename modules/{administration-guide => install}/pages/ref_permissions-to-install-che-on-openshift-using-cli.adoc (78%) rename modules/{administration-guide => install}/pages/ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc (81%) rename modules/{administration-guide => install}/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc (86%) rename modules/{administration-guide => install}/partials/configuring-environment-variables-for-amazon-elastic-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_associate-keycloak-as-oidc-identity-provider-on-amazon-elastic-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_configuring-dns-on-amazon-elastic-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_configuring-dns-on-microsoft-azure.adoc (100%) rename modules/{administration-guide => install}/partials/proc_creating-lets-encrypt-certificate-for-che-on-amazon-elastic-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc (100%) rename modules/{administration-guide => install}/partials/proc_installing-cert-manager-on-amazon-elastic-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_installing-cert-manager-on-microsoft-azure-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_installing-che-on-amazon-elastic-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_installing-che-on-microsoft-azure-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_installing-ingress-nginx-controller-on-amazon-elastic-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_installing-keycloak-on-amazon-elastic-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_installing-nginx-ingress-controller-on-microsoft-azure-kubernetes-service.adoc (100%) rename modules/{administration-guide => install}/partials/proc_preparing-microsoft-azure-for-installing-che.adoc (100%) rename modules/{administration-guide => install}/partials/proc_registering-application-on-microsoft-azure.adoc (100%) rename modules/{administration-guide => install}/partials/snip_preparing-images-for-a-restricted-environment.adoc (90%) diff --git a/antora.yml b/antora.yml index 2b76f5eff8..da9fca7b67 100644 --- a/antora.yml +++ b/antora.yml @@ -8,6 +8,7 @@ nav: - modules/overview/nav.adoc - modules/hosted-che/nav.adoc - modules/end-user-guide/nav.adoc + - modules/install/nav.adoc - modules/administration-guide/nav.adoc - modules/extensions/nav.adoc - modules/glossary/nav.adoc diff --git a/modules/administration-guide/examples/proc_che-configuring-ingresses.adoc b/modules/administration-guide/examples/proc_che-configuring-ingresses.adoc index d7ed2d9166..072aa083be 100644 --- a/modules/administration-guide/examples/proc_che-configuring-ingresses.adoc +++ b/modules/administration-guide/examples/proc_che-configuring-ingresses.adoc @@ -26,6 +26,6 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/examples/snip_che-concealing-editors-additional-resources.adoc b/modules/administration-guide/examples/snip_che-concealing-editors-additional-resources.adoc index 79cb4396a1..3c98c8da29 100644 --- a/modules/administration-guide/examples/snip_che-concealing-editors-additional-resources.adoc +++ b/modules/administration-guide/examples/snip_che-concealing-editors-additional-resources.adoc @@ -2,7 +2,7 @@ .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/examples/snip_che-supported-platforms.adoc b/modules/administration-guide/examples/snip_che-supported-platforms.adoc index bf0a65d623..0528d70816 100644 --- a/modules/administration-guide/examples/snip_che-supported-platforms.adoc +++ b/modules/administration-guide/examples/snip_che-supported-platforms.adoc @@ -23,4 +23,4 @@ The following options are available for the local installation: .Additional resources -* xref:installing-che.adoc[] +* xref:install:installing-che.adoc[] diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index e26825866c..27c2c6d02b 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -1,8 +1,7 @@ .Administration Guide * xref:security-best-practices.adoc[] -* xref:preparing-the-installation.adoc[] -** xref:supported-platforms.adoc[] +* xref:supported-platforms.adoc[] ** xref:installing-the-chectl-management-tool.adoc[] ** xref:architecture-overview.adoc[] *** xref:server-components.adoc[] @@ -16,29 +15,9 @@ *** xref:user-workspaces.adoc[] ** xref:calculating-che-resource-requirements.adoc[] * xref:running-at-scale.adoc[] -// Install -* 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:proc_finding-the-fully-qualified-domain-name-fqdn.adoc[] -** xref:permissions-to-install-che.adoc[] -*** 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:configuring-che.adoc[] ** xref:understanding-the-checluster-custom-resource.adoc[] -*** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +*** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] *** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] *** xref:checluster-custom-resource-fields-reference.adoc[] ** xref:configuring-namespace-provisioning.adoc[] @@ -137,4 +116,3 @@ ** 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[] -* xref:proc_uninstalling-che.adoc[] diff --git a/modules/administration-guide/pages/che-operator.adoc b/modules/administration-guide/pages/che-operator.adoc index f8ab47018e..6abcb4fba2 100644 --- a/modules/administration-guide/pages/che-operator.adoc +++ b/modules/administration-guide/pages/che-operator.adoc @@ -29,4 +29,4 @@ On a cluster with the {prod-short} operator, it is possible to create a `CheClus .Additional resources * xref:understanding-the-checluster-custom-resource.adoc[] -* xref:installing-che.adoc[] +* xref:install:installing-che.adoc[] diff --git a/modules/administration-guide/pages/configuring-che-hostname.adoc b/modules/administration-guide/pages/configuring-che-hostname.adoc index 5841a2f8fc..f524526c10 100644 --- a/modules/administration-guide/pages/configuring-che-hostname.adoc +++ b/modules/administration-guide/pages/configuring-che-hostname.adoc @@ -66,6 +66,6 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc b/modules/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc index b82c93fe37..f657cd5046 100644 --- a/modules/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc +++ b/modules/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc @@ -63,4 +63,4 @@ $ {orch-cli} label secret self-signed-certificate app.kubernetes.io/part-of=che. .Additional resources -* xref:installing-che.adoc[] +* xref:install:installing-che.adoc[] diff --git a/modules/administration-guide/pages/configuring-storage-classes.adoc b/modules/administration-guide/pages/configuring-storage-classes.adoc index 7c6be0de16..d3ff3a5d0d 100644 --- a/modules/administration-guide/pages/configuring-storage-classes.adoc +++ b/modules/administration-guide/pages/configuring-storage-classes.adoc @@ -30,7 +30,7 @@ Define a storage class name in the {prod-short} configuration to use the storage Use CheCluster Custom Resource definition to define storage classes: -. Define storage class names: configure the `CheCluster` Custom Resource, and install {prod-short}. See xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]. +. Define storage class names: configure the `CheCluster` Custom Resource, and install {prod-short}. See xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]. + [source,yaml,subs="+quotes,+attributes"] ---- @@ -51,6 +51,6 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/configuring-storage-sizes.adoc b/modules/administration-guide/pages/configuring-storage-sizes.adoc index ccf3739acc..80d7922ae1 100644 --- a/modules/administration-guide/pages/configuring-storage-sizes.adoc +++ b/modules/administration-guide/pages/configuring-storage-sizes.adoc @@ -35,7 +35,7 @@ per-workspace: 5Gi [NOTE] ==== -* You can set this field at installation. See xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]. +* You can set this field at installation. See xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]. * You can update this field on the command line. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]. diff --git a/modules/administration-guide/pages/configuring-the-storage-strategy.adoc b/modules/administration-guide/pages/configuring-the-storage-strategy.adoc index 2e2e1eac85..dcbc6256b9 100644 --- a/modules/administration-guide/pages/configuring-the-storage-strategy.adoc +++ b/modules/administration-guide/pages/configuring-the-storage-strategy.adoc @@ -24,7 +24,7 @@ The default storage strategy used in {prod-short} is `per-user`. [NOTE] ==== -* You can set this field at installation. See xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]. +* You can set this field at installation. See xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]. * You can update this field on the command line. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]. diff --git a/modules/administration-guide/pages/configuring-workspace-target-namespace.adoc b/modules/administration-guide/pages/configuring-workspace-target-namespace.adoc index d7be519ec1..09957b1453 100644 --- a/modules/administration-guide/pages/configuring-workspace-target-namespace.adoc +++ b/modules/administration-guide/pages/configuring-workspace-target-namespace.adoc @@ -56,6 +56,6 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/configuring-workspaces-nodeselector.adoc b/modules/administration-guide/pages/configuring-workspaces-nodeselector.adoc index 0241453f8d..156732bc74 100644 --- a/modules/administration-guide/pages/configuring-workspaces-nodeselector.adoc +++ b/modules/administration-guide/pages/configuring-workspaces-nodeselector.adoc @@ -51,6 +51,6 @@ Pass the name of this newly created `StorageClass` to {prod-short} through the ` .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc b/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc index 3f59d912e7..bfa9f9edf1 100644 --- a/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc +++ b/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc @@ -69,7 +69,7 @@ sslCAInfo = /etc/config/che-git-tls-creds/certificate .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/permissions-to-install-che.adoc b/modules/administration-guide/pages/permissions-to-install-che.adoc deleted file mode 100644 index 12f0d350ad..0000000000 --- a/modules/administration-guide/pages/permissions-to-install-che.adoc +++ /dev/null @@ -1,14 +0,0 @@ -:_content-type: ASSEMBLY -:description: Permissions to install {prod} -:keywords: administration-guide, installing, permissions -:navtitle: Permissions to install {prod-short} -:page-aliases: - -[id="permissions-to-install-che"] -= Permissions to install {prod-short} - -Learn about the permissions required to install {prod} on different {kubernetes} clusters. - -* xref:ref_permissions-to-install-che-on-openshift-using-cli.adoc[] - -* xref:ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc[] diff --git a/modules/administration-guide/pages/preparing-the-installation.adoc b/modules/administration-guide/pages/preparing-the-installation.adoc deleted file mode 100644 index 0e5ff54637..0000000000 --- a/modules/administration-guide/pages/preparing-the-installation.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:_content-type: ASSEMBLY -:description: Preparing the installation -:keywords: preparing, installation -:navtitle: Preparing the installation -:page-aliases: - -[id="preparing-the-installation"] -= Preparing the installation - -To prepare a {prod-short} installation, learn about the {prod-short} ecosystem and deployment constraints: - -* xref:supported-platforms.adoc[] -* xref:installing-the-chectl-management-tool.adoc[] -* xref:architecture-overview.adoc[] -* xref:calculating-che-resource-requirements.adoc[] -* xref:understanding-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/provisioning-namespaces-in-advance.adoc b/modules/administration-guide/pages/provisioning-namespaces-in-advance.adoc index 7333c08ce0..e4c7a95a85 100644 --- a/modules/administration-guide/pages/provisioning-namespaces-in-advance.adoc +++ b/modules/administration-guide/pages/provisioning-namespaces-in-advance.adoc @@ -38,6 +38,6 @@ metadata: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/removing-user-data-in-compliance-with-the-gdpr.adoc b/modules/administration-guide/pages/removing-user-data-in-compliance-with-the-gdpr.adoc index 9595f66811..673332e40e 100644 --- a/modules/administration-guide/pages/removing-user-data-in-compliance-with-the-gdpr.adoc +++ b/modules/administration-guide/pages/removing-user-data-in-compliance-with-the-gdpr.adoc @@ -36,4 +36,4 @@ $ oc delete user * xref:managing-workloads-using-the-che-server-api.adoc[] * xref:configuring-workspace-target-namespace.adoc[] -* xref:proc_uninstalling-che.adoc[] +* xref:install:proc_uninstalling-che.adoc[] diff --git a/modules/administration-guide/pages/security-best-practices.adoc b/modules/administration-guide/pages/security-best-practices.adoc index 0b36f80f77..ec44d4c50d 100644 --- a/modules/administration-guide/pages/security-best-practices.adoc +++ b/modules/administration-guide/pages/security-best-practices.adoc @@ -249,7 +249,7 @@ In an air-gapped environment, the cluster cannot access external repositories or registries to download container images, updates, or dependencies. {prod} is supported and can be installed in a restricted environment. -include::example$snip_che-installation-instructions.adoc[] +include::install:example$snip_che-installation-instructions.adoc[] .Managing extensions diff --git a/modules/administration-guide/pages/show-deprecated-editors.adoc b/modules/administration-guide/pages/show-deprecated-editors.adoc index c2a1521f1b..54eb992c5b 100644 --- a/modules/administration-guide/pages/show-deprecated-editors.adoc +++ b/modules/administration-guide/pages/show-deprecated-editors.adoc @@ -41,6 +41,6 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/the-woopra-telemetry-plugin.adoc b/modules/administration-guide/pages/the-woopra-telemetry-plugin.adoc index 2ebe2efc10..14076e5ac1 100644 --- a/modules/administration-guide/pages/the-woopra-telemetry-plugin.adoc +++ b/modules/administration-guide/pages/the-woopra-telemetry-plugin.adoc @@ -40,6 +40,6 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc b/modules/administration-guide/pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc index 0b6a664c53..63e05c3308 100644 --- a/modules/administration-guide/pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc +++ b/modules/administration-guide/pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc @@ -11,9 +11,9 @@ This section describes how to upgrade {prod} and perform minor version updates b .Prerequisites -* The {prod-short} instance was installed on OpenShift using the `{prod-cli} --installer operator` method in the `{prod-namespace}` project. See xref:proc_installing-che-in-a-restricted-environment.adoc[]. +* 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[]. -include::partial$snip_preparing-images-for-a-restricted-environment.adoc[] +include::install:partial$snip_preparing-images-for-a-restricted-environment.adoc[] . In all running workspaces in the {prod-prev-short} {prod-prev-ver} instance, save and push changes back to the Git repositories. diff --git a/modules/administration-guide/partials/con_logging-http-traffic.adoc b/modules/administration-guide/partials/con_logging-http-traffic.adoc index 81022ce438..3f780d3c13 100644 --- a/modules/administration-guide/partials/con_logging-http-traffic.adoc +++ b/modules/administration-guide/partials/con_logging-http-traffic.adoc @@ -18,7 +18,7 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/partials/proc_configuring-routes.adoc b/modules/administration-guide/partials/proc_configuring-routes.adoc index 11fc42e164..9d8f516873 100644 --- a/modules/administration-guide/partials/proc_configuring-routes.adoc +++ b/modules/administration-guide/partials/proc_configuring-routes.adoc @@ -29,6 +29,6 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/partials/proc_configuring-server-logging.adoc b/modules/administration-guide/partials/proc_configuring-server-logging.adoc index c06ce8e006..ef0e740b58 100644 --- a/modules/administration-guide/partials/proc_configuring-server-logging.adoc +++ b/modules/administration-guide/partials/proc_configuring-server-logging.adoc @@ -32,7 +32,7 @@ spec: .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-file-into-a-container.adoc b/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-file-into-a-container.adoc index e90a3045fc..f93ab15069 100644 --- a/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-file-into-a-container.adoc +++ b/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-file-into-a-container.adoc @@ -96,7 +96,7 @@ IMPORTANT: To make the changes in the {prod-short} container visible, re-create .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-subpath-into-a-container.adoc b/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-subpath-into-a-container.adoc index 169c0401b7..65ea99bdc1 100644 --- a/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-subpath-into-a-container.adoc +++ b/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-a-subpath-into-a-container.adoc @@ -96,7 +96,7 @@ IMPORTANT: To make the changes in a {prod-short} container visible, re-create th .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc b/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc index 221ebe458d..11ab0058c0 100644 --- a/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc +++ b/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc @@ -118,7 +118,7 @@ IMPORTANT: To make the changes in the {prod-short} container visible, re-create .Additional resources -* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] * xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[] diff --git a/modules/end-user-guide/pages/troubleshooting-slow-workspaces.adoc b/modules/end-user-guide/pages/troubleshooting-slow-workspaces.adoc index 08002eed97..ef959e8063 100644 --- a/modules/end-user-guide/pages/troubleshooting-slow-workspaces.adoc +++ b/modules/end-user-guide/pages/troubleshooting-slow-workspaces.adoc @@ -32,7 +32,7 @@ Installing offline:: + _Role: Administrator_ + -Components of {prod-short} are OCI images. Set up {prod} in offline mode to reduce any extra download at runtime because everything needs to be available from the beginning. See xref:administration-guide:installing-che-in-a-restricted-environment.adoc[]. +Components of {prod-short} are OCI images. Set up {prod} in offline mode to reduce any extra download at runtime because everything needs to be available from the beginning. See xref:install:proc_installing-che-in-a-restricted-environment.adoc[]. Reducing the number of public endpoints:: + diff --git a/modules/administration-guide/examples/snip_che-installation-instructions.adoc b/modules/install/examples/snip_che-installation-instructions.adoc similarity index 100% rename from modules/administration-guide/examples/snip_che-installation-instructions.adoc rename to modules/install/examples/snip_che-installation-instructions.adoc diff --git a/modules/administration-guide/examples/snip_che-installing-che.adoc b/modules/install/examples/snip_che-installing-che.adoc similarity index 100% rename from modules/administration-guide/examples/snip_che-installing-che.adoc rename to modules/install/examples/snip_che-installing-che.adoc diff --git a/modules/install/nav.adoc b/modules/install/nav.adoc new file mode 100644 index 0000000000..303d5111d2 --- /dev/null +++ b/modules/install/nav.adoc @@ -0,0 +1,31 @@ +.Install +* xref:con_installation-overview.adoc[] +// Requirements +* Requirements +** xref:administration-guide:supported-platforms.adoc[] +** xref:administration-guide:calculating-che-resource-requirements.adoc[] +** xref:administration-guide: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[] +** xref:proc_finding-the-fully-qualified-domain-name-fqdn.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:con_next-steps-after-installation.adoc[] +* xref:proc_uninstalling-che.adoc[] diff --git a/modules/install/pages/con_installation-overview.adoc b/modules/install/pages/con_installation-overview.adoc new file mode 100644 index 0000000000..d9a3d0df7f --- /dev/null +++ b/modules/install/pages/con_installation-overview.adoc @@ -0,0 +1,35 @@ +:_content-type: CONCEPT +:description: {prod-short} deploys on {orch-name} as an Operator that manages a gateway, dashboard, server, and plug-in registry. The installation method you choose — CLI or web console — depends on your cluster environment, security requirements, and need for configuration control. +:keywords: install, overview, deployment, operator +:navtitle: {prod-short} installation overview + +[id="con_installation-overview"] += {prod-short} installation overview + +[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 — CLI or web console — depends on your cluster environment, security requirements, and need for configuration control. + +{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 + +{prod-short} supports two installation methods: + +`{prod-cli}` command-line tool:: Install and manage {prod-short} from the command line. This method provides the most control over the installation process and supports advanced configuration options during deployment. + +{orch-name} web console:: Install the {prod} Operator from OperatorHub and create a `CheCluster` instance through the web console. This method uses the standard {orch-name} Operator installation workflow. + +== Deployment scenarios + +Standard installation:: Deploy {prod-short} on an {orch-name} cluster with internet access. Both the CLI and web console methods are available. + +Restricted environment:: Deploy {prod-short} on an air-gapped or disconnected {orch-name} cluster. This scenario requires mirroring container images to a private registry before installation. + +External identity provider:: Deploy {prod-short} with {keycloak} as an external OpenID Connect (OIDC) identity provider instead of the default {orch-name} OAuth. This scenario applies when you need to integrate with an existing identity management system. + +.Additional resources + +* xref:proc_installing-che-on-openshift-using-cli.adoc[] +* xref:proc_installing-che-on-openshift-using-the-web-console.adoc[] +* xref:proc_installing-che-in-a-restricted-environment.adoc[] +* xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[] diff --git a/modules/install/pages/con_next-steps-after-installation.adoc b/modules/install/pages/con_next-steps-after-installation.adoc new file mode 100644 index 0000000000..e554ee453a --- /dev/null +++ b/modules/install/pages/con_next-steps-after-installation.adoc @@ -0,0 +1,20 @@ +:_content-type: CONCEPT +:description: After a successful installation, configure the CheCluster resource, connect Git providers, and create your first workspace. +:keywords: install, next steps, configuration, post-install +:navtitle: Next steps after installation + +[id="con_next-steps-after-installation"] += Next steps after installation + +[role="_abstract"] +After a successful installation, a few configuration tasks remain before your team can start using {prod-short} — customizing the `CheCluster` resource, connecting Git providers, and verifying end-to-end functionality with a first workspace. + +* Configure the `CheCluster` custom resource to customize {prod-short} behavior. +* Configure OAuth for Git providers so that users can interact with remote Git repositories. +* Create your first workspace from a Git repository URL. + +.Additional resources + +* xref:administration-guide:understanding-the-checluster-custom-resource.adoc[] +* xref:administration-guide:configuring-oauth-for-git-providers.adoc[] +* xref:end-user-guide:starting-a-workspace-from-a-git-repository-url.adoc[] diff --git a/modules/administration-guide/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc b/modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc similarity index 94% rename from modules/administration-guide/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc rename to modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc index e179cdc752..50e6f93a9a 100644 --- a/modules/administration-guide/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc +++ b/modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc @@ -13,7 +13,7 @@ To provide cloud development environments on AWS, deploy {prod-short} on an Amaz * You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm]. -* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. * You have the `aws` CLI installed. See link:https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html[AWS CLI install and update instructions]. diff --git a/modules/administration-guide/pages/installing-che-on-microsoft-azure.adoc b/modules/install/pages/installing-che-on-microsoft-azure.adoc similarity index 100% rename from modules/administration-guide/pages/installing-che-on-microsoft-azure.adoc rename to modules/install/pages/installing-che-on-microsoft-azure.adoc diff --git a/modules/administration-guide/pages/installing-che.adoc b/modules/install/pages/installing-che.adoc similarity index 64% rename from modules/administration-guide/pages/installing-che.adoc rename to modules/install/pages/installing-che.adoc index a29cbdb73d..3be2b0dd4f 100644 --- a/modules/administration-guide/pages/installing-che.adoc +++ b/modules/install/pages/installing-che.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY -:description: Provide your development team with consistent, browser-based cloud development environments by deploying {prod-short} on {orch-name}, {kubernetes}, or a local single-node cluster. -:keywords: administration guide, installing-che, install, deploy +:description: Install {prod-short} on an {orch-name} or {kubernetes} cluster by using the command-line interface (CLI) or the web console. Choose the method that matches your cluster environment and configuration needs. +:keywords: install, deploy, openshift, kubernetes :navtitle: Install {prod-short} :page-aliases: installation-guide:installing-che.adoc, installation-guide:3-minutes-to-che.adoc, overview:3-minutes-to-che.adoc, installation-guide:quick-starts.adoc, installation-guide:che-quick-starts.adoc, .:quick-start.html, overview:che-quick-start.adoc, installation-guide:installing-che-on-aws.adoc, installation-guide:installing-che-on-docker-desktop.adoc, installation-guide:installing-che-on-google-cloud-platform.adoc, installation-guide:installing-che-on-kind.adoc, installation-guide:installing-che-on-kubespray.adoc, installation-guide:installing-che-on-microsoft-azure.adoc, installation-guide:installing-che-on-openshift-3-using-the-operator.adoc @@ -8,7 +8,7 @@ = Install {prod-short} [role="_abstract"] -To provide your development team with consistent, browser-based cloud development environments, deploy {prod-short} on {orch-name}, {kubernetes}, or a local single-node cluster. Choose the deployment method that matches your target platform and environment. +Install {prod-short} on an {orch-name} or {kubernetes} cluster by using the command-line interface (CLI) or the web console. Choose the method that matches your cluster environment and configuration needs. [NOTE] ==== diff --git a/modules/administration-guide/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc similarity index 78% rename from modules/administration-guide/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc rename to modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc index 344eeb993b..9baea25bd1 100644 --- a/modules/administration-guide/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc +++ b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -:description: Finding the FQDN of a {prod-short} instance +:description: Retrieve the {prod-short} dashboard URL from the CheCluster custom resource. You need this URL to open the dashboard in a browser or share the endpoint with your development team. :keywords: fqdn, domain, url, dashboard :navtitle: Find the FQDN :page-aliases: finding-the-fully-qualified-domain-name-fqdn.adoc @@ -8,7 +8,7 @@ = Find the fully qualified domain name (FQDN) [role="_abstract"] -Retrieve the fully qualified domain name (FQDN) of your organization's instance of {prod-short} on the command line to access the {prod-short} dashboard URL. +Retrieve the {prod-short} dashboard URL from the `CheCluster` custom resource. You need this URL to open the dashboard in a browser or share the endpoint with your development team. [TIP] ==== diff --git a/modules/administration-guide/pages/proc_installing-che-in-a-restricted-environment.adoc b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc similarity index 76% rename from modules/administration-guide/pages/proc_installing-che-in-a-restricted-environment.adoc rename to modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc index 937d4aa27a..c4d0723fc6 100644 --- a/modules/administration-guide/pages/proc_installing-che-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -:description: To provide cloud development environments on an air-gapped {orch-name} cluster, mirror the required images and operator catalogs, then deploy {prod-short}. +:description: Deploy {prod-short} on an air-gapped {orch-name} cluster by mirroring the required container images and Operator catalogs to a private registry. This procedure covers the additional steps needed when the cluster has no direct internet access. :keywords: install, restricted, air-gapped, disconnected, openshift :navtitle: Install {prod-short} in a restricted environment :page-aliases: installation-guide:installing-che-in-restricted-environment.adoc, installation-guide:installing-che-in-a-restricted-environment.adoc, preparing-a-restricted-environment.adoc, configuring-che-to-run-in-a-restricted-environment.adoc, installing-che-in-a-restricted-environment.adoc @@ -8,7 +8,7 @@ = Install {prod-short} in a restricted environment on {orch-name} [role="_abstract"] -To provide cloud development environments on an air-gapped {orch-name} cluster, mirror the required images and operator catalogs to a registry within the restricted network, then deploy {prod-short}. +Deploy {prod-short} on an air-gapped {orch-name} cluster by mirroring the required container images and Operator catalogs to a private registry. This procedure covers the additional steps needed when the cluster has no direct internet access. On a restricted network, deploying {prod-short} and running workspaces requires the following public resources: @@ -37,7 +37,7 @@ $ {prod-cli} server:deploy \ --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml ---- -. Allow incoming traffic from the {prod-short} namespace to all Pods in the user {orch-namespace}s. See: xref:configuring-network-policies.adoc[]. +. Allow incoming traffic from the {prod-short} namespace to all Pods in the user {orch-namespace}s. See: xref:administration-guide:configuring-network-policies.adoc[]. .Verification diff --git a/modules/administration-guide/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc b/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc similarity index 98% rename from modules/administration-guide/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc rename to modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc index 4ac905f2e6..bb66a3b01a 100644 --- a/modules/administration-guide/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc @@ -23,7 +23,7 @@ Single-node {kubernetes} clusters are suited only for testing or development. Do * You have `{orch-cli}` installed. See link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing `{orch-cli}`]. -* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. .Procedure @@ -367,4 +367,4 @@ sleep 5s && \ [role="_additional-resources"] .Additional resources -* xref:configuring-che-with-self-signed-certificate.adoc[] +* xref:administration-guide:configuring-che-with-self-signed-certificate.adoc[] diff --git a/modules/administration-guide/pages/proc_installing-che-on-minikube.adoc b/modules/install/pages/proc_installing-che-on-minikube.adoc similarity index 90% rename from modules/administration-guide/pages/proc_installing-che-on-minikube.adoc rename to modules/install/pages/proc_installing-che-on-minikube.adoc index e106fdf2f5..d439dcc6f3 100644 --- a/modules/administration-guide/pages/proc_installing-che-on-minikube.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube.adoc @@ -21,7 +21,7 @@ Single-node {kubernetes} clusters are suited only for testing or development. Do * You have `{orch-cli}` installed. See link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing `{orch-cli}`]. -* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. .Procedure @@ -58,4 +58,4 @@ $ {prod-cli} dashboard:open [role="_additional-resources"] .Additional resources -* xref:configuring-che-with-self-signed-certificate.adoc[] +* xref:administration-guide:configuring-che-with-self-signed-certificate.adoc[] diff --git a/modules/administration-guide/pages/proc_installing-che-on-openshift-using-cli.adoc b/modules/install/pages/proc_installing-che-on-openshift-using-cli.adoc similarity index 76% rename from modules/administration-guide/pages/proc_installing-che-on-openshift-using-cli.adoc rename to modules/install/pages/proc_installing-che-on-openshift-using-cli.adoc index b4f9c2f28d..18d4b4937f 100644 --- a/modules/administration-guide/pages/proc_installing-che-on-openshift-using-cli.adoc +++ b/modules/install/pages/proc_installing-che-on-openshift-using-cli.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -:description: To set up cloud development environments for your team on an OpenShift cluster, deploy {prod-short} by using the {prod-cli} CLI management tool. +:description: Install the {prod-short} Operator and create a CheCluster instance from the command line by using the {prod-cli} management tool. The CLI method provides full control over configuration options during deployment. :keywords: install, openshift, cli, chectl :navtitle: Install {prod-short} on OpenShift using CLI :page-aliases: installation-guide:installing-che-on-openshift-4-using-cli.adoc, overview:installing-che-on-openshift-4-using-cli.adoc, installing-che-on-openshift-4-using-cli.adoc, installing-che-on-openshift-using-cli.adoc @@ -8,7 +8,7 @@ = Install {prod-short} on OpenShift using CLI [role="_abstract"] -To set up cloud development environments for your team on an {orch-name} cluster, deploy {prod-short} by using the `{prod-cli}` CLI management tool. +Install the {prod-short} Operator and create a `CheCluster` instance from the command line by using the `{prod-cli}` management tool. The CLI method provides full control over configuration options during deployment. .Prerequisites @@ -16,7 +16,7 @@ To set up cloud development environments for your team on an {orch-name} cluster * You have an active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI]. -* You have the `{prod-cli}` management tool installed. See xref:installing-the-chectl-management-tool.adoc[]. +* You have the `{prod-cli}` management tool installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. .Procedure diff --git a/modules/administration-guide/pages/proc_installing-che-on-openshift-using-the-web-console.adoc b/modules/install/pages/proc_installing-che-on-openshift-using-the-web-console.adoc similarity index 88% rename from modules/administration-guide/pages/proc_installing-che-on-openshift-using-the-web-console.adoc rename to modules/install/pages/proc_installing-che-on-openshift-using-the-web-console.adoc index 85b35b631d..c7dbf0c751 100644 --- a/modules/administration-guide/pages/proc_installing-che-on-openshift-using-the-web-console.adoc +++ b/modules/install/pages/proc_installing-che-on-openshift-using-the-web-console.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -:description: To set up cloud development environments for your team on an OpenShift cluster, deploy {prod-short} through the web console by using OperatorHub. +:description: Deploy the {prod} Operator from OperatorHub and create a CheCluster instance through the {orch-name} web console. This method uses the standard Operator workflow and is suitable when you do not need advanced CLI configuration options. :keywords: install, openshift, web console, operatorhub :navtitle: Install {prod-short} on OpenShift using the web console :page-aliases: installation-guide:installing-che-on-openshift-4-using-operatorhub.adoc, overview:installing-che-on-openshift-4-using-operatorhub.adoc, creating-an-instance-of-the-che-operator.adoc, installing-che-on-openshift-4-using-operatorhub.adoc, installing-che-on-openshift-using-the-web-console.adoc @@ -8,7 +8,7 @@ = Install {prod-short} on OpenShift using the web console [role="_abstract"] -To set up cloud development environments for your team on an {orch-name} cluster, deploy {prod-short} through the web console by using OperatorHub and creating a `CheCluster` instance. +Deploy the {prod} Operator from OperatorHub and create a `CheCluster` instance through the {orch-name} web console. This method uses the standard Operator workflow and is suitable when you do not need advanced CLI configuration options. .Prerequisites diff --git a/modules/administration-guide/pages/proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc b/modules/install/pages/proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc similarity index 100% rename from modules/administration-guide/pages/proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc rename to modules/install/pages/proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc diff --git a/modules/administration-guide/pages/proc_installing-che-on-red-hat-openshift-local.adoc b/modules/install/pages/proc_installing-che-on-red-hat-openshift-local.adoc similarity index 95% rename from modules/administration-guide/pages/proc_installing-che-on-red-hat-openshift-local.adoc rename to modules/install/pages/proc_installing-che-on-red-hat-openshift-local.adoc index 669900ab42..557726d6c1 100644 --- a/modules/administration-guide/pages/proc_installing-che-on-red-hat-openshift-local.adoc +++ b/modules/install/pages/proc_installing-che-on-red-hat-openshift-local.adoc @@ -12,7 +12,7 @@ To evaluate {prod-short} on a local {orch-name} cluster, deploy {prod-short} by .Prerequisites -* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. * You have a running instance of {rh-os-local}. See link:https://developers.redhat.com/products/openshift-local/overview[{rh-os-local} overview]. diff --git a/modules/administration-guide/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc b/modules/install/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc similarity index 99% rename from modules/administration-guide/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc rename to modules/install/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc index 0e35b96b55..752336577d 100644 --- a/modules/administration-guide/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc +++ b/modules/install/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc @@ -20,7 +20,7 @@ To deploy {prod-short} when the host cluster version is incompatible or lacks ex * You have `kubelogin` installed. See link:https://github.com/int128/kubelogin[Installing kubelogin]. -* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. * You have an active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. diff --git a/modules/administration-guide/pages/proc_uninstalling-che.adoc b/modules/install/pages/proc_uninstalling-che.adoc similarity index 69% rename from modules/administration-guide/pages/proc_uninstalling-che.adoc rename to modules/install/pages/proc_uninstalling-che.adoc index ec1436bbfa..c401e9f288 100644 --- a/modules/administration-guide/pages/proc_uninstalling-che.adoc +++ b/modules/install/pages/proc_uninstalling-che.adoc @@ -1,5 +1,5 @@ :_content-type: PROCEDURE -:description: Uninstalling {prod-short} +:description: Remove {prod-short} and all related user data from an {orch-name} cluster by using the {prod-cli} management tool. :keywords: uninstall, remove, delete :navtitle: Uninstall {prod-short} :page-aliases: installation-guide:uninstalling-che.adoc, installation-guide:uninstalling-che-after-operatorhub-installation.adoc, uninstalling-che-on-openshift.adoc, installation-guide:uninstalling-che-after-chectl-installation.adoc, uninstalling-che-by-using-chectl.adoc, uninstalling-che.adoc @@ -8,7 +8,7 @@ = Uninstall {prod-short} [role="_abstract"] -Use `{prod-cli}` to uninstall the {prod-short} instance and remove all {prod-short}-related user data from the cluster. +Remove {prod-short} and all related user data from an {orch-name} cluster by using the `{prod-cli}` management tool. [WARNING] ==== @@ -17,7 +17,7 @@ Uninstalling {prod-short} removes all {prod-short}-related user data. .Prerequisites -* You have the `{prod-cli}` management tool installed. See xref:installing-the-chectl-management-tool.adoc[]. +* You have the `{prod-cli}` management tool installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. .Procedure @@ -40,7 +40,18 @@ The `--delete-all` option removes the {devworkspace} Operator and the related re Standard operating procedure (SOP) for removing {devworkspace} Operator manually without `{prod-cli}` is available in the {ocp} link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp4-ver}/html/web_console/web-terminal#removing-devworkspace-operator_uninstalling-web-terminal[official documentation]. ==== +.Verification + +* Verify that the {prod-short} namespace has been removed: ++ +[source,bash,subs="+attributes"] +---- +{orch-cli} get namespace {prod-namespace} +---- ++ +The expected output is `NotFound`. + [role="_additional-resources"] .Additional resources -* xref:installing-the-chectl-management-tool.adoc[] +* xref:administration-guide:installing-the-chectl-management-tool.adoc[] diff --git a/modules/install/pages/proc_verifying-the-installation.adoc b/modules/install/pages/proc_verifying-the-installation.adoc new file mode 100644 index 0000000000..93ae6b395b --- /dev/null +++ b/modules/install/pages/proc_verifying-the-installation.adoc @@ -0,0 +1,52 @@ +:_content-type: PROCEDURE +:description: Confirm that {prod-short} is operational before onboarding users by checking the Operator pod, the CheCluster status, and the dashboard URL. +:keywords: install, verify, check, status +:navtitle: Verify the {prod-short} installation + +[id="proc_verifying-the-installation"] += Verify the {prod-short} installation + +[role="_abstract"] +Confirm that {prod-short} is operational before onboarding users by checking the Operator pod, the `CheCluster` status, and the dashboard URL. + +.Prerequisites + +* You have installed {prod-short} on an {orch-name} cluster. +* You have an active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. + +.Procedure + +. Verify that the {prod-short} Operator pod is running: ++ +[source,bash,subs="+attributes"] +---- +{orch-cli} get pods -n {prod-namespace} -l app.kubernetes.io/component={prod-id-short}-operator +---- + +. Verify that the `CheCluster` custom resource reports no errors: ++ +[source,bash,subs="+attributes"] +---- +{orch-cli} get checluster {prod-checluster} -n {prod-namespace} -o jsonpath='{.status.chePhase}' +---- ++ +The expected output is `Active`. + +. Retrieve the {prod-short} dashboard URL: ++ +[source,bash,subs="+attributes"] +---- +{orch-cli} get checluster {prod-checluster} -n {prod-namespace} -o jsonpath='{.status.cheURL}' +---- + +. Open the URL in a web browser and log in with your {orch-name} credentials. + +.Verification + +* The {prod-short} dashboard loads and displays the *Create Workspace* page. + +[role="_additional-resources"] +.Additional resources + +* xref:proc_installing-che-on-openshift-using-cli.adoc[] +* xref:proc_installing-che-on-openshift-using-the-web-console.adoc[] diff --git a/modules/administration-guide/pages/ref_permissions-to-install-che-on-openshift-using-cli.adoc b/modules/install/pages/ref_permissions-to-install-che-on-openshift-using-cli.adoc similarity index 78% rename from modules/administration-guide/pages/ref_permissions-to-install-che-on-openshift-using-cli.adoc rename to modules/install/pages/ref_permissions-to-install-che-on-openshift-using-cli.adoc index 81968ec5c1..01d72ec9bc 100644 --- a/modules/administration-guide/pages/ref_permissions-to-install-che-on-openshift-using-cli.adoc +++ b/modules/install/pages/ref_permissions-to-install-che-on-openshift-using-cli.adoc @@ -1,5 +1,5 @@ :_content-type: REFERENCE -:description: Permissions required to install {prod-short} on OpenShift using CLI +:description: The following ClusterRole defines the minimum permissions required for a {prod-cli}-based installation of {prod-short}. Apply this role to the service account or user of the installation program before running {prod-cli} server:deploy. :keywords: permissions, rbac, cli, install :navtitle: Permissions for CLI installation :page-aliases: permissions-to-install-che-on-openshift-using-cli.adoc @@ -8,9 +8,7 @@ = Permissions to install {prod-short} on OpenShift using CLI [role="_abstract"] -A specific set of permissions is required to install {prod-short} on an {orch-name} cluster using the {prod-cli} CLI tool. - -The following YAML shows the minimal set of permissions required to install {prod-short} on an {orch-name} cluster using {prod-cli}: +The following `ClusterRole` defines the minimum permissions required for a `{prod-cli}`-based installation of {prod-short}. Apply this role to the service account or user of the installation program before running `{prod-cli} server:deploy`. [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/administration-guide/pages/ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc b/modules/install/pages/ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc similarity index 81% rename from modules/administration-guide/pages/ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc rename to modules/install/pages/ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc index 8cfef56f41..cc4433005c 100644 --- a/modules/administration-guide/pages/ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc +++ b/modules/install/pages/ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc @@ -1,5 +1,5 @@ :_content-type: REFERENCE -:description: Permissions required to install {prod-short} on OpenShift using the web console +:description: The following ClusterRole defines the minimum permissions required for a web-console-based installation of {prod-short}. Apply this role to the user of the installation program before installing the Operator from OperatorHub. :keywords: permissions, rbac, web console, install :navtitle: Permissions for web console installation :page-aliases: permissions-to-install-che-on-openshift-using-the-web-console.adoc @@ -8,9 +8,7 @@ = Permissions to install {prod-short} on OpenShift using web console [role="_abstract"] -A specific set of permissions is required to install {prod-short} on an {orch-name} cluster using the web console. - -The following YAML shows the minimal set of permissions required to install {prod-short} on an {orch-name} cluster using the web console: +The following `ClusterRole` defines the minimum permissions required for a web-console-based installation of {prod-short}. Apply this role to the user of the installation program before installing the Operator from OperatorHub. [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/administration-guide/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc b/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc similarity index 86% rename from modules/administration-guide/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc rename to modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc index 995609a9c0..ab64779406 100644 --- a/modules/administration-guide/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc +++ b/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc @@ -14,7 +14,7 @@ To deploy {prod-short} with a suitable configuration, edit the `CheCluster` Cust * An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}. -* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[]. +* `{prod-cli}`. See: xref:administration-guide:installing-the-chectl-management-tool.adoc[]. .Procedure * Create a `che-operator-cr-patch.yaml` YAML file that contains the subset of the `CheCluster` Custom Resource to configure: @@ -49,6 +49,6 @@ $ oc get configmap che -o jsonpath='{.data.__}' \ [role="_additional-resources"] .Additional resources -* xref:checluster-custom-resource-fields-reference.adoc[]. +* xref:administration-guide:checluster-custom-resource-fields-reference.adoc[]. -* xref:advanced-configuration-options-for-the-che-server-component.adoc[]. +* xref:administration-guide:advanced-configuration-options-for-the-che-server-component.adoc[]. diff --git a/modules/administration-guide/partials/configuring-environment-variables-for-amazon-elastic-kubernetes-service.adoc b/modules/install/partials/configuring-environment-variables-for-amazon-elastic-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/configuring-environment-variables-for-amazon-elastic-kubernetes-service.adoc rename to modules/install/partials/configuring-environment-variables-for-amazon-elastic-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_associate-keycloak-as-oidc-identity-provider-on-amazon-elastic-kubernetes-service.adoc b/modules/install/partials/proc_associate-keycloak-as-oidc-identity-provider-on-amazon-elastic-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_associate-keycloak-as-oidc-identity-provider-on-amazon-elastic-kubernetes-service.adoc rename to modules/install/partials/proc_associate-keycloak-as-oidc-identity-provider-on-amazon-elastic-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_configuring-dns-on-amazon-elastic-kubernetes-service.adoc b/modules/install/partials/proc_configuring-dns-on-amazon-elastic-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_configuring-dns-on-amazon-elastic-kubernetes-service.adoc rename to modules/install/partials/proc_configuring-dns-on-amazon-elastic-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_configuring-dns-on-microsoft-azure.adoc b/modules/install/partials/proc_configuring-dns-on-microsoft-azure.adoc similarity index 100% rename from modules/administration-guide/partials/proc_configuring-dns-on-microsoft-azure.adoc rename to modules/install/partials/proc_configuring-dns-on-microsoft-azure.adoc diff --git a/modules/administration-guide/partials/proc_creating-lets-encrypt-certificate-for-che-on-amazon-elastic-kubernetes-service.adoc b/modules/install/partials/proc_creating-lets-encrypt-certificate-for-che-on-amazon-elastic-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_creating-lets-encrypt-certificate-for-che-on-amazon-elastic-kubernetes-service.adoc rename to modules/install/partials/proc_creating-lets-encrypt-certificate-for-che-on-amazon-elastic-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc b/modules/install/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc similarity index 100% rename from modules/administration-guide/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc rename to modules/install/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc diff --git a/modules/administration-guide/partials/proc_installing-cert-manager-on-amazon-elastic-kubernetes-service.adoc b/modules/install/partials/proc_installing-cert-manager-on-amazon-elastic-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_installing-cert-manager-on-amazon-elastic-kubernetes-service.adoc rename to modules/install/partials/proc_installing-cert-manager-on-amazon-elastic-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_installing-cert-manager-on-microsoft-azure-kubernetes-service.adoc b/modules/install/partials/proc_installing-cert-manager-on-microsoft-azure-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_installing-cert-manager-on-microsoft-azure-kubernetes-service.adoc rename to modules/install/partials/proc_installing-cert-manager-on-microsoft-azure-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_installing-che-on-amazon-elastic-kubernetes-service.adoc b/modules/install/partials/proc_installing-che-on-amazon-elastic-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_installing-che-on-amazon-elastic-kubernetes-service.adoc rename to modules/install/partials/proc_installing-che-on-amazon-elastic-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_installing-che-on-microsoft-azure-kubernetes-service.adoc b/modules/install/partials/proc_installing-che-on-microsoft-azure-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_installing-che-on-microsoft-azure-kubernetes-service.adoc rename to modules/install/partials/proc_installing-che-on-microsoft-azure-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_installing-ingress-nginx-controller-on-amazon-elastic-kubernetes-service.adoc b/modules/install/partials/proc_installing-ingress-nginx-controller-on-amazon-elastic-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_installing-ingress-nginx-controller-on-amazon-elastic-kubernetes-service.adoc rename to modules/install/partials/proc_installing-ingress-nginx-controller-on-amazon-elastic-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_installing-keycloak-on-amazon-elastic-kubernetes-service.adoc b/modules/install/partials/proc_installing-keycloak-on-amazon-elastic-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_installing-keycloak-on-amazon-elastic-kubernetes-service.adoc rename to modules/install/partials/proc_installing-keycloak-on-amazon-elastic-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_installing-nginx-ingress-controller-on-microsoft-azure-kubernetes-service.adoc b/modules/install/partials/proc_installing-nginx-ingress-controller-on-microsoft-azure-kubernetes-service.adoc similarity index 100% rename from modules/administration-guide/partials/proc_installing-nginx-ingress-controller-on-microsoft-azure-kubernetes-service.adoc rename to modules/install/partials/proc_installing-nginx-ingress-controller-on-microsoft-azure-kubernetes-service.adoc diff --git a/modules/administration-guide/partials/proc_preparing-microsoft-azure-for-installing-che.adoc b/modules/install/partials/proc_preparing-microsoft-azure-for-installing-che.adoc similarity index 100% rename from modules/administration-guide/partials/proc_preparing-microsoft-azure-for-installing-che.adoc rename to modules/install/partials/proc_preparing-microsoft-azure-for-installing-che.adoc diff --git a/modules/administration-guide/partials/proc_registering-application-on-microsoft-azure.adoc b/modules/install/partials/proc_registering-application-on-microsoft-azure.adoc similarity index 100% rename from modules/administration-guide/partials/proc_registering-application-on-microsoft-azure.adoc rename to modules/install/partials/proc_registering-application-on-microsoft-azure.adoc diff --git a/modules/administration-guide/partials/snip_preparing-images-for-a-restricted-environment.adoc b/modules/install/partials/snip_preparing-images-for-a-restricted-environment.adoc similarity index 90% rename from modules/administration-guide/partials/snip_preparing-images-for-a-restricted-environment.adoc rename to modules/install/partials/snip_preparing-images-for-a-restricted-environment.adoc index c9fe34af04..f1a193927b 100644 --- a/modules/administration-guide/partials/snip_preparing-images-for-a-restricted-environment.adoc +++ b/modules/install/partials/snip_preparing-images-for-a-restricted-environment.adoc @@ -28,11 +28,11 @@ * 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:administration-guide:installing-the-chectl-management-tool.adoc[]. .Procedure -. Download and execute the mirroring script to install a custom Operator catalog and mirror the related images: xref:attachment$restricted-environment/prepare-restricted-environment.sh[prepare-restricted-environment.sh]. +. Download and execute the mirroring script to install a custom Operator catalog and mirror the related images: xref:administration-guide:attachment$restricted-environment/prepare-restricted-environment.sh[prepare-restricted-environment.sh]. + [subs="+attributes,+quotes"] ---- diff --git a/modules/overview/pages/introduction-to-eclipse-che.adoc b/modules/overview/pages/introduction-to-eclipse-che.adoc index 1319cda5a0..c754c91aed 100644 --- a/modules/overview/pages/introduction-to-eclipse-che.adoc +++ b/modules/overview/pages/introduction-to-eclipse-che.adoc @@ -23,7 +23,7 @@ * xref:what-is-{prod-id-short}[] * xref:architecture-overview.adoc[] * xref:hosted-che:hosted-che.adoc[] -* xref:administration-guide:installing-che.adoc[] +* xref:install:installing-che.adoc[] * xref:administration-guide:supported-platforms.adoc[] * xref:administration-guide:calculating-che-resource-requirements.adoc[] From b997aba93276defbbb8eb4f0de35f85ca240f28e Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Mon, 18 May 2026 19:59:55 +0530 Subject: [PATCH 2/2] chore: merge Plan content into Install module, retire Plan Move calculating-che-resource-requirements, running-at-scale, and installing-the-chectl-management-tool from administration-guide into the install module. This merges what was planned as a separate Plan module (PR #3099) directly into Install, matching the downstream decision to retire the Plan guide. - Move 3 pages, 4 examples, 1 image to modules/install/ - Add running-at-scale to install/nav.adoc Requirements section - Update admin-guide nav to remove moved entries - Convert cross-module xrefs: admin-guide refs to install become local - Add plan: page-aliases for backward-compatible redirects Co-authored-by: Cursor --- ...-upgrading-the-chectl-management-tool.adoc | 2 +- modules/administration-guide/nav.adoc | 3 - ...installing-the-chectl-management-tool.adoc | 22 -- .../pages/running-at-scale.adoc | 231 ------------------ ...ing-che-using-the-cli-management-tool.adoc | 2 +- .../partials/proc_configuring-routes.adoc | 2 +- ...ctl-management-tool-on-linux-or-macos.adoc | 0 ...the-chectl-management-tool-on-windows.adoc | 0 .../snip_che-example-devfile-disclaimer.adoc | 0 ...-running-at-scale-calculate-resources.adoc | 0 .../snip_che-multi-cluster.png | Bin modules/install/nav.adoc | 5 +- ...calculating-che-resource-requirements.adoc | 60 ++--- ...-on-amazon-elastic-kubernetes-service.adoc | 2 +- ...installing-the-chectl-management-tool.adoc | 22 ++ ...talling-che-on-minikube-keycloak-oidc.adoc | 2 +- .../proc_installing-che-on-minikube.adoc | 2 +- ...installing-che-on-openshift-using-cli.adoc | 2 +- ...alling-che-on-red-hat-openshift-local.adoc | 2 +- ...che-on-the-virtual-kubernetes-cluster.adoc | 2 +- .../install/pages/proc_uninstalling-che.adoc | 4 +- modules/install/pages/running-at-scale.adoc | 205 ++++++++++++++++ ...r-custom-resource-during-installation.adoc | 2 +- ...g-images-for-a-restricted-environment.adoc | 2 +- .../pages/introduction-to-eclipse-che.adoc | 2 +- 25 files changed, 271 insertions(+), 305 deletions(-) delete mode 100644 modules/administration-guide/pages/installing-the-chectl-management-tool.adoc delete mode 100644 modules/administration-guide/pages/running-at-scale.adoc rename modules/{administration-guide => install}/examples/proc_che-installing-the-chectl-management-tool-on-linux-or-macos.adoc (100%) rename modules/{administration-guide => install}/examples/proc_che-installing-the-chectl-management-tool-on-windows.adoc (100%) rename modules/{administration-guide => install}/examples/snip_che-example-devfile-disclaimer.adoc (100%) rename modules/{administration-guide => install}/examples/snip_che-running-at-scale-calculate-resources.adoc (100%) rename modules/{administration-guide => install}/images/running-at-scale/snip_che-multi-cluster.png (100%) rename modules/{administration-guide => install}/pages/calculating-che-resource-requirements.adoc (65%) create mode 100644 modules/install/pages/installing-the-chectl-management-tool.adoc create mode 100644 modules/install/pages/running-at-scale.adoc diff --git a/modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc b/modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc index e171617f41..68b0e5992b 100644 --- a/modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc +++ b/modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc @@ -4,7 +4,7 @@ This section describes how to upgrade the `{prod-cli}` management tool. .Prerequisites -* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[]. +* `{prod-cli}`. See: xref:install:installing-the-chectl-management-tool.adoc[]. .Procedure diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 27c2c6d02b..653d74fa6b 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -2,7 +2,6 @@ * xref:security-best-practices.adoc[] * xref:supported-platforms.adoc[] -** xref:installing-the-chectl-management-tool.adoc[] ** xref:architecture-overview.adoc[] *** xref:server-components.adoc[] **** xref:che-operator.adoc[] @@ -13,8 +12,6 @@ **** xref:che-devfile-registry.adoc[] **** xref:plugin-registry.adoc[] *** xref:user-workspaces.adoc[] -** xref:calculating-che-resource-requirements.adoc[] -* xref:running-at-scale.adoc[] * xref:configuring-che.adoc[] ** xref:understanding-the-checluster-custom-resource.adoc[] *** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] diff --git a/modules/administration-guide/pages/installing-the-chectl-management-tool.adoc b/modules/administration-guide/pages/installing-the-chectl-management-tool.adoc deleted file mode 100644 index 99576a06fa..0000000000 --- a/modules/administration-guide/pages/installing-the-chectl-management-tool.adoc +++ /dev/null @@ -1,22 +0,0 @@ -:_content-type: ASSEMBLY -:description: Installing the {prod-cli} management tool -:keywords: overview, using-the-chectl-management-tool -:navtitle: Installing the {prod-cli} management tool -:page-aliases: installation-guide:using-the-chectl-management-tool.adoc, overview:using-the-chectl-management-tool.adoc, using-the-chectl-management-tool.adoc - - -[id="installing-the-{prod-cli}-management-tool"] -= Installing the {prod-cli} management tool - - -You can install `{prod-cli}`, the {prod} command-line management tool, on Microsoft Windows, Apple MacOS, and Linux. With `{prod-cli}`, you can perform operations the {prod-short} server such as starting, stopping, updating, and deleting the server. - -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] - - -.Additional resources - -* {link-prod-cli-documentation} - diff --git a/modules/administration-guide/pages/running-at-scale.adoc b/modules/administration-guide/pages/running-at-scale.adoc deleted file mode 100644 index fc62192cb0..0000000000 --- a/modules/administration-guide/pages/running-at-scale.adoc +++ /dev/null @@ -1,231 +0,0 @@ -:_content-type: CONCEPT -:description: Running {prod} at scale -:keywords: scale, infrastructure, workload, scalability, CDE, cloud -:navtitle: Running {prod} at scale -//:page-aliases: - -[id="running-at-scale"] -= Running {prod} at scale - -Even though link:https://kubernetes.io/[Kubernetes] has emerged as a powerful foundation for deploying and managing containerized workloads at scale, achieving scale with Cloud Development Environments (CDEs), particularly in the range of thousands of concurrent workspaces, presents significant challenges. - -Such a scale imposes high infrastructure demands and introduces potential bottlenecks that can impact the performance and stability of the entire system. Addressing these challenges requires meticulous planning, strategic architectural choices, monitoring, and continuous optimization to ensure a seamless and efficient development experience for a large number of users. - -[NOTE] -==== -CDE workloads are complex to scale mainly because the underlying IDE solutions, -such as link:https://github.com/microsoft/vscode[Visual Studio Code - -Open Source ("Code - OSS")] or link:https://www.jetbrains.com/remote-development/gateway/[JetBrains Gateway], -are designed as single-user applications, not as multitenant services. -==== - -.Resource quantity and object maximums - -While there is no strict limit on the number of resources in a {kubernetes} cluster, -there are certain link:https://kubernetes.io/docs/setup/best-practices/cluster-large/[considerations for large clusters] to remember - -link:https://www.redhat.com/en/technologies/cloud-computing/openshift[OpenShift Container Platform], which is a certified distribution of {kubernetes}, also provides a set of tested maximums for various resources, which can serve as an initial guideline for planning your environment: - -[%header,format=csv] -|=== -Resource type, Tested maximum -Number of nodes,2000 -Number of pods,150000 -Number of pods per node,2500 -Number of namespace,10000 -Number of services,10000 -Number of secrets,80000 -Number of config maps,90000 -|=== - -Table 1: OpenShift Container Platform tested cluster maximums for various resources. - -[NOTE] -==== -You can find more details on the OpenShift Container Platform tested object maximums in the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/scalability_and_performance/planning-your-environment-according-to-object-maximums#planning-your-environment-according-to-object-maximums[official documentation]. -==== - -For example, it is generally not recommended to have more than 10,000 namespaces due to potential performance and management overhead. In {prod}, each user is allocated a namespace. If you expect the user base to be large, consider spreading workloads across multiple "fit-for-purpose" clusters and potentially leveraging solutions for multi-cluster orchestration. - -.Resource requirements - -When deploying {prod} on {kubernetes}, -it is crucial to accurately calculate the resource requirements -and determine memory and CPU / GPU needs for each CDE to come up with the right sizing of the cluster. -In general, the CDE size is limited by and cannot be bigger than the worker node size. -The resource requirements for CDEs can vary significantly based on the specific workloads and configurations. -For example, a simple CDE might require only a few hundred megabytes of memory, -while a more complex one will need several gigabytes of memory and multiple CPU cores. - -include::example$snip_{project-context}-running-at-scale-calculate-resources.adoc[] - -.Using etcd - -The primary datastore of {kubernetes} cluster configuration and state is link:https://etcd.io/[etcd]. It holds the cluster state and configuration, including information about nodes, pods, services, and custom resources. As a distributed key-value store, etcd does not scale well past a certain threshold, and as the size of etcd grows, so does the load on the cluster, risking its stability. - -[IMPORTANT] -==== -The default etcd size is 2 GB, and the recommended maximum is 8 GB. Exceeding the maximum limit can make the {kubernetes} cluster unstable and unresponsive. -==== - -.Object size as a factor - -Not only the overall number, but also the size of the objects stored in etcd is a critical factor that can significantly impact its performance and stability. Each object stored in etcd consumes space, and as the number of objects increases, the overall size of etcd grows too. The larger the object is, the more space it takes in etcd. For example, etcd can be overloaded with just a few thousand of relatively big {kubernetes} objects. - -[IMPORTANT] -==== -Even though the data stored in a `ConfigMap` cannot exceed 1 MiB by design, a few thousand of relatively big `ConfigMap` objects can overload etcd storage. -==== - -In the context of {prod}, by default the Operator creates and manages the 'ca-certs-merged' ConfigMap, which contains the Certificate Authorities (CAs) bundle, in every user namespace. With a large number of TLS certificates in the cluster, this results in additional etcd usage. - -To disable mounting the CA bundle by using the `ConfigMap` under the `/etc/pki/ca-trust/extracted/pem` path, -configure the `CheCluster` Custom Resource by setting the `disableWorkspaceCaBundleMount` property to `true`. -With this configuration, only custom certificates will be mounted under the path `/public-certs`: - -[source,yaml] ----- -spec: - devEnvironments: - trustedCerts: - disableWorkspaceCaBundleMount: true ----- - -.{devworkspace} objects - -For large {kubernetes} deployments, particularly those involving a high number of custom resources such as `DevWorkspace` objects, which represent CDEs, etcd can become a significant performance bottleneck. - -[IMPORTANT] -==== -Based on the load testing for 6,000 `DevWorkspace` objects, storage consumption for etcd was approximately 2.5GB. -==== - -Starting from {devworkspace} Operator version 0.34.0, -you can configure a pruner -that automatically cleans up `DevWorkspace` objects that were not in use for a certain period of time. -To set the pruner up, configure the `DevWorkspaceOperatorConfig` object as follows: - -[source,yaml] ----- -apiVersion: controller.devfile.io/v1alpha1 -kind: DevWorkspaceOperatorConfig -metadata: - name: devworkspace-operator-config - namespace: crw -config: - workspace: - cleanupCronJob: - enabled: true - dryRun: false - retainTime: 2592000 <1> - schedule: “0 0 1 * *” <2> ----- -<1> By default, if a workspace was not started for more than 30 days it will be marked for deletion. -<2> By default, the pruner will run once per month. - -.OLMConfig - -When an Operator is installed by the link:https://olm.operatorframework.io/[Operator Lifecycle Manager (OLM)], -a stripped-down copy of its CSV is created in every {namespace} the Operator is configured to watch. -These stripped-down CSVs are known as “Copied CSVs” -and communicate to users which controllers are actively reconciling resource events in a given namespace. -On especially large clusters, with namespaces and installed operators tending in the hundreds or thousands, -Copied CSVs consume an unsustainable amount of resources; for example, OLM memory usage, cluster etcd limits, -networking, etc. To eliminate the CSVs copied to every namespace, configure the `OLMConfig` object accordingly: - -[source,yaml] ----- -apiVersion: operators.coreos.com/v1 -kind: OLMConfig -metadata: - name: cluster -spec: - features: - disableCopiedCSVs: true ----- - -[NOTE] -==== -Additional information about the `disableCopiedCSVs` feature is available in its original link:https://github.com/operator-framework/enhancements/blob/master/enhancements/olm-toggle-copied-csvs.md[enhancement proposal]. -==== - -The primary impact of the `disableCopiedCSVs` property on etcd is related to resource consumption. In clusters with a large number of namespaces and many cluster-wide Operators, the creation and maintenance of numerous Copied CSVs can lead to increased etcd storage usage and memory consumption. By disabling Copied CSVs, the amount of data stored in etcd is significantly reduced, which can help improve overall cluster performance and stability. - -This is particularly important for large clusters where the number of namespaces and operators can quickly add up to a significant amount of data. Disabling Copied CSVs can help reduce the load on etcd, leading to improved performance and responsiveness of the cluster. -Additionally, it can help reduce the memory footprint of OLM, as it no longer needs to maintain and manage these additional resources. - -[NOTE] -==== -You can find more details about "Disabling Copied CSVs" in the link:https://olm.operatorframework.io/docs/advanced-tasks/configuring-olm/#disabling-copied-csvs[official documentation]. -==== - -.Cluster Autoscaling - -Although cluster autoscaling is a powerful {kubernetes} feature, you cannot always fall back on it. You should always consider predictive scaling by analyzing load data on your environment to detect daily or weekly usage patterns. If your workloads follow a pattern and there are dramatic peaks throughout the day, you should consider provisioning worker nodes accordingly. For example, if you have a predictable load pattern where the number of workspaces increases during business hours and decreases during off-hours, you can use predictive scaling to adjust the number of worker nodes based on the expected load. -This can help ensure that you have enough resources available to handle the peak load while minimizing costs during off-peak hours. - -[NOTE] -==== -Consider leveraging open-source solutions such as link:https://karpenter.sh/[Karpenter] for configuration and lifecycle management of the worker nodes. Karpenter can dynamically provision and optimize worker nodes based on the specific requirements of the workloads, helping to improve resource utilization and reduce costs. -==== - -.Multi-cluster - -By design, {prod} is not multi-cluster aware, and you can only have one instance per cluster. -However, -you can run {prod} in a multi-cluster environment by deploying {prod} in each different cluster -and using a load balancer or DNS-based routing to direct traffic to the appropriate instance based on the user’s location or other criteria. -This approach can help -improve performance and reliability by distributing the workload across multiple clusters -and providing redundancy in case of cluster failures. - -.Developer Sandbox example - -You can test running {prod-short} in a multi-cluster environment by using the link:https://developers.redhat.com/developer-sandbox[Developer Sandbox], -a free trial environment by Red Hat with pre-configured tools and services. -From an infrastructure perspective, -the Developer Sandbox consists of multiple link:https://www.redhat.com/en/technologies/cloud-computing/openshift/aws[ROSA] clusters. -On each cluster, -the productized version of {prod} is installed -and configured using link:https://argo-cd.readthedocs.io/en/stable/[Argo CD]. -Since the user base is spread across multiple clusters, -link:https://workspaces.openshift.com/[workspaces.openshift.com] is used as a single entry point to the productized {prod} instances. - -image::running-at-scale/snip_{project-context}-multi-cluster.png[Scheme of a multi-cluster environment] - -You can find implementation details about the multicluster redirector in the following link:https://github.com/codeready-toolchain/crw-multicluster-redirector[GitHub repository]. - -[IMPORTANT] -==== -The multi-cluster architecture of link:https://workspaces.openshift.com/[workspaces.openshift.com] is part of the link:https://developers.redhat.com/developer-sandbox[Developer Sandbox]. -It is a Developer Sandbox-specific solution that cannot be reused as-is in other environments. However, you can use it as a reference for implementing a similar solution well-tailored to your specific multicluster needs. -==== - -.The multicluster redirector solution for Red Hat OpenShift - -Red Hat offers an open-source, Quarkus-based service that acts as a single gateway for developers. This service automatically redirects users to the correct {prod} instance on the appropriate cluster based on their Red Hat OpenShift group membership. The community-supported version is available in the link:https://github.com/redhat-developer/devspaces-multicluster-redirector[GitHub repository]. - -.Architecture and requirements - -A critical requirement for the multicluster redirector is that all users must be provisioned to the host cluster where the redirector is deployed. Users authenticate through the OAuth flow of this cluster, even if they never run workloads there. The host cluster's Red Hat OpenShift groups determine the routing logic. See the link:https://github.com/redhat-developer/devspaces-multicluster-redirector?tab=readme-ov-file#-deploying-to-openshift[Deploying to Red Hat OpenShift] section for deployment instructions. - -.Configuration - -The routing configuration uses a `ConfigMap` that contains JSON to map Red Hat OpenShift groups to {prod} URLs. The redirector uses this file to update routing tables in real-time without requiring restarts. - -.Operational flow - -The routing process follows these steps: - -. Authenticate via OAuth by using a proxy sidecar. -. Pass identity and group information through HTTP headers. -. Verify group memberships by using Red Hat OpenShift API queries. -. Determine the appropriate {prod} URL by using a mapping lookup. -. Redirect the user to the designated cluster instance. - -If users belong to multiple Red Hat OpenShift groups, they can choose their desired {prod} instance from a selection dashboard. - -.Additional resources - -* link:https://che.eclipseprojects.io/2025/04/29/@ilya.buziuk-running-at-scale.html[Running at scale] -* link:https://developers.redhat.com/articles/2026/01/23/enterprise-multi-cluster-scalability-openshift-dev-spaces[Enterprise multi-cluster scalability] diff --git a/modules/administration-guide/pages/upgrading-che-using-the-cli-management-tool.adoc b/modules/administration-guide/pages/upgrading-che-using-the-cli-management-tool.adoc index 2a76ac8e76..f5216a164d 100644 --- a/modules/administration-guide/pages/upgrading-che-using-the-cli-management-tool.adoc +++ b/modules/administration-guide/pages/upgrading-che-using-the-cli-management-tool.adoc @@ -15,7 +15,7 @@ This section describes how to upgrade from the previous minor version using the * 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:installing-the-chectl-management-tool.adoc[]. +* `{prod-cli}` for {prod-short} version {prod-ver}. See: xref:install:installing-the-chectl-management-tool.adoc[]. .Procedure diff --git a/modules/administration-guide/partials/proc_configuring-routes.adoc b/modules/administration-guide/partials/proc_configuring-routes.adoc index 9d8f516873..8e74a48c60 100644 --- a/modules/administration-guide/partials/proc_configuring-routes.adoc +++ b/modules/administration-guide/partials/proc_configuring-routes.adoc @@ -8,7 +8,7 @@ You can configure labels, annotations, and domains for OpenShift Route to work w * An active `oc` session with administrative permissions to the OpenShift cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI]. -* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[]. +* `{prod-cli}`. See: xref:install:installing-the-chectl-management-tool.adoc[]. .Procedure diff --git a/modules/administration-guide/examples/proc_che-installing-the-chectl-management-tool-on-linux-or-macos.adoc b/modules/install/examples/proc_che-installing-the-chectl-management-tool-on-linux-or-macos.adoc similarity index 100% rename from modules/administration-guide/examples/proc_che-installing-the-chectl-management-tool-on-linux-or-macos.adoc rename to modules/install/examples/proc_che-installing-the-chectl-management-tool-on-linux-or-macos.adoc diff --git a/modules/administration-guide/examples/proc_che-installing-the-chectl-management-tool-on-windows.adoc b/modules/install/examples/proc_che-installing-the-chectl-management-tool-on-windows.adoc similarity index 100% rename from modules/administration-guide/examples/proc_che-installing-the-chectl-management-tool-on-windows.adoc rename to modules/install/examples/proc_che-installing-the-chectl-management-tool-on-windows.adoc diff --git a/modules/administration-guide/examples/snip_che-example-devfile-disclaimer.adoc b/modules/install/examples/snip_che-example-devfile-disclaimer.adoc similarity index 100% rename from modules/administration-guide/examples/snip_che-example-devfile-disclaimer.adoc rename to modules/install/examples/snip_che-example-devfile-disclaimer.adoc diff --git a/modules/administration-guide/examples/snip_che-running-at-scale-calculate-resources.adoc b/modules/install/examples/snip_che-running-at-scale-calculate-resources.adoc similarity index 100% rename from modules/administration-guide/examples/snip_che-running-at-scale-calculate-resources.adoc rename to modules/install/examples/snip_che-running-at-scale-calculate-resources.adoc diff --git a/modules/administration-guide/images/running-at-scale/snip_che-multi-cluster.png b/modules/install/images/running-at-scale/snip_che-multi-cluster.png similarity index 100% rename from modules/administration-guide/images/running-at-scale/snip_che-multi-cluster.png rename to modules/install/images/running-at-scale/snip_che-multi-cluster.png diff --git a/modules/install/nav.adoc b/modules/install/nav.adoc index 303d5111d2..f208e6a9c1 100644 --- a/modules/install/nav.adoc +++ b/modules/install/nav.adoc @@ -3,8 +3,9 @@ // Requirements * Requirements ** xref:administration-guide:supported-platforms.adoc[] -** xref:administration-guide:calculating-che-resource-requirements.adoc[] -** xref:administration-guide:installing-the-chectl-management-tool.adoc[] +** xref:calculating-che-resource-requirements.adoc[] +** xref:running-at-scale.adoc[] +** xref:installing-the-chectl-management-tool.adoc[] // Installing * xref:installing-che.adoc[] ** Deploy on OpenShift diff --git a/modules/administration-guide/pages/calculating-che-resource-requirements.adoc b/modules/install/pages/calculating-che-resource-requirements.adoc similarity index 65% rename from modules/administration-guide/pages/calculating-che-resource-requirements.adoc rename to modules/install/pages/calculating-che-resource-requirements.adoc index 9c1b4e3b7d..db1c56602c 100644 --- a/modules/administration-guide/pages/calculating-che-resource-requirements.adoc +++ b/modules/install/pages/calculating-che-resource-requirements.adoc @@ -1,12 +1,15 @@ :_content-type: PROCEDURE -:description: Calculating {prod-short} resource requirements -:keywords: administration-guide, calculating-che-resource-requirements -:navtitle: Calculating {prod-short} resource requirements -:page-aliases: .:calculating-che-resource-requirements.adoc +:description: Calculate the CPU and memory requirements for the {prod-short} Operator, {devworkspace} Controller, and user workspaces. Accurate resource estimates ensure your cluster can handle the expected number of concurrent users without performance issues. +:keywords: install, calculating-che-resource-requirements +:navtitle: Calculate {prod-short} resource requirements +:page-aliases: administration-guide:calculating-che-resource-requirements.adoc, plan:calculating-che-resource-requirements.adoc [id="calculating-{prod-id-short}-resource-requirements"] -= Calculating {prod-short} resource requirements += Calculate {prod-short} resource requirements + +[role="_abstract"] +Calculate the CPU and memory requirements for the {prod-short} Operator, {devworkspace} Controller, and user workspaces. Accurate resource estimates ensure your cluster can handle the expected number of concurrent users without performance issues. 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. @@ -15,26 +18,21 @@ include::example$snip_{project-context}-example-devfile-disclaimer.adoc[] .Procedure -. Identify the workspace resource requirements which depend on the devfile that is used for defining the development environment. This includes identifying the workspace components explicitly specified in the `components` section of the devfile. +. Identify the workspace resource requirements from the devfile `components` section. The following example uses the link:https://github.com/che-incubator/quarkus-api-example/blob/main/devfile.yaml[Quarkus API example devfile]. -** Here is an link:https://github.com/che-incubator/quarkus-api-example/blob/main/devfile.yaml[example devfile] with the following components: +** The `tools` component of the devfile defines the following requests and limits: + -.`tools` -==== -The `tools` component of the devfile defines the following requests and limits: - -[source,yaml,subs="+attributes,+quotes,macros"] +[source,yaml] ---- memoryLimit: 6G memoryRequest: 512M cpuRequest: 1000m cpuLimit: 4000m ---- -==== -** During the workspace startup, an internal `che-gateway` container is implicitly provisioned with the following requests and limits: +** During workspace startup, an internal `che-gateway` container is implicitly provisioned with the following requests and limits: + -[source,yaml,subs="+attributes,+quotes,macros"] +[source,yaml] ---- memoryLimit: 256M memoryRequest: 64M @@ -42,9 +40,9 @@ The `tools` component of the devfile defines the following requests and limits: cpuLimit: 500m ---- -** IMPORTANT: Additional memory and CPU will be added implicitly for the Visual Studio Code - Open Source ("Code - OSS"): +** Additional memory and CPU are added implicitly for the Visual Studio Code - Open Source ("Code - OSS") editor: + -[source,yaml,subs="+attributes,+quotes,macros"] +[source,yaml] ---- memoryLimit: 1024M memoryRequest: 256M @@ -52,9 +50,9 @@ The `tools` component of the devfile defines the following requests and limits: cpuLimit: 500m ---- -** IMPORTANT: Additional memory and CPU will be added implicitly for a JetBrains IDE (for example IntelliJ IDEA Ultimate): +** Additional memory and CPU are added implicitly for a JetBrains IDE, for example IntelliJ IDEA Ultimate: + -[source,yaml,subs="+attributes,+quotes,macros"] +[source,yaml] ---- memoryLimit: 6144M memoryRequest: 2048M @@ -65,7 +63,6 @@ The `tools` component of the devfile defines the following requests and limits: . Calculate the sums of the resources required for each workspace. If you intend to use multiple devfiles, repeat this calculation for every expected devfile. + .Workspace requirements for the link:https://github.com/che-incubator/quarkus-api-example/blob/main/devfile.yaml[example devfile] in the previous step -==== [cols="1a,1a,1a,1a,1a,1a,1a",options="header"] |=== |Purpose @@ -106,7 +103,6 @@ The `tools` component of the devfile defines the following requests and limits: >s|5000 m >s|1080 m |=== -==== . Multiply the resources calculated per workspace by the number of workspaces that you expect all of your users to run simultaneously. @@ -203,14 +199,6 @@ The `tools` component of the devfile defines the following requests and limits: |N/A |N/A -|{devworkspace} webhook server -|`{devworkspace-id}-webhook-server` -|`webhook-server` -|300 MiB -|20 MiB -|200 m -|100 m - |{devworkspace} Operator Catalog |`{devworkspace-id}-operator-catalog` |`registry-server` @@ -236,13 +224,19 @@ The `tools` component of the devfile defines the following requests and limits: |N/A 3+>s|Total ->s|13 GiB ->s|1.2 GiB ->s|8.4 ->s|1.2 +>s|12.3 GiB +>s|1.1 GiB +>s|8.2 +>s|1.1 |=== +. Add the workspace resources from step 3 and the operator resources from step 4 to determine total cluster resource requirements. + +.Verification + +* Verify that the total resource requirements account for all {prod-short} Operator components, {devworkspace} Controller components, and the expected number of concurrent workspaces. + .Additional resources * link:https://devfile.io/docs/2.2.0/what-is-a-devfile[What is a devfile] diff --git a/modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc b/modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc index 50e6f93a9a..e179cdc752 100644 --- a/modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc +++ b/modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc @@ -13,7 +13,7 @@ To provide cloud development environments on AWS, deploy {prod-short} on an Amaz * You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm]. -* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. * You have the `aws` CLI installed. See link:https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html[AWS CLI install and update instructions]. diff --git a/modules/install/pages/installing-the-chectl-management-tool.adoc b/modules/install/pages/installing-the-chectl-management-tool.adoc new file mode 100644 index 0000000000..72c6f57b7c --- /dev/null +++ b/modules/install/pages/installing-the-chectl-management-tool.adoc @@ -0,0 +1,22 @@ +:_content-type: ASSEMBLY +:description: Install {prod-cli}, the {prod} CLI management tool, on Linux, macOS, or Windows. The {prod-cli} tool lets you deploy, update, and manage {prod-short} from the command line. +:keywords: install, installing-the-chectl-management-tool +:navtitle: Install the {prod-cli} management tool +:page-aliases: administration-guide:installing-the-chectl-management-tool.adoc, plan:installing-the-chectl-management-tool.adoc, installation-guide:using-the-chectl-management-tool.adoc, overview:using-the-chectl-management-tool.adoc, using-the-chectl-management-tool.adoc + + +[id="installing-the-{prod-cli}-management-tool"] += Install the {prod-cli} management tool + +[role="_abstract"] +Install `{prod-cli}`, the {prod} CLI management tool, on Linux, macOS, or Windows. The `{prod-cli}` tool lets you deploy, update, and manage {prod-short} from the command line. + +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] + + +.Additional resources + +* {link-prod-cli-documentation} + diff --git a/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc b/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc index bb66a3b01a..2d1af3b578 100644 --- a/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc @@ -23,7 +23,7 @@ Single-node {kubernetes} clusters are suited only for testing or development. Do * You have `{orch-cli}` installed. See link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing `{orch-cli}`]. -* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. .Procedure diff --git a/modules/install/pages/proc_installing-che-on-minikube.adoc b/modules/install/pages/proc_installing-che-on-minikube.adoc index d439dcc6f3..13cd49848d 100644 --- a/modules/install/pages/proc_installing-che-on-minikube.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube.adoc @@ -21,7 +21,7 @@ Single-node {kubernetes} clusters are suited only for testing or development. Do * You have `{orch-cli}` installed. See link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing `{orch-cli}`]. -* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. .Procedure diff --git a/modules/install/pages/proc_installing-che-on-openshift-using-cli.adoc b/modules/install/pages/proc_installing-che-on-openshift-using-cli.adoc index 18d4b4937f..9c5ac3884b 100644 --- a/modules/install/pages/proc_installing-che-on-openshift-using-cli.adoc +++ b/modules/install/pages/proc_installing-che-on-openshift-using-cli.adoc @@ -16,7 +16,7 @@ Install the {prod-short} Operator and create a `CheCluster` instance from the co * You have an active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI]. -* You have the `{prod-cli}` management tool installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. +* You have the `{prod-cli}` management tool installed. See xref:installing-the-chectl-management-tool.adoc[]. .Procedure diff --git a/modules/install/pages/proc_installing-che-on-red-hat-openshift-local.adoc b/modules/install/pages/proc_installing-che-on-red-hat-openshift-local.adoc index 557726d6c1..669900ab42 100644 --- a/modules/install/pages/proc_installing-che-on-red-hat-openshift-local.adoc +++ b/modules/install/pages/proc_installing-che-on-red-hat-openshift-local.adoc @@ -12,7 +12,7 @@ To evaluate {prod-short} on a local {orch-name} cluster, deploy {prod-short} by .Prerequisites -* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. * You have a running instance of {rh-os-local}. See link:https://developers.redhat.com/products/openshift-local/overview[{rh-os-local} overview]. diff --git a/modules/install/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc b/modules/install/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc index 752336577d..0e35b96b55 100644 --- a/modules/install/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc +++ b/modules/install/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc @@ -20,7 +20,7 @@ To deploy {prod-short} when the host cluster version is incompatible or lacks ex * You have `kubelogin` installed. See link:https://github.com/int128/kubelogin[Installing kubelogin]. -* You have `{prod-cli}` installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. +* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. * You have an active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. diff --git a/modules/install/pages/proc_uninstalling-che.adoc b/modules/install/pages/proc_uninstalling-che.adoc index c401e9f288..076f1ce7ca 100644 --- a/modules/install/pages/proc_uninstalling-che.adoc +++ b/modules/install/pages/proc_uninstalling-che.adoc @@ -17,7 +17,7 @@ Uninstalling {prod-short} removes all {prod-short}-related user data. .Prerequisites -* You have the `{prod-cli}` management tool installed. See xref:administration-guide:installing-the-chectl-management-tool.adoc[]. +* You have the `{prod-cli}` management tool installed. See xref:installing-the-chectl-management-tool.adoc[]. .Procedure @@ -54,4 +54,4 @@ The expected output is `NotFound`. [role="_additional-resources"] .Additional resources -* xref:administration-guide:installing-the-chectl-management-tool.adoc[] +* xref:installing-the-chectl-management-tool.adoc[] diff --git a/modules/install/pages/running-at-scale.adoc b/modules/install/pages/running-at-scale.adoc new file mode 100644 index 0000000000..155b008995 --- /dev/null +++ b/modules/install/pages/running-at-scale.adoc @@ -0,0 +1,205 @@ +:_content-type: CONCEPT +:description: Scaling cloud development environments (CDEs) to thousands of concurrent workspaces imposes high infrastructure demands on etcd storage, Operator memory, and worker node capacity. This topic covers the bottlenecks, tested maximums, and architectural patterns — including multi-cluster deployments — that address these challenges. +:keywords: install, scale, infrastructure, workload, scalability, CDE, cloud +:navtitle: {prod-short} scalability +:page-aliases: administration-guide:running-at-scale.adoc, plan:running-at-scale.adoc + +[id="running-at-scale"] += {prod-short} scalability + +[role="_abstract"] +Scaling cloud development environments (CDEs) to thousands of concurrent workspaces imposes high infrastructure demands on etcd storage, Operator memory, and worker node capacity. This topic covers the bottlenecks, tested maximums, and architectural patterns — including multi-cluster deployments — that address these challenges. + +Such a scale imposes high infrastructure demands and introduces potential bottlenecks that can impact performance and stability. Addressing these challenges requires meticulous planning, strategic architectural choices, monitoring, and continuous optimization. + +CDE workloads are particularly complex to scale. The underlying IDE solutions, such as link:https://github.com/microsoft/vscode[Visual Studio Code - Open Source ("Code - OSS")] or link:https://www.jetbrains.com/remote-development/gateway/[JetBrains Gateway], are designed as single-user applications, not as multitenant services. + +== Resource quantity and object maximums + +While there is no strict limit on the number of resources in a {kubernetes} cluster, there are certain link:https://kubernetes.io/docs/setup/best-practices/cluster-large/[considerations for large clusters] to remember. + +link:https://www.redhat.com/en/technologies/cloud-computing/openshift[OpenShift Container Platform], a certified distribution of {kubernetes}, provides a set of tested maximums for various resources. These maximums can serve as an initial guideline for planning your environment: + +.OpenShift Container Platform tested cluster maximums +[%header,format=csv] +|=== +Resource type, Tested maximum +Number of nodes,2000 +Number of pods,150000 +Number of pods per node,2500 +Number of namespace,10000 +Number of services,10000 +Number of secrets,80000 +Number of config maps,90000 +|=== + +For more details on OpenShift Container Platform tested object maximums, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/scalability_and_performance/planning-your-environment-according-to-object-maximums#planning-your-environment-according-to-object-maximums[OpenShift Container Platform scalability and performance documentation]. + +For example, it is generally not recommended to have more than 10,000 namespaces due to potential performance and management overhead. In {prod}, each user is allocated a namespace. If you expect the user base to be large, consider spreading workloads across multiple "fit-for-purpose" clusters and potentially using solutions for multi-cluster orchestration. + +== Resource requirements + +When deploying {prod} on {kubernetes}, accurately calculate the resource requirements for each CDE, including memory and CPU or GPU needs. This determines the right sizing of the cluster. In general, the CDE size is limited by and cannot be bigger than the worker node size. + +The resource requirements for CDEs can vary significantly based on the specific workloads and configurations. A simple CDE might require only a few hundred megabytes of memory. A more complex one might need several gigabytes of memory and multiple CPU cores. + +include::example$snip_{project-context}-running-at-scale-calculate-resources.adoc[] + +== Using etcd + +The primary datastore of {kubernetes} cluster configuration and state is link:https://etcd.io/[etcd]. It holds information about nodes, pods, services, and custom resources. + +As a distributed key-value store, etcd does not scale well past a certain threshold. As the size of etcd grows, so does the load on the cluster, risking its stability. + +[IMPORTANT] +==== +The default etcd size is 2 GB, and the recommended maximum is 8 GB. Exceeding the maximum limit can make the {kubernetes} cluster unstable and unresponsive. Even though the data stored in a `ConfigMap` cannot exceed 1 MiB by design, a few thousand relatively large `ConfigMap` objects can overload etcd storage. +==== + +== Object size as a factor + +The size of the objects stored in etcd is also a critical factor. Each object consumes space, and as the number of objects increases, the overall size of etcd grows. The larger the object, the more space it takes. For example, etcd can be overloaded with only a few thousand large {kubernetes} objects. + +In the context of {prod}, by default the Operator creates and manages the 'ca-certs-merged' ConfigMap, which contains the Certificate Authorities (CAs) bundle, in every user namespace. With a large number of Transport Layer Security (TLS) certificates in the cluster, this results in additional etcd usage. + +To disable mounting the CA bundle by using the `ConfigMap` under the `/etc/pki/ca-trust/extracted/pem` path, configure the `CheCluster` Custom Resource by setting the `disableWorkspaceCaBundleMount` property to `true`. With this configuration, only custom certificates are mounted under the path `/public-certs`: + +[source,yaml] +---- +spec: + devEnvironments: + trustedCerts: + disableWorkspaceCaBundleMount: true +---- + +== {devworkspace} objects + +For large {kubernetes} deployments, particularly those involving a high number of custom resources such as `DevWorkspace` objects, which represent CDEs, etcd can become a significant performance bottleneck. + +[IMPORTANT] +==== +Based on the load testing for 6,000 `DevWorkspace` objects, storage consumption for etcd was approximately 2.5GB. +==== + +Starting from {devworkspace} Operator version 0.34.0, you can configure a pruner that automatically cleans up `DevWorkspace` objects that were not in use for a certain period of time. To set the pruner up, configure the `DevWorkspaceOperatorConfig` object as follows: + +[source,yaml] +---- +apiVersion: controller.devfile.io/v1alpha1 +kind: DevWorkspaceOperatorConfig +metadata: + name: devworkspace-operator-config + namespace: crw +config: + workspace: + cleanupCronJob: + enabled: true + dryRun: false + retainTime: 2592000 + schedule: “0 0 1 * *” +---- + +retainTime:: By default, if a workspace was not started for more than 30 days, it is marked for deletion. + +schedule:: By default, the pruner runs once per month. + +== OLMConfig + +When an Operator is installed by the link:https://olm.operatorframework.io/[Operator Lifecycle Manager (OLM)], a stripped-down copy of its CSV is created in every {namespace} the Operator watches. These “Copied CSVs” communicate which controllers are reconciling resource events in a given namespace. + +On large clusters with hundreds or thousands of namespaces, Copied CSVs consume an unsustainable amount of resources, including OLM memory, etcd storage, and network bandwidth. To eliminate the CSVs copied to every namespace, configure the `OLMConfig` object: + +[source,yaml] +---- +apiVersion: operators.coreos.com/v1 +kind: OLMConfig +metadata: + name: cluster +spec: + features: + disableCopiedCSVs: true +---- + +Additional information about the `disableCopiedCSVs` feature is available in its original link:https://github.com/operator-framework/enhancements/blob/master/enhancements/olm-toggle-copied-csvs.md[enhancement proposal]. + +In clusters with many namespaces and cluster-wide Operators, Copied CSVs increase etcd storage usage and memory consumption. Disabling Copied CSVs significantly reduces the data stored in etcd and improves cluster performance and stability. + +Disabling Copied CSVs also reduces the memory footprint of OLM, as it no longer maintains these additional resources. + +For more details about disabling Copied CSVs, see the link:https://olm.operatorframework.io/docs/advanced-tasks/configuring-olm/#disabling-copied-csvs[OLM documentation]. + +== Cluster Autoscaling + +Although cluster autoscaling is a powerful {kubernetes} feature, you cannot always rely on it. Consider predictive scaling by analyzing load data to detect daily or weekly usage patterns. + +If your workloads follow a pattern with dramatic peaks throughout the day, provision worker nodes accordingly. For example, if workspaces increase during business hours and decrease during off-hours, predictive scaling adjusts the number of worker nodes. This ensures enough resources are available during peak load while minimizing costs during off-peak hours. + +You can also use open-source solutions such as link:https://karpenter.sh/[Karpenter] for configuration and lifecycle management of the worker nodes. Karpenter can dynamically provision and optimize worker nodes based on the specific requirements of the workloads. This helps improve resource utilization and reduce costs. + +== Multi-cluster + +By design, {prod} is not multi-cluster aware. You can only have one instance per cluster. + +However, you can run {prod} in a multi-cluster environment by deploying {prod} in each cluster. Use a load balancer or Domain Name System (DNS)-based routing to direct traffic to the appropriate instance. This approach distributes the workload across clusters and provides redundancy in case of cluster failures. + +== Developer Sandbox example + +You can test running {prod-short} in a multi-cluster environment by using the link:https://developers.redhat.com/developer-sandbox[Developer Sandbox], a free trial environment by Red Hat. + +From an infrastructure perspective, the Developer Sandbox consists of multiple link:https://www.redhat.com/en/technologies/cloud-computing/openshift/aws[Red Hat OpenShift Service on AWS (ROSA)] clusters. On each cluster, the productized version of {prod} is installed and configured using link:https://argo-cd.readthedocs.io/en/stable/[Argo CD]. The link:https://workspaces.openshift.com/[workspaces.openshift.com] URL is used as a single entry point to the {prod} instances across clusters. + +image::running-at-scale/snip_{project-context}-multi-cluster.png[Scheme of a multi-cluster environment] + +You can find implementation details about the multicluster redirector in the link:https://github.com/codeready-toolchain/crw-multicluster-redirector[crw-multicluster-redirector GitHub repository]. + +[IMPORTANT] +==== +The multi-cluster architecture of link:https://workspaces.openshift.com/[workspaces.openshift.com] is part of the link:https://developers.redhat.com/developer-sandbox[Developer Sandbox]. It is a Developer Sandbox-specific solution that cannot be reused as-is in other environments. However, you can use it as a reference for implementing a similar solution well-tailored to your specific multicluster needs. +==== + +== The multicluster redirector solution for OpenShift Container Platform + +Red Hat offers an open-source, Quarkus-based service that acts as a single gateway for developers. This service automatically redirects users to the correct {prod} instance on the appropriate cluster based on their OpenShift Container Platform group membership. The community-supported version is available in the link:https://github.com/redhat-developer/devspaces-multicluster-redirector[devspaces-multicluster-redirector GitHub repository]. + +== Architecture and requirements + +A critical requirement for the multicluster redirector is that all users are provisioned to the host cluster where the redirector is deployed. Users authenticate through the OAuth flow of this cluster, even if they never run workloads there. The host cluster’s OpenShift Container Platform groups determine the routing logic. See the link:https://github.com/redhat-developer/devspaces-multicluster-redirector?tab=readme-ov-file#-deploying-to-openshift[devspaces-multicluster-redirector documentation] for deployment instructions. + +== Configuration + +The routing configuration uses a `ConfigMap` that contains JSON to map OpenShift Container Platform groups to {prod} URLs. The redirector uses this file to update routing tables in real-time without requiring restarts. + +== Operational flow + +The routing process follows these steps: + +. Authenticate by using OAuth through a proxy sidecar. +. Pass identity and group information through HTTP headers. +. Verify group memberships by using OpenShift Container Platform API queries. +. Determine the appropriate {prod} URL by using a mapping lookup. +. Redirect the user to the designated cluster instance. + +If users belong to multiple OpenShift Container Platform groups, they can choose their desired {prod} instance from a selection dashboard. + +.Additional resources + +* link:https://che.eclipseprojects.io/2025/04/29/@ilya.buziuk-running-at-scale.html[Running at scale] +* link:https://developers.redhat.com/articles/2026/01/23/enterprise-multi-cluster-scalability-openshift-dev-spaces[Enterprise multi-cluster scalability] +* link:https://kubernetes.io/[Kubernetes] +* link:https://github.com/microsoft/vscode[Visual Studio Code - Open Source ("Code - OSS")] +* link:https://www.jetbrains.com/remote-development/gateway/[JetBrains Gateway] +* link:https://kubernetes.io/docs/setup/best-practices/cluster-large/[Considerations for large clusters] +* link:https://www.redhat.com/en/technologies/cloud-computing/openshift[OpenShift Container Platform] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/scalability_and_performance/planning-your-environment-according-to-object-maximums#planning-your-environment-according-to-object-maximums[OpenShift Container Platform tested object maximums] +* xref:calculating-che-resource-requirements.adoc[] +* link:https://etcd.io/[etcd] +* link:https://olm.operatorframework.io/[Operator Lifecycle Manager (OLM)] +* link:https://github.com/operator-framework/enhancements/blob/master/enhancements/olm-toggle-copied-csvs.md[OLM toggle Copied CSVs enhancement proposal] +* link:https://olm.operatorframework.io/docs/advanced-tasks/configuring-olm/#disabling-copied-csvs[Disabling Copied CSVs in OLM] +* link:https://karpenter.sh/[Karpenter] +* link:https://developers.redhat.com/developer-sandbox[Developer Sandbox] +* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/aws[Red Hat OpenShift Service on AWS (ROSA)] +* link:https://argo-cd.readthedocs.io/en/stable/[Argo CD] +* link:https://workspaces.openshift.com/[workspaces.openshift.com] +* link:https://github.com/codeready-toolchain/crw-multicluster-redirector[crw-multicluster-redirector GitHub repository] +* link:https://github.com/redhat-developer/devspaces-multicluster-redirector[devspaces-multicluster-redirector GitHub repository] diff --git a/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc b/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc index ab64779406..4ff59b0789 100644 --- a/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc +++ b/modules/install/pages/using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc @@ -14,7 +14,7 @@ To deploy {prod-short} with a suitable configuration, edit the `CheCluster` Cust * An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}. -* `{prod-cli}`. See: xref:administration-guide:installing-the-chectl-management-tool.adoc[]. +* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[]. .Procedure * Create a `che-operator-cr-patch.yaml` YAML file that contains the subset of the `CheCluster` Custom Resource to configure: diff --git a/modules/install/partials/snip_preparing-images-for-a-restricted-environment.adoc b/modules/install/partials/snip_preparing-images-for-a-restricted-environment.adoc index f1a193927b..daad610901 100644 --- a/modules/install/partials/snip_preparing-images-for-a-restricted-environment.adoc +++ b/modules/install/partials/snip_preparing-images-for-a-restricted-environment.adoc @@ -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:administration-guide:installing-the-chectl-management-tool.adoc[]. +* `{prod-cli}` for {prod-short} version {prod-ver}. See xref:installing-the-chectl-management-tool.adoc[]. .Procedure diff --git a/modules/overview/pages/introduction-to-eclipse-che.adoc b/modules/overview/pages/introduction-to-eclipse-che.adoc index c754c91aed..c9c54f4bb6 100644 --- a/modules/overview/pages/introduction-to-eclipse-che.adoc +++ b/modules/overview/pages/introduction-to-eclipse-che.adoc @@ -25,7 +25,7 @@ * xref:hosted-che:hosted-che.adoc[] * xref:install:installing-che.adoc[] * xref:administration-guide:supported-platforms.adoc[] -* xref:administration-guide:calculating-che-resource-requirements.adoc[] +* xref:install:calculating-che-resource-requirements.adoc[] == Joining the community