From 79fff69a2bfa8f458204a6d5bc50d9698282d70d Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Thu, 2 Jul 2026 14:51:35 +0530 Subject: [PATCH 1/8] feat: add GitOps installation procedures Add two new procedures for deploying Che using Argo CD (GitOps), per SME feedback that production deployments use GitOps, not CLI or web console. New files: - proc_deploying-che-using-gitops.adoc: connected cluster GitOps deployment with single Argo CD Application - proc_deploying-che-using-gitops-in-a-restricted-environment.adoc: air-gapped GitOps deployment with mirrored registry Modified files: - con_installation-overview.adoc: add GitOps as deployment method - nav.adoc: add "Deploy using GitOps" section before OpenShift Tested end-to-end on OCP 4.21 ROSA cluster (Jul 2, 2026). Critical sync option: SkipDryRunOnMissingResource=true Content body is identical to downstream devspaces-documentation proc_deploying-devspaces-using-gitops*.adoc (minus downstream-only metadata wrappers). Co-authored-by: Cursor --- modules/install/nav.adoc | 3 + .../pages/con_installation-overview.adoc | 12 +- ...ng-gitops-in-a-restricted-environment.adoc | 222 ++++++++++++++++++ .../proc_deploying-che-using-gitops.adoc | 212 +++++++++++++++++ 4 files changed, 445 insertions(+), 4 deletions(-) create mode 100644 modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc create mode 100644 modules/install/pages/proc_deploying-che-using-gitops.adoc diff --git a/modules/install/nav.adoc b/modules/install/nav.adoc index f208e6a9c1..5388c2d87d 100644 --- a/modules/install/nav.adoc +++ b/modules/install/nav.adoc @@ -8,6 +8,9 @@ ** xref:installing-the-chectl-management-tool.adoc[] // Installing * xref:installing-che.adoc[] +** Deploy using GitOps +*** xref:proc_deploying-che-using-gitops.adoc[] +*** xref:proc_deploying-che-using-gitops-in-a-restricted-environment.adoc[] ** Deploy on OpenShift *** xref:proc_installing-che-on-openshift-using-cli.adoc[] *** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[] diff --git a/modules/install/pages/con_installation-overview.adoc b/modules/install/pages/con_installation-overview.adoc index d9a3d0df7f..0131edfba2 100644 --- a/modules/install/pages/con_installation-overview.adoc +++ b/modules/install/pages/con_installation-overview.adoc @@ -13,23 +13,27 @@ == Installation methods -{prod-short} supports two installation methods: +Argo CD (GitOps):: Store the Operator subscription and `CheCluster` configuration in a Git repository and let Argo CD reconcile the deployment. Choose this method for production deployments where every configuration change must be tracked in Git, auditable, and automatically reconciled. -`{prod-cli}` command-line tool:: 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. +`{prod-cli}` command-line tool:: Install and manage {prod-short} from the command line. Choose this method when you need to quickly deploy {prod-short} for evaluation or manage it from scripts. {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. +Standard installation:: Deploy {prod-short} on a cluster with internet access. All installation 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. +GitOps deployment:: Your organization manages cluster configuration declaratively through Argo CD. Store the Operator subscription and `CheCluster` configuration in a Git repository and let Argo CD reconcile the desired state. Available for both connected and air-gapped clusters. + +Restricted environment:: Deploy {prod-short} on an air-gapped or disconnected cluster. This scenario requires mirroring container images to a private registry before installation. Both GitOps and CLI methods are available. 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_deploying-che-using-gitops.adoc[] * xref:proc_installing-che-on-openshift-using-cli.adoc[] * xref:proc_installing-che-on-openshift-using-the-web-console.adoc[] +* xref:proc_deploying-che-using-gitops-in-a-restricted-environment.adoc[] * xref:proc_installing-che-in-a-restricted-environment.adoc[] * xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[] diff --git a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc new file mode 100644 index 0000000000..7103fafd2a --- /dev/null +++ b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc @@ -0,0 +1,222 @@ +:_content-type: PROCEDURE +:description: Deploy {prod-short} in a restricted network through Argo CD by mirroring the required container images to a private registry and storing the deployment manifests in an internal Git repository. +:keywords: install, gitops, argo cd, air-gapped, restricted, disconnected +:navtitle: Deploy in a restricted environment using GitOps + +[id="deploying-che-using-gitops-in-a-restricted-environment"] += Deploy in a restricted environment using GitOps + +[role="_abstract"] +Deploy {prod-short} in a restricted network through Argo CD by mirroring the required container images to a private registry and storing the deployment manifests in an internal Git repository. + +In a disconnected environment, the cluster cannot pull images from public registries or sync from external Git repositories. You mirror the required images to an internal registry, store the {prod-short} manifests in an internal Git repository, and let Argo CD reconcile the deployment from inside the network. + +.Prerequisites + +* You have a {kubernetes} or {orch-name} cluster operating on a restricted network with administrative access. + +* You have mirrored the required {prod-short} container images and Operator catalogs to a private registry. See xref:proc_installing-che-in-a-restricted-environment.adoc[]. + +* You have an `ImageContentSourcePolicy` or `ImageDigestMirrorSet` configured to redirect image pulls to your private registry. + +* You have Argo CD installed on the cluster. See link:https://argo-cd.readthedocs.io/en/stable/getting_started/[Argo CD Getting Started]. + +* You have an active `{orch-cli}` session with administrative permissions to the cluster. + +* You have an internal Git repository accessible from the cluster. + +.Procedure + +. In your internal Git repository, create a directory for the {prod-short} manifests with three files: the Operator subscription, the `CheCluster` custom resource, and a Kustomize configuration. ++ +.Repository structure +[source,subs="+quotes"] +---- +____/ +└── che/ + ├── subscription.yaml + ├── checluster.yaml + └── kustomization.yaml +---- + +. Create the `subscription.yaml` file with the namespace and Operator subscription pointing to the disconnected catalog source: ++ +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: v1 +kind: Namespace +metadata: + name: {prod-namespace} +--- +apiVersion: operators.coreos.com/v1alpha1 +kind: Subscription +metadata: + name: {prod-operator-package-name} + namespace: openshift-operators +spec: + channel: {prod-stable-channel} + installPlanApproval: Automatic + name: {prod-operator-package-name} + source: {prod-operator-package-name}-disconnected-install + sourceNamespace: openshift-marketplace +---- ++ +The `source` field points to the disconnected catalog source created by the mirroring script. + +. Create the `checluster.yaml` file with the {prod-short} instance configuration pointing to your private registry: ++ +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: org.eclipse.che/v2 +kind: CheCluster +metadata: + name: {prod-checluster} + namespace: {prod-namespace} +spec: + components: + cheServer: + debug: false + logLevel: INFO + metrics: + enable: true + pluginRegistry: + openVSXURL: "" + containerRegistry: + hostname: ____ + organization: ____ + devEnvironments: + startTimeoutSeconds: 600 + defaultEditor: che-incubator/che-code/latest + defaultNamespace: + autoProvision: true + template: -{prod-id-short} + storage: + pvcStrategy: per-user +---- ++ +`containerRegistry.hostname`:: The hostname of your private container registry that holds the mirrored images. +`containerRegistry.organization`:: The organization or project path in your private registry. +`pluginRegistry.openVSXURL`:: Set to an empty string to disable external Open VSX access. Use an internal Open VSX instance if IDE extensions are required. +`startTimeoutSeconds`:: Increased to 600 seconds to allow for slower image pulls from internal registries. + +. Create the `kustomization.yaml` file: ++ +[source,yaml] +---- +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +resources: + - subscription.yaml + - checluster.yaml +---- + +. Commit and push the files to your internal Git repository. + +. Grant the Argo CD service account the permissions required to create namespaces and install Operators: ++ +[source,bash,subs="+attributes,+quotes"] +---- +$ {orch-cli} apply -f - <__ + targetRevision: main + path: che + destination: + server: https://kubernetes.default.svc + syncPolicy: + automated: + selfHeal: true + prune: true + retry: + limit: 10 + backoff: + duration: 30s + factor: 2 + maxDuration: 5m + syncOptions: + - CreateNamespace=true + - ServerSideApply=true + - SkipDryRunOnMissingResource=true +EOF +---- + +. Wait for Argo CD to sync the resources. In a restricted environment, the Operator installation takes longer because images are pulled from the internal registry. + +.Verification + +. Verify that the Argo CD Application reports `Synced` and `Healthy`: ++ +[source,bash,subs="+attributes"] +---- +$ {orch-cli} get application {prod-id-short} -n argocd \ + -o jsonpath='{.status.sync.status}{" "}{.status.health.status}' +---- ++ +Expected output: `Synced Healthy` + +. Verify that the `CheCluster` is active: ++ +[source,bash,subs="+attributes"] +---- +$ {orch-cli} get checluster {prod-checluster} -n {prod-namespace} \ + -o jsonpath='{.status.chePhase}' +---- ++ +Expected output: `Active` + +. Retrieve the {prod-short} dashboard URL and open it in a browser: ++ +[source,bash,subs="+attributes"] +---- +$ {orch-cli} get checluster {prod-checluster} -n {prod-namespace} \ + -o jsonpath='{.status.cheURL}' +---- + +.Troubleshooting + +* *Image pull errors*: Verify that all required images are mirrored to your private registry and that the `ImageContentSourcePolicy` or `ImageDigestMirrorSet` is configured correctly. + +* *Sync fails with "CheCluster CRD not found"*: Verify that the Argo CD Application includes `SkipDryRunOnMissingResource=true` in the `syncOptions`. + +* *Sync retries but CheCluster is not created*: The Operator may still be installing. Wait for the ClusterServiceVersion to reach `Succeeded`: ++ +[source,bash,subs="+attributes"] +---- +$ {orch-cli} get csv -A | grep {prod-operator-package-name} +---- + +.Additional resources + +* xref:proc_deploying-che-using-gitops.adoc[] +* xref:proc_installing-che-in-a-restricted-environment.adoc[] +* link:https://argo-cd.readthedocs.io/en/stable/getting_started/[Argo CD Getting Started] diff --git a/modules/install/pages/proc_deploying-che-using-gitops.adoc b/modules/install/pages/proc_deploying-che-using-gitops.adoc new file mode 100644 index 0000000000..38c5ffbe50 --- /dev/null +++ b/modules/install/pages/proc_deploying-che-using-gitops.adoc @@ -0,0 +1,212 @@ +:_content-type: PROCEDURE +:description: Deploy {prod-short} declaratively through Argo CD so that every configuration change is tracked in Git, auditable, and automatically reconciled on the cluster. +:keywords: install, gitops, argo cd, declarative, deployment +:navtitle: Deploy using GitOps and Argo CD + +[id="deploying-che-using-gitops"] += Deploy using GitOps and Argo CD + +[role="_abstract"] +Deploy {prod-short} declaratively through Argo CD so that every configuration change is tracked in Git, auditable, and automatically reconciled on the cluster. + +With this method, you store the Operator subscription and `CheCluster` configuration in a Git repository. Argo CD monitors the repository and applies changes to the cluster automatically. You manage {prod-short} through Git commits instead of direct cluster commands. + +.Prerequisites + +* You have a {kubernetes} or {orch-name} cluster with administrative access. + +* You have Argo CD installed on the cluster. See link:https://argo-cd.readthedocs.io/en/stable/getting_started/[Argo CD Getting Started]. + +* You have an active `{orch-cli}` session with administrative permissions to the cluster. + +* You have a Git repository accessible from the cluster (GitHub, GitLab, Bitbucket, or an internal Git server). + +.Procedure + +. In your Git repository, create a directory for the {prod-short} manifests. The directory contains three files: the Operator subscription, the `CheCluster` custom resource, and a Kustomize configuration. ++ +.Repository structure +[source,subs="+quotes"] +---- +____/ +└── che/ + ├── subscription.yaml + ├── checluster.yaml + └── kustomization.yaml +---- + +. Create the `subscription.yaml` file with the namespace and Operator subscription: ++ +[source,yaml,subs="+attributes"] +---- +apiVersion: v1 +kind: Namespace +metadata: + name: {prod-namespace} +--- +apiVersion: operators.coreos.com/v1alpha1 +kind: Subscription +metadata: + name: {prod-operator-package-name} + namespace: openshift-operators +spec: + channel: {prod-stable-channel} + installPlanApproval: Automatic + name: {prod-operator-package-name} + source: {prod-stable-channel-catalog-source} + sourceNamespace: openshift-marketplace +---- ++ +NOTE: On vanilla {kubernetes} clusters without OLM, install the {prod-short} Operator using Helm or `{prod-cli}` instead of a `Subscription`. + +. Create the `checluster.yaml` file with the {prod-short} instance configuration: ++ +[source,yaml,subs="+attributes"] +---- +apiVersion: org.eclipse.che/v2 +kind: CheCluster +metadata: + name: {prod-checluster} + namespace: {prod-namespace} +spec: + components: + cheServer: + debug: false + logLevel: INFO + metrics: + enable: true + pluginRegistry: + openVSXURL: https://open-vsx.org + devEnvironments: + startTimeoutSeconds: 300 + defaultEditor: che-incubator/che-code/latest + defaultNamespace: + autoProvision: true + template: -{prod-id-short} + storage: + pvcStrategy: per-user +---- + +. Create the `kustomization.yaml` file: ++ +[source,yaml] +---- +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +resources: + - subscription.yaml + - checluster.yaml +---- + +. Commit and push the files to your Git repository. + +. Grant the Argo CD service account the permissions required to create namespaces and install Operators: ++ +[source,bash,subs="+attributes,+quotes"] +---- +$ {orch-cli} apply -f - <__ + targetRevision: main + path: che + destination: + server: https://kubernetes.default.svc + syncPolicy: + automated: + selfHeal: true + prune: true + retry: + limit: 10 + backoff: + duration: 30s + factor: 2 + maxDuration: 5m + syncOptions: + - CreateNamespace=true + - ServerSideApply=true + - SkipDryRunOnMissingResource=true +EOF +---- ++ +`SkipDryRunOnMissingResource`:: Required because the `CheCluster` custom resource definition (CRD) does not exist until the Operator installs it. This option tells Argo CD to skip validation for unknown resource types and apply them directly. ++ +`selfHeal`:: Reverts manual changes on the cluster to match the Git repository state. + +. Wait for Argo CD to sync the resources. The Operator installs first, registers the `CheCluster` CRD, and then Argo CD applies the `CheCluster` custom resource. + +.Verification + +. Verify that the Argo CD Application reports `Synced` and `Healthy`: ++ +[source,bash,subs="+attributes"] +---- +$ {orch-cli} get application {prod-id-short} -n argocd \ + -o jsonpath='{.status.sync.status}{" "}{.status.health.status}' +---- ++ +Expected output: `Synced Healthy` + +. Verify that the `CheCluster` is active: ++ +[source,bash,subs="+attributes"] +---- +$ {orch-cli} get checluster {prod-checluster} -n {prod-namespace} \ + -o jsonpath='{.status.chePhase}' +---- ++ +Expected output: `Active` + +. Retrieve the {prod-short} dashboard URL and open it in a browser: ++ +[source,bash,subs="+attributes"] +---- +$ {orch-cli} get checluster {prod-checluster} -n {prod-namespace} \ + -o jsonpath='{.status.cheURL}' +---- + +.Troubleshooting + +* *Sync fails with "CheCluster CRD not found"*: Verify that the Argo CD Application includes `SkipDryRunOnMissingResource=true` in the `syncOptions`. + +* *Sync retries but CheCluster is not created*: The Operator may still be installing. Wait for the ClusterServiceVersion to reach `Succeeded`: ++ +[source,bash,subs="+attributes"] +---- +$ {orch-cli} get csv -A | grep {prod-operator-package-name} +---- + +.Additional resources + +* link:https://argo-cd.readthedocs.io/en/stable/getting_started/[Argo CD Getting Started] +* link:https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/[Argo CD sync options] +* xref:administration-guide:understanding-the-checluster-custom-resource.adoc[] From 1b30cb3ed2b0302c860909648962f4bc5ec06338 Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Thu, 2 Jul 2026 14:55:55 +0530 Subject: [PATCH 2/8] =?UTF-8?q?fix:=20resolve=20Vale=20errors=20=E2=80=94?= =?UTF-8?q?=20vanilla,=20bare=20namespace=20word?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Cursor --- ...eploying-che-using-gitops-in-a-restricted-environment.adoc | 2 +- modules/install/pages/proc_deploying-che-using-gitops.adoc | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc index 7103fafd2a..809f427c13 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc @@ -133,7 +133,7 @@ subjects: EOF ---- + -Adjust the `ServiceAccount` name and namespace to match your Argo CD installation. +Adjust the `ServiceAccount` name and {orch-namespace} to match your Argo CD installation. . Create the Argo CD `Application` resource that points to your internal Git repository: + diff --git a/modules/install/pages/proc_deploying-che-using-gitops.adoc b/modules/install/pages/proc_deploying-che-using-gitops.adoc index 38c5ffbe50..dabba59ddc 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops.adoc @@ -57,7 +57,7 @@ spec: sourceNamespace: openshift-marketplace ---- + -NOTE: On vanilla {kubernetes} clusters without OLM, install the {prod-short} Operator using Helm or `{prod-cli}` instead of a `Subscription`. +NOTE: On {kubernetes} clusters without OLM, install the {prod-short} Operator using Helm or `{prod-cli}` instead of a `Subscription`. . Create the `checluster.yaml` file with the {prod-short} instance configuration: + @@ -121,7 +121,7 @@ subjects: EOF ---- + -Adjust the `ServiceAccount` name and namespace to match your Argo CD installation. +Adjust the `ServiceAccount` name and {orch-namespace} to match your Argo CD installation. . Create the Argo CD `Application` resource that points to your Git repository: + From d0b04749f2a16b807152c5afcc0235b8c67c1227 Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Thu, 2 Jul 2026 15:52:58 +0530 Subject: [PATCH 3/8] feat: add persona callouts to Install module - Per-page persona callout added to all 23 install pages - Links to discover:roles-and-tasks.adoc for role definitions Co-authored-by: Cursor --- .../install/pages/calculating-che-resource-requirements.adoc | 2 ++ modules/install/pages/con_installation-overview.adoc | 2 ++ modules/install/pages/con_next-steps-after-installation.adoc | 2 ++ .../installing-che-on-amazon-elastic-kubernetes-service.adoc | 2 ++ modules/install/pages/installing-che-on-microsoft-azure.adoc | 2 ++ .../install/pages/installing-the-chectl-management-tool.adoc | 2 ++ ..._deploying-che-using-gitops-in-a-restricted-environment.adoc | 2 ++ modules/install/pages/proc_deploying-che-using-gitops.adoc | 2 ++ .../proc_finding-the-fully-qualified-domain-name-fqdn.adoc | 2 ++ .../pages/proc_installing-che-in-a-restricted-environment.adoc | 2 ++ .../pages/proc_installing-che-on-minikube-keycloak-oidc.adoc | 2 ++ modules/install/pages/proc_installing-che-on-minikube.adoc | 2 ++ .../pages/proc_installing-che-on-openshift-using-cli.adoc | 2 ++ .../proc_installing-che-on-openshift-using-the-web-console.adoc | 2 ++ .../proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc | 2 ++ .../pages/proc_installing-che-on-red-hat-openshift-local.adoc | 2 ++ .../proc_installing-che-on-the-virtual-kubernetes-cluster.adoc | 2 ++ modules/install/pages/proc_uninstalling-che.adoc | 2 ++ modules/install/pages/proc_verifying-the-installation.adoc | 2 ++ .../ref_permissions-to-install-che-on-openshift-using-cli.adoc | 2 ++ ...sions-to-install-che-on-openshift-using-the-web-console.adoc | 2 ++ modules/install/pages/running-at-scale.adoc | 2 ++ ...gure-the-checluster-custom-resource-during-installation.adoc | 2 ++ 23 files changed, 46 insertions(+) diff --git a/modules/install/pages/calculating-che-resource-requirements.adoc b/modules/install/pages/calculating-che-resource-requirements.adoc index db1c56602c..40079b563a 100644 --- a/modules/install/pages/calculating-che-resource-requirements.adoc +++ b/modules/install/pages/calculating-che-resource-requirements.adoc @@ -11,6 +11,8 @@ [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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + The {prod-short} Operator, {devworkspace} Controller, and user workspaces consist of a set of pods. The pods contribute to the resource consumption in CPU and memory limits and requests. diff --git a/modules/install/pages/con_installation-overview.adoc b/modules/install/pages/con_installation-overview.adoc index 0131edfba2..b21799ef13 100644 --- a/modules/install/pages/con_installation-overview.adoc +++ b/modules/install/pages/con_installation-overview.adoc @@ -9,6 +9,8 @@ [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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + {prod-short} consists of an Operator, a user dashboard, a gateway, and a plug-in registry. The Operator manages the full lifecycle of all server components. You deploy {prod-short} by installing the Operator and creating a `CheCluster` custom resource. == Installation methods diff --git a/modules/install/pages/con_next-steps-after-installation.adoc b/modules/install/pages/con_next-steps-after-installation.adoc index e554ee453a..fdef9efd12 100644 --- a/modules/install/pages/con_next-steps-after-installation.adoc +++ b/modules/install/pages/con_next-steps-after-installation.adoc @@ -9,6 +9,8 @@ [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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + * 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. 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 e179cdc752..5463065d7e 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 @@ -9,6 +9,8 @@ [role="_abstract"] To provide cloud development environments on AWS, deploy {prod-short} on an Amazon EKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites * You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm]. diff --git a/modules/install/pages/installing-che-on-microsoft-azure.adoc b/modules/install/pages/installing-che-on-microsoft-azure.adoc index e52f031ae6..c408d1bc3b 100644 --- a/modules/install/pages/installing-che-on-microsoft-azure.adoc +++ b/modules/install/pages/installing-che-on-microsoft-azure.adoc @@ -9,6 +9,8 @@ [role="_abstract"] To provide cloud development environments on Microsoft Azure, deploy {prod-short} on an AKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites * You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm]. diff --git a/modules/install/pages/installing-the-chectl-management-tool.adoc b/modules/install/pages/installing-the-chectl-management-tool.adoc index 72c6f57b7c..726d0114d7 100644 --- a/modules/install/pages/installing-the-chectl-management-tool.adoc +++ b/modules/install/pages/installing-the-chectl-management-tool.adoc @@ -11,6 +11,8 @@ [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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + include::example$proc_{project-context}-installing-the-chectl-management-tool-on-windows.adoc[leveloffset=+1] include::example$proc_{project-context}-installing-the-chectl-management-tool-on-linux-or-macos.adoc[leveloffset=+1] diff --git a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc index 809f427c13..f6acca40a2 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc @@ -9,6 +9,8 @@ [role="_abstract"] Deploy {prod-short} in a restricted network through Argo CD by mirroring the required container images to a private registry and storing the deployment manifests in an internal Git repository. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + In a disconnected environment, the cluster cannot pull images from public registries or sync from external Git repositories. You mirror the required images to an internal registry, store the {prod-short} manifests in an internal Git repository, and let Argo CD reconcile the deployment from inside the network. .Prerequisites diff --git a/modules/install/pages/proc_deploying-che-using-gitops.adoc b/modules/install/pages/proc_deploying-che-using-gitops.adoc index dabba59ddc..2ff4acb3e1 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops.adoc @@ -9,6 +9,8 @@ [role="_abstract"] Deploy {prod-short} declaratively through Argo CD so that every configuration change is tracked in Git, auditable, and automatically reconciled on the cluster. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + With this method, you store the Operator subscription and `CheCluster` configuration in a Git repository. Argo CD monitors the repository and applies changes to the cluster automatically. You manage {prod-short} through Git commits instead of direct cluster commands. .Prerequisites diff --git a/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc index 9baea25bd1..0aa54421df 100644 --- a/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc +++ b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc @@ -10,6 +10,8 @@ [role="_abstract"] 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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + [TIP] ==== You can find the FQDN for your organization's {prod-short} instance in the *Administrator* view of the {orch-name} web console as follows. Go to *Operators* -> *Installed Operators* -> *{prod} instance Specification* -> *{prod-checluster}* -> *{prod} URL*. diff --git a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc index c4d0723fc6..52823a58ac 100644 --- a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc @@ -10,6 +10,8 @@ [role="_abstract"] 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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + On a restricted network, deploying {prod-short} and running workspaces requires the following public resources: * Operator catalog 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 2d1af3b578..2e47d893cc 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 @@ -10,6 +10,8 @@ [role="_abstract"] To test {prod-short} with centralized authentication locally, deploy {prod-short} on a single-node {kubernetes} cluster with Minikube and configure Keycloak as the OpenID Connect (OIDC) identity provider. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + [WARNING] ==== Single-node {kubernetes} clusters are suited only for testing or development. Do not use such clusters to run {prod-short} for organizations or developer teams. diff --git a/modules/install/pages/proc_installing-che-on-minikube.adoc b/modules/install/pages/proc_installing-che-on-minikube.adoc index 13cd49848d..e2d020b23c 100644 --- a/modules/install/pages/proc_installing-che-on-minikube.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube.adoc @@ -10,6 +10,8 @@ [role="_abstract"] To evaluate {prod-short} in a local development environment, create a single-node {kubernetes} cluster with Minikube and deploy {prod-short}. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + [WARNING] ==== Single-node {kubernetes} clusters are suited only for testing or development. Do not use such clusters to run {prod-short} for organizations or developer teams. 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 9c5ac3884b..58a6d3ae1e 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 @@ -10,6 +10,8 @@ [role="_abstract"] 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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites * You have an {ocp} {ocp4-ver} or later cluster. diff --git a/modules/install/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 index c7dbf0c751..ae32ffbadf 100644 --- a/modules/install/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 @@ -10,6 +10,8 @@ [role="_abstract"] 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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites * You have an {orch-name} web console session as a cluster administrator. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/web-console.html[Accessing the web console]. diff --git a/modules/install/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 index 833ef7c264..6d4f43ba1b 100644 --- a/modules/install/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 @@ -10,6 +10,8 @@ [role="_abstract"] To enable centralized user authentication through an external identity provider, install {prod-short} on {orch-name} with {keycloak} as the OIDC provider. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites * You have an active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}. 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 669900ab42..1b501cc89e 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 @@ -10,6 +10,8 @@ [role="_abstract"] To evaluate {prod-short} on a local {orch-name} cluster, deploy {prod-short} by using {rh-os-local} for development and testing. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites * You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[]. 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 0e35b96b55..ee09f7a262 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 @@ -10,6 +10,8 @@ [role="_abstract"] To deploy {prod-short} when the host cluster version is incompatible or lacks external OIDC support, use a virtual {kubernetes} cluster (vCluster) to bypass these constraints. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites * You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm]. diff --git a/modules/install/pages/proc_uninstalling-che.adoc b/modules/install/pages/proc_uninstalling-che.adoc index 076f1ce7ca..783a82aae2 100644 --- a/modules/install/pages/proc_uninstalling-che.adoc +++ b/modules/install/pages/proc_uninstalling-che.adoc @@ -10,6 +10,8 @@ [role="_abstract"] Remove {prod-short} and all related user data from an {orch-name} cluster by using the `{prod-cli}` management tool. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + [WARNING] ==== Uninstalling {prod-short} removes all {prod-short}-related user data. diff --git a/modules/install/pages/proc_verifying-the-installation.adoc b/modules/install/pages/proc_verifying-the-installation.adoc index 93ae6b395b..d84751eeb1 100644 --- a/modules/install/pages/proc_verifying-the-installation.adoc +++ b/modules/install/pages/proc_verifying-the-installation.adoc @@ -9,6 +9,8 @@ [role="_abstract"] Confirm that {prod-short} is operational before onboarding users by checking the Operator pod, the `CheCluster` status, and the dashboard URL. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites * You have installed {prod-short} on an {orch-name} cluster. diff --git a/modules/install/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 index 01d72ec9bc..17095172c1 100644 --- a/modules/install/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 @@ -10,6 +10,8 @@ [role="_abstract"] 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`. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + [source,yaml,subs="+quotes,+attributes"] ---- apiVersion: rbac.authorization.k8s.io/v1 diff --git a/modules/install/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 index cc4433005c..a1d2ea96d2 100644 --- a/modules/install/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 @@ -10,6 +10,8 @@ [role="_abstract"] 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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + [source,yaml,subs="+quotes,+attributes"] ---- apiVersion: rbac.authorization.k8s.io/v1 diff --git a/modules/install/pages/running-at-scale.adoc b/modules/install/pages/running-at-scale.adoc index 155b008995..2720d1eaca 100644 --- a/modules/install/pages/running-at-scale.adoc +++ b/modules/install/pages/running-at-scale.adoc @@ -10,6 +10,8 @@ [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. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + 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. 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 4ff59b0789..5433c31644 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 @@ -9,6 +9,8 @@ To deploy {prod-short} with a suitable configuration, edit the `CheCluster` Custom Resource YAML file during the installation of {prod-short}. Otherwise, the {prod-short} deployment uses the default configuration parameterized by the Operator. +This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. + .Prerequisites From 457b357025b6ae8d046ce4ff17ce69e587690baa Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Thu, 2 Jul 2026 15:58:45 +0530 Subject: [PATCH 4/8] fix: improve persona callout wording to match GKE pattern MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 'This page is for platform administrators.' → 'This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters.' Matches Google GKE documentation style. Co-authored-by: Cursor --- .../install/pages/calculating-che-resource-requirements.adoc | 2 +- modules/install/pages/con_installation-overview.adoc | 2 +- modules/install/pages/con_next-steps-after-installation.adoc | 2 +- .../installing-che-on-amazon-elastic-kubernetes-service.adoc | 2 +- modules/install/pages/installing-che-on-microsoft-azure.adoc | 2 +- .../install/pages/installing-the-chectl-management-tool.adoc | 2 +- ..._deploying-che-using-gitops-in-a-restricted-environment.adoc | 2 +- modules/install/pages/proc_deploying-che-using-gitops.adoc | 2 +- .../proc_finding-the-fully-qualified-domain-name-fqdn.adoc | 2 +- .../pages/proc_installing-che-in-a-restricted-environment.adoc | 2 +- .../pages/proc_installing-che-on-minikube-keycloak-oidc.adoc | 2 +- modules/install/pages/proc_installing-che-on-minikube.adoc | 2 +- .../pages/proc_installing-che-on-openshift-using-cli.adoc | 2 +- .../proc_installing-che-on-openshift-using-the-web-console.adoc | 2 +- .../proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc | 2 +- .../pages/proc_installing-che-on-red-hat-openshift-local.adoc | 2 +- .../proc_installing-che-on-the-virtual-kubernetes-cluster.adoc | 2 +- modules/install/pages/proc_uninstalling-che.adoc | 2 +- modules/install/pages/proc_verifying-the-installation.adoc | 2 +- .../ref_permissions-to-install-che-on-openshift-using-cli.adoc | 2 +- ...sions-to-install-che-on-openshift-using-the-web-console.adoc | 2 +- modules/install/pages/running-at-scale.adoc | 2 +- ...gure-the-checluster-custom-resource-during-installation.adoc | 2 +- 23 files changed, 23 insertions(+), 23 deletions(-) diff --git a/modules/install/pages/calculating-che-resource-requirements.adoc b/modules/install/pages/calculating-che-resource-requirements.adoc index 40079b563a..16ade7d5f8 100644 --- a/modules/install/pages/calculating-che-resource-requirements.adoc +++ b/modules/install/pages/calculating-che-resource-requirements.adoc @@ -11,7 +11,7 @@ [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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. 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. diff --git a/modules/install/pages/con_installation-overview.adoc b/modules/install/pages/con_installation-overview.adoc index b21799ef13..57b56d9652 100644 --- a/modules/install/pages/con_installation-overview.adoc +++ b/modules/install/pages/con_installation-overview.adoc @@ -9,7 +9,7 @@ [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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. {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. diff --git a/modules/install/pages/con_next-steps-after-installation.adoc b/modules/install/pages/con_next-steps-after-installation.adoc index fdef9efd12..29cbe9fd8b 100644 --- a/modules/install/pages/con_next-steps-after-installation.adoc +++ b/modules/install/pages/con_next-steps-after-installation.adoc @@ -9,7 +9,7 @@ [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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. * Configure the `CheCluster` custom resource to customize {prod-short} behavior. * Configure OAuth for Git providers so that users can interact with remote Git repositories. 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 5463065d7e..15e286d39c 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 @@ -9,7 +9,7 @@ [role="_abstract"] To provide cloud development environments on AWS, deploy {prod-short} on an Amazon EKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites diff --git a/modules/install/pages/installing-che-on-microsoft-azure.adoc b/modules/install/pages/installing-che-on-microsoft-azure.adoc index c408d1bc3b..c1d4aaf415 100644 --- a/modules/install/pages/installing-che-on-microsoft-azure.adoc +++ b/modules/install/pages/installing-che-on-microsoft-azure.adoc @@ -9,7 +9,7 @@ [role="_abstract"] To provide cloud development environments on Microsoft Azure, deploy {prod-short} on an AKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites diff --git a/modules/install/pages/installing-the-chectl-management-tool.adoc b/modules/install/pages/installing-the-chectl-management-tool.adoc index 726d0114d7..27bff282a7 100644 --- a/modules/install/pages/installing-the-chectl-management-tool.adoc +++ b/modules/install/pages/installing-the-chectl-management-tool.adoc @@ -11,7 +11,7 @@ [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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. include::example$proc_{project-context}-installing-the-chectl-management-tool-on-windows.adoc[leveloffset=+1] diff --git a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc index f6acca40a2..f7b421c852 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Deploy {prod-short} in a restricted network through Argo CD by mirroring the required container images to a private registry and storing the deployment manifests in an internal Git repository. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. In a disconnected environment, the cluster cannot pull images from public registries or sync from external Git repositories. You mirror the required images to an internal registry, store the {prod-short} manifests in an internal Git repository, and let Argo CD reconcile the deployment from inside the network. diff --git a/modules/install/pages/proc_deploying-che-using-gitops.adoc b/modules/install/pages/proc_deploying-che-using-gitops.adoc index 2ff4acb3e1..108684db34 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Deploy {prod-short} declaratively through Argo CD so that every configuration change is tracked in Git, auditable, and automatically reconciled on the cluster. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. With this method, you store the Operator subscription and `CheCluster` configuration in a Git repository. Argo CD monitors the repository and applies changes to the cluster automatically. You manage {prod-short} through Git commits instead of direct cluster commands. diff --git a/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc index 0aa54421df..715031f631 100644 --- a/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc +++ b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. [TIP] ==== diff --git a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc index 52823a58ac..b9d623f140 100644 --- a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. On a restricted network, deploying {prod-short} and running workspaces requires the following public resources: 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 2e47d893cc..498a40cecc 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 @@ -10,7 +10,7 @@ [role="_abstract"] To test {prod-short} with centralized authentication locally, deploy {prod-short} on a single-node {kubernetes} cluster with Minikube and configure Keycloak as the OpenID Connect (OIDC) identity provider. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. [WARNING] ==== diff --git a/modules/install/pages/proc_installing-che-on-minikube.adoc b/modules/install/pages/proc_installing-che-on-minikube.adoc index e2d020b23c..349081c6f3 100644 --- a/modules/install/pages/proc_installing-che-on-minikube.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube.adoc @@ -10,7 +10,7 @@ [role="_abstract"] To evaluate {prod-short} in a local development environment, create a single-node {kubernetes} cluster with Minikube and deploy {prod-short}. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. [WARNING] ==== 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 58a6d3ae1e..838fb736ed 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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites diff --git a/modules/install/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 index ae32ffbadf..899c3ebae8 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites diff --git a/modules/install/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 index 6d4f43ba1b..1781de08ba 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] To enable centralized user authentication through an external identity provider, install {prod-short} on {orch-name} with {keycloak} as the OIDC provider. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites 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 1b501cc89e..5a51784a39 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 @@ -10,7 +10,7 @@ [role="_abstract"] To evaluate {prod-short} on a local {orch-name} cluster, deploy {prod-short} by using {rh-os-local} for development and testing. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites 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 ee09f7a262..cd82f4a2e6 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 @@ -10,7 +10,7 @@ [role="_abstract"] To deploy {prod-short} when the host cluster version is incompatible or lacks external OIDC support, use a virtual {kubernetes} cluster (vCluster) to bypass these constraints. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites diff --git a/modules/install/pages/proc_uninstalling-che.adoc b/modules/install/pages/proc_uninstalling-che.adoc index 783a82aae2..408ca4f59f 100644 --- a/modules/install/pages/proc_uninstalling-che.adoc +++ b/modules/install/pages/proc_uninstalling-che.adoc @@ -10,7 +10,7 @@ [role="_abstract"] Remove {prod-short} and all related user data from an {orch-name} cluster by using the `{prod-cli}` management tool. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. [WARNING] ==== diff --git a/modules/install/pages/proc_verifying-the-installation.adoc b/modules/install/pages/proc_verifying-the-installation.adoc index d84751eeb1..029fe8de45 100644 --- a/modules/install/pages/proc_verifying-the-installation.adoc +++ b/modules/install/pages/proc_verifying-the-installation.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Confirm that {prod-short} is operational before onboarding users by checking the Operator pod, the `CheCluster` status, and the dashboard URL. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites diff --git a/modules/install/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 index 17095172c1..68c4348288 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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`. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/install/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 index a1d2ea96d2..ebb070bace 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/install/pages/running-at-scale.adoc b/modules/install/pages/running-at-scale.adoc index 2720d1eaca..934a104c3d 100644 --- a/modules/install/pages/running-at-scale.adoc +++ b/modules/install/pages/running-at-scale.adoc @@ -10,7 +10,7 @@ [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. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. 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. 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 5433c31644..c311dc549e 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 @@ -9,7 +9,7 @@ To deploy {prod-short} with a suitable configuration, edit the `CheCluster` Custom Resource YAML file during the installation of {prod-short}. Otherwise, the {prod-short} deployment uses the default configuration parameterized by the Operator. -This page is for platform administrators. To learn more about common roles, see xref:discover:roles-and-tasks.adoc[]. +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. .Prerequisites From 3b741ae144e0b607af184dcfa0dd56d6f0eaf31d Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Thu, 2 Jul 2026 16:05:27 +0530 Subject: [PATCH 5/8] refactor: use Antora partials for persona callouts in Install Replace hardcoded persona text with include::discover:partial$snip_persona-admin.adoc[] in all 23 install pages. Partials created in Discover PR #3131. Co-authored-by: Cursor --- .../install/pages/calculating-che-resource-requirements.adoc | 2 +- modules/install/pages/con_installation-overview.adoc | 2 +- modules/install/pages/con_next-steps-after-installation.adoc | 2 +- .../installing-che-on-amazon-elastic-kubernetes-service.adoc | 2 +- modules/install/pages/installing-che-on-microsoft-azure.adoc | 2 +- .../install/pages/installing-the-chectl-management-tool.adoc | 2 +- ..._deploying-che-using-gitops-in-a-restricted-environment.adoc | 2 +- modules/install/pages/proc_deploying-che-using-gitops.adoc | 2 +- .../proc_finding-the-fully-qualified-domain-name-fqdn.adoc | 2 +- .../pages/proc_installing-che-in-a-restricted-environment.adoc | 2 +- .../pages/proc_installing-che-on-minikube-keycloak-oidc.adoc | 2 +- modules/install/pages/proc_installing-che-on-minikube.adoc | 2 +- .../pages/proc_installing-che-on-openshift-using-cli.adoc | 2 +- .../proc_installing-che-on-openshift-using-the-web-console.adoc | 2 +- .../proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc | 2 +- .../pages/proc_installing-che-on-red-hat-openshift-local.adoc | 2 +- .../proc_installing-che-on-the-virtual-kubernetes-cluster.adoc | 2 +- modules/install/pages/proc_uninstalling-che.adoc | 2 +- modules/install/pages/proc_verifying-the-installation.adoc | 2 +- .../ref_permissions-to-install-che-on-openshift-using-cli.adoc | 2 +- ...sions-to-install-che-on-openshift-using-the-web-console.adoc | 2 +- modules/install/pages/running-at-scale.adoc | 2 +- ...gure-the-checluster-custom-resource-during-installation.adoc | 2 +- 23 files changed, 23 insertions(+), 23 deletions(-) diff --git a/modules/install/pages/calculating-che-resource-requirements.adoc b/modules/install/pages/calculating-che-resource-requirements.adoc index 16ade7d5f8..d53ceb6f90 100644 --- a/modules/install/pages/calculating-che-resource-requirements.adoc +++ b/modules/install/pages/calculating-che-resource-requirements.adoc @@ -11,7 +11,7 @@ [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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] The {prod-short} Operator, {devworkspace} Controller, and user workspaces consist of a set of pods. The pods contribute to the resource consumption in CPU and memory limits and requests. diff --git a/modules/install/pages/con_installation-overview.adoc b/modules/install/pages/con_installation-overview.adoc index 57b56d9652..840e184d1f 100644 --- a/modules/install/pages/con_installation-overview.adoc +++ b/modules/install/pages/con_installation-overview.adoc @@ -9,7 +9,7 @@ [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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] {prod-short} consists of an Operator, a user dashboard, a gateway, and a plug-in registry. The Operator manages the full lifecycle of all server components. You deploy {prod-short} by installing the Operator and creating a `CheCluster` custom resource. diff --git a/modules/install/pages/con_next-steps-after-installation.adoc b/modules/install/pages/con_next-steps-after-installation.adoc index 29cbe9fd8b..87390aa382 100644 --- a/modules/install/pages/con_next-steps-after-installation.adoc +++ b/modules/install/pages/con_next-steps-after-installation.adoc @@ -9,7 +9,7 @@ [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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] * Configure the `CheCluster` custom resource to customize {prod-short} behavior. * Configure OAuth for Git providers so that users can interact with remote Git repositories. 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 15e286d39c..5777fff1cb 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 @@ -9,7 +9,7 @@ [role="_abstract"] To provide cloud development environments on AWS, deploy {prod-short} on an Amazon EKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/pages/installing-che-on-microsoft-azure.adoc b/modules/install/pages/installing-che-on-microsoft-azure.adoc index c1d4aaf415..b7a889aa9f 100644 --- a/modules/install/pages/installing-che-on-microsoft-azure.adoc +++ b/modules/install/pages/installing-che-on-microsoft-azure.adoc @@ -9,7 +9,7 @@ [role="_abstract"] To provide cloud development environments on Microsoft Azure, deploy {prod-short} on an AKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/pages/installing-the-chectl-management-tool.adoc b/modules/install/pages/installing-the-chectl-management-tool.adoc index 27bff282a7..20af0eed65 100644 --- a/modules/install/pages/installing-the-chectl-management-tool.adoc +++ b/modules/install/pages/installing-the-chectl-management-tool.adoc @@ -11,7 +11,7 @@ [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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] include::example$proc_{project-context}-installing-the-chectl-management-tool-on-windows.adoc[leveloffset=+1] diff --git a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc index f7b421c852..a9993a8266 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Deploy {prod-short} in a restricted network through Argo CD by mirroring the required container images to a private registry and storing the deployment manifests in an internal Git repository. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] In a disconnected environment, the cluster cannot pull images from public registries or sync from external Git repositories. You mirror the required images to an internal registry, store the {prod-short} manifests in an internal Git repository, and let Argo CD reconcile the deployment from inside the network. diff --git a/modules/install/pages/proc_deploying-che-using-gitops.adoc b/modules/install/pages/proc_deploying-che-using-gitops.adoc index 108684db34..e69cb0083b 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Deploy {prod-short} declaratively through Argo CD so that every configuration change is tracked in Git, auditable, and automatically reconciled on the cluster. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] With this method, you store the Operator subscription and `CheCluster` configuration in a Git repository. Argo CD monitors the repository and applies changes to the cluster automatically. You manage {prod-short} through Git commits instead of direct cluster commands. diff --git a/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc index 715031f631..9a095bf812 100644 --- a/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc +++ b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] [TIP] ==== diff --git a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc index b9d623f140..20021518c8 100644 --- a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] On a restricted network, deploying {prod-short} and running workspaces requires the following public resources: 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 498a40cecc..fb736ed80e 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 @@ -10,7 +10,7 @@ [role="_abstract"] To test {prod-short} with centralized authentication locally, deploy {prod-short} on a single-node {kubernetes} cluster with Minikube and configure Keycloak as the OpenID Connect (OIDC) identity provider. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] [WARNING] ==== diff --git a/modules/install/pages/proc_installing-che-on-minikube.adoc b/modules/install/pages/proc_installing-che-on-minikube.adoc index 349081c6f3..4985936153 100644 --- a/modules/install/pages/proc_installing-che-on-minikube.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube.adoc @@ -10,7 +10,7 @@ [role="_abstract"] To evaluate {prod-short} in a local development environment, create a single-node {kubernetes} cluster with Minikube and deploy {prod-short}. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] [WARNING] ==== 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 838fb736ed..ab683fc089 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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/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 index 899c3ebae8..38febc81fb 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/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 index 1781de08ba..37aaa80db4 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] To enable centralized user authentication through an external identity provider, install {prod-short} on {orch-name} with {keycloak} as the OIDC provider. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites 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 5a51784a39..1a9e7aaf54 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 @@ -10,7 +10,7 @@ [role="_abstract"] To evaluate {prod-short} on a local {orch-name} cluster, deploy {prod-short} by using {rh-os-local} for development and testing. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites 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 cd82f4a2e6..af725a6174 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 @@ -10,7 +10,7 @@ [role="_abstract"] To deploy {prod-short} when the host cluster version is incompatible or lacks external OIDC support, use a virtual {kubernetes} cluster (vCluster) to bypass these constraints. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/pages/proc_uninstalling-che.adoc b/modules/install/pages/proc_uninstalling-che.adoc index 408ca4f59f..6998b3f0a1 100644 --- a/modules/install/pages/proc_uninstalling-che.adoc +++ b/modules/install/pages/proc_uninstalling-che.adoc @@ -10,7 +10,7 @@ [role="_abstract"] Remove {prod-short} and all related user data from an {orch-name} cluster by using the `{prod-cli}` management tool. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] [WARNING] ==== diff --git a/modules/install/pages/proc_verifying-the-installation.adoc b/modules/install/pages/proc_verifying-the-installation.adoc index 029fe8de45..2fd5ac2700 100644 --- a/modules/install/pages/proc_verifying-the-installation.adoc +++ b/modules/install/pages/proc_verifying-the-installation.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Confirm that {prod-short} is operational before onboarding users by checking the Operator pod, the `CheCluster` status, and the dashboard URL. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/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 index 68c4348288..b889850f0f 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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`. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/install/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 index ebb070bace..1e142bed43 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/install/pages/running-at-scale.adoc b/modules/install/pages/running-at-scale.adoc index 934a104c3d..08b99a2998 100644 --- a/modules/install/pages/running-at-scale.adoc +++ b/modules/install/pages/running-at-scale.adoc @@ -10,7 +10,7 @@ [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. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] 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. 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 c311dc549e..71bdd4f54f 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 @@ -9,7 +9,7 @@ To deploy {prod-short} with a suitable configuration, edit the `CheCluster` Custom Resource YAML file during the installation of {prod-short}. Otherwise, the {prod-short} deployment uses the default configuration parameterized by the Operator. -This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. +include::discover:partial$snip_persona-admin.adoc[] .Prerequisites From 3988ce7db4285d5ecb8689acdcbcd8cc56abef25 Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Thu, 2 Jul 2026 16:25:20 +0530 Subject: [PATCH 6/8] fix: use local install partial instead of cross-module discover:partial Co-authored-by: Cursor --- .../install/pages/calculating-che-resource-requirements.adoc | 2 +- modules/install/pages/con_installation-overview.adoc | 2 +- modules/install/pages/con_next-steps-after-installation.adoc | 2 +- .../installing-che-on-amazon-elastic-kubernetes-service.adoc | 2 +- modules/install/pages/installing-che-on-microsoft-azure.adoc | 2 +- .../install/pages/installing-the-chectl-management-tool.adoc | 2 +- ..._deploying-che-using-gitops-in-a-restricted-environment.adoc | 2 +- modules/install/pages/proc_deploying-che-using-gitops.adoc | 2 +- .../proc_finding-the-fully-qualified-domain-name-fqdn.adoc | 2 +- .../pages/proc_installing-che-in-a-restricted-environment.adoc | 2 +- .../pages/proc_installing-che-on-minikube-keycloak-oidc.adoc | 2 +- modules/install/pages/proc_installing-che-on-minikube.adoc | 2 +- .../pages/proc_installing-che-on-openshift-using-cli.adoc | 2 +- .../proc_installing-che-on-openshift-using-the-web-console.adoc | 2 +- .../proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc | 2 +- .../pages/proc_installing-che-on-red-hat-openshift-local.adoc | 2 +- .../proc_installing-che-on-the-virtual-kubernetes-cluster.adoc | 2 +- modules/install/pages/proc_uninstalling-che.adoc | 2 +- modules/install/pages/proc_verifying-the-installation.adoc | 2 +- .../ref_permissions-to-install-che-on-openshift-using-cli.adoc | 2 +- ...sions-to-install-che-on-openshift-using-the-web-console.adoc | 2 +- modules/install/pages/running-at-scale.adoc | 2 +- ...gure-the-checluster-custom-resource-during-installation.adoc | 2 +- modules/install/partials/snip_persona-admin.adoc | 1 + 24 files changed, 24 insertions(+), 23 deletions(-) create mode 100644 modules/install/partials/snip_persona-admin.adoc diff --git a/modules/install/pages/calculating-che-resource-requirements.adoc b/modules/install/pages/calculating-che-resource-requirements.adoc index d53ceb6f90..4ec7411f06 100644 --- a/modules/install/pages/calculating-che-resource-requirements.adoc +++ b/modules/install/pages/calculating-che-resource-requirements.adoc @@ -11,7 +11,7 @@ [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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] The {prod-short} Operator, {devworkspace} Controller, and user workspaces consist of a set of pods. The pods contribute to the resource consumption in CPU and memory limits and requests. diff --git a/modules/install/pages/con_installation-overview.adoc b/modules/install/pages/con_installation-overview.adoc index 840e184d1f..c91f228f91 100644 --- a/modules/install/pages/con_installation-overview.adoc +++ b/modules/install/pages/con_installation-overview.adoc @@ -9,7 +9,7 @@ [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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] {prod-short} consists of an Operator, a user dashboard, a gateway, and a plug-in registry. The Operator manages the full lifecycle of all server components. You deploy {prod-short} by installing the Operator and creating a `CheCluster` custom resource. diff --git a/modules/install/pages/con_next-steps-after-installation.adoc b/modules/install/pages/con_next-steps-after-installation.adoc index 87390aa382..b4134be963 100644 --- a/modules/install/pages/con_next-steps-after-installation.adoc +++ b/modules/install/pages/con_next-steps-after-installation.adoc @@ -9,7 +9,7 @@ [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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] * Configure the `CheCluster` custom resource to customize {prod-short} behavior. * Configure OAuth for Git providers so that users can interact with remote Git repositories. 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 5777fff1cb..10f0df07ed 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 @@ -9,7 +9,7 @@ [role="_abstract"] To provide cloud development environments on AWS, deploy {prod-short} on an Amazon EKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/pages/installing-che-on-microsoft-azure.adoc b/modules/install/pages/installing-che-on-microsoft-azure.adoc index b7a889aa9f..2e77b55651 100644 --- a/modules/install/pages/installing-che-on-microsoft-azure.adoc +++ b/modules/install/pages/installing-che-on-microsoft-azure.adoc @@ -9,7 +9,7 @@ [role="_abstract"] To provide cloud development environments on Microsoft Azure, deploy {prod-short} on an AKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/pages/installing-the-chectl-management-tool.adoc b/modules/install/pages/installing-the-chectl-management-tool.adoc index 20af0eed65..1785c9b191 100644 --- a/modules/install/pages/installing-the-chectl-management-tool.adoc +++ b/modules/install/pages/installing-the-chectl-management-tool.adoc @@ -11,7 +11,7 @@ [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::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] include::example$proc_{project-context}-installing-the-chectl-management-tool-on-windows.adoc[leveloffset=+1] diff --git a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc index a9993a8266..a4d5882e4a 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Deploy {prod-short} in a restricted network through Argo CD by mirroring the required container images to a private registry and storing the deployment manifests in an internal Git repository. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] In a disconnected environment, the cluster cannot pull images from public registries or sync from external Git repositories. You mirror the required images to an internal registry, store the {prod-short} manifests in an internal Git repository, and let Argo CD reconcile the deployment from inside the network. diff --git a/modules/install/pages/proc_deploying-che-using-gitops.adoc b/modules/install/pages/proc_deploying-che-using-gitops.adoc index e69cb0083b..6581c2d114 100644 --- a/modules/install/pages/proc_deploying-che-using-gitops.adoc +++ b/modules/install/pages/proc_deploying-che-using-gitops.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Deploy {prod-short} declaratively through Argo CD so that every configuration change is tracked in Git, auditable, and automatically reconciled on the cluster. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] With this method, you store the Operator subscription and `CheCluster` configuration in a Git repository. Argo CD monitors the repository and applies changes to the cluster automatically. You manage {prod-short} through Git commits instead of direct cluster commands. diff --git a/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc index 9a095bf812..2f9fa847f7 100644 --- a/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc +++ b/modules/install/pages/proc_finding-the-fully-qualified-domain-name-fqdn.adoc @@ -10,7 +10,7 @@ [role="_abstract"] 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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] [TIP] ==== diff --git a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc index 20021518c8..b3947dcfef 100644 --- a/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc +++ b/modules/install/pages/proc_installing-che-in-a-restricted-environment.adoc @@ -10,7 +10,7 @@ [role="_abstract"] 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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] On a restricted network, deploying {prod-short} and running workspaces requires the following public resources: 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 fb736ed80e..62ef0e6e9d 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 @@ -10,7 +10,7 @@ [role="_abstract"] To test {prod-short} with centralized authentication locally, deploy {prod-short} on a single-node {kubernetes} cluster with Minikube and configure Keycloak as the OpenID Connect (OIDC) identity provider. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] [WARNING] ==== diff --git a/modules/install/pages/proc_installing-che-on-minikube.adoc b/modules/install/pages/proc_installing-che-on-minikube.adoc index 4985936153..fb1e774de7 100644 --- a/modules/install/pages/proc_installing-che-on-minikube.adoc +++ b/modules/install/pages/proc_installing-che-on-minikube.adoc @@ -10,7 +10,7 @@ [role="_abstract"] To evaluate {prod-short} in a local development environment, create a single-node {kubernetes} cluster with Minikube and deploy {prod-short}. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] [WARNING] ==== 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 ab683fc089..93f73cc478 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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/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 index 38febc81fb..5bd3e7232d 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/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 index 37aaa80db4..17964651ee 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] To enable centralized user authentication through an external identity provider, install {prod-short} on {orch-name} with {keycloak} as the OIDC provider. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites 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 1a9e7aaf54..f84635e0f4 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 @@ -10,7 +10,7 @@ [role="_abstract"] To evaluate {prod-short} on a local {orch-name} cluster, deploy {prod-short} by using {rh-os-local} for development and testing. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites 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 af725a6174..6995b3ea67 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 @@ -10,7 +10,7 @@ [role="_abstract"] To deploy {prod-short} when the host cluster version is incompatible or lacks external OIDC support, use a virtual {kubernetes} cluster (vCluster) to bypass these constraints. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/pages/proc_uninstalling-che.adoc b/modules/install/pages/proc_uninstalling-che.adoc index 6998b3f0a1..6aa2eb3b81 100644 --- a/modules/install/pages/proc_uninstalling-che.adoc +++ b/modules/install/pages/proc_uninstalling-che.adoc @@ -10,7 +10,7 @@ [role="_abstract"] Remove {prod-short} and all related user data from an {orch-name} cluster by using the `{prod-cli}` management tool. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] [WARNING] ==== diff --git a/modules/install/pages/proc_verifying-the-installation.adoc b/modules/install/pages/proc_verifying-the-installation.adoc index 2fd5ac2700..1d3f1eaabb 100644 --- a/modules/install/pages/proc_verifying-the-installation.adoc +++ b/modules/install/pages/proc_verifying-the-installation.adoc @@ -9,7 +9,7 @@ [role="_abstract"] Confirm that {prod-short} is operational before onboarding users by checking the Operator pod, the `CheCluster` status, and the dashboard URL. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/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 index b889850f0f..54d12a6f12 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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`. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/install/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 index 1e142bed43..0cf82b08f8 100644 --- a/modules/install/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 @@ -10,7 +10,7 @@ [role="_abstract"] 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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] [source,yaml,subs="+quotes,+attributes"] ---- diff --git a/modules/install/pages/running-at-scale.adoc b/modules/install/pages/running-at-scale.adoc index 08b99a2998..796e93b763 100644 --- a/modules/install/pages/running-at-scale.adoc +++ b/modules/install/pages/running-at-scale.adoc @@ -10,7 +10,7 @@ [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. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] 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. 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 71bdd4f54f..b3c929e877 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 @@ -9,7 +9,7 @@ To deploy {prod-short} with a suitable configuration, edit the `CheCluster` Custom Resource YAML file during the installation of {prod-short}. Otherwise, the {prod-short} deployment uses the default configuration parameterized by the Operator. -include::discover:partial$snip_persona-admin.adoc[] +include::partial$snip_persona-admin.adoc[] .Prerequisites diff --git a/modules/install/partials/snip_persona-admin.adoc b/modules/install/partials/snip_persona-admin.adoc new file mode 100644 index 0000000000..9857252bbf --- /dev/null +++ b/modules/install/partials/snip_persona-admin.adoc @@ -0,0 +1 @@ +This page is for platform administrators who install, configure, and manage {prod-short} on {orch-name} clusters. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. From c9a12e3b53da8b0a8939581befaf7cc72d0d1e1f Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Thu, 2 Jul 2026 17:12:10 +0530 Subject: [PATCH 7/8] fix: use AsciiDoc comments for Vale control directives pass:[] HTML comments get linted as content, causing false RedHat.Spacing errors on 'RedHat.Spelling'. AsciiDoc comments (// vale ...) are the correct format for Vale control. Co-authored-by: Cursor --- ...c_installing-che-on-openshift-using-the-web-console.adoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/modules/install/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 index 5bd3e7232d..854f6172be 100644 --- a/modules/install/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 @@ -61,11 +61,9 @@ See link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/user .Verification -pass:[] - +// vale RedHat.Spelling = NO . In *{prod} instance Specification*, go to *{prod-checluster}*, landing on the *Details* tab. - -pass:[] +// vale RedHat.Spelling = YES . Under *Message*, check that there is *None*, which means no errors. From b78e9610b66d35855520d158648a2024d452322d Mon Sep 17 00:00:00 2001 From: Gaurav Trivedi Date: Thu, 2 Jul 2026 17:21:59 +0530 Subject: [PATCH 8/8] fix: flatten Install nav to remove redundant 'Install Che' nesting MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Same fix as Upgrade PR #3142 — the top-level nav already says 'Install', so nesting all procedures under another 'Install Che' wrapper is redundant. Deployment sections (GitOps, OpenShift, Kubernetes, local, restricted) are now top-level nav items. Co-authored-by: Cursor --- modules/install/nav.adoc | 45 ++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/modules/install/nav.adoc b/modules/install/nav.adoc index 5388c2d87d..67c5226895 100644 --- a/modules/install/nav.adoc +++ b/modules/install/nav.adoc @@ -7,29 +7,28 @@ ** xref:running-at-scale.adoc[] ** xref:installing-the-chectl-management-tool.adoc[] // Installing -* xref:installing-che.adoc[] -** Deploy using GitOps -*** xref:proc_deploying-che-using-gitops.adoc[] -*** xref:proc_deploying-che-using-gitops-in-a-restricted-environment.adoc[] -** Deploy on OpenShift -*** xref:proc_installing-che-on-openshift-using-cli.adoc[] -*** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[] -*** xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[] -** Deploy on {kubernetes} -*** xref:installing-che-on-microsoft-azure.adoc[] -*** xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[] -*** xref:proc_installing-che-on-the-virtual-kubernetes-cluster.adoc[] -** Deploy locally -*** xref:proc_installing-che-on-red-hat-openshift-local.adoc[] -*** xref:proc_installing-che-on-minikube.adoc[] -*** xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[] -** Deploy in a restricted environment -*** xref:proc_installing-che-in-a-restricted-environment.adoc[] -** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] -** 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[] +* Deploy using GitOps +** xref:proc_deploying-che-using-gitops.adoc[] +** xref:proc_deploying-che-using-gitops-in-a-restricted-environment.adoc[] +* Deploy on OpenShift +** xref:proc_installing-che-on-openshift-using-cli.adoc[] +** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[] +** xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[] +* Deploy on {kubernetes} +** xref:installing-che-on-microsoft-azure.adoc[] +** xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[] +** xref:proc_installing-che-on-the-virtual-kubernetes-cluster.adoc[] +* Deploy locally +** xref:proc_installing-che-on-red-hat-openshift-local.adoc[] +** xref:proc_installing-che-on-minikube.adoc[] +** xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[] +* Deploy in a restricted environment +** xref:proc_installing-che-in-a-restricted-environment.adoc[] +* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[] +* 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[]