feat: add GitOps installation procedures - #3141
Conversation
|
🎊 Navigate the preview: https://6a72e2fc324154cae529237b--eclipse-che-docs-pr.netlify.app 🎊 |
8af33c4 to
c9a12e3
Compare
b78e961 to
a44cff4
Compare
a44cff4 to
ca5eac5
Compare
|
From what I can tell, the old nav linked installing-che.adoc, which carries a large :page-aliases: list for historical URLs. Now that it's removed from the nav, have you verified that those aliases still resolve correctly in the Antora build, or do they need to be migrated to another page? |
|
@btjd Thank you, verified this. The installing-che.adoc file was not deleted, only removed from nav.adoc. It still exists at That said, I'll update the 3 cross-module xrefs that still point to installing-che.adoc (from |
9d77603 to
2ff1c64
Compare
| roleRef: | ||
| apiGroup: rbac.authorization.k8s.io | ||
| kind: ClusterRole | ||
| name: cluster-admin |
There was a problem hiding this comment.
IMHO I would replace this with:
{orch-cli} apply -f - <<EOF
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: argocd-che-installer
rules:
- apiGroups: [""]
resources: ["namespaces"]
verbs: ["get", "list", "create", "update", "patch"]
- apiGroups: ["operators.coreos.com"]
resources: ["subscriptions", "operatorgroups"]
verbs: ["get", "list", "create", "update", "patch", "delete"]
- apiGroups: ["org.eclipse.che"]
resources: ["checlusters"]
verbs: ["get", "list", "create", "update", "patch", "delete"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: argocd-che-installer
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: argocd-che-installer
subjects:
- kind: ServiceAccount
name: argocd-application-controller
namespace: argocd
EOF
to avoid giving cluster-admin permissions to the service account.
I tested the above on my cluster.
| + | ||
| [source,bash,subs="+attributes,+quotes"] | ||
| ---- | ||
| $ {orch-cli} apply -f - <<EOF |
There was a problem hiding this comment.
|
I got it working on my cluster: With this git repo: https://github.com/dkwon17/gitops-test |
Add two procedures for deploying Che using Argo CD (GitOps): - proc_deploying-che-using-gitops.adoc: connected cluster deployment - proc_deploying-che-using-gitops-in-a-restricted-environment.adoc: air-gapped deployment with mirrored registry Update con_installation-overview.adoc with GitOps as a deployment method and deployment scenario. Flatten Install nav to remove redundant 'Install Che' nesting. Add persona callouts to all Install module pages using a local partial (snip_persona-admin.adoc). Tested end-to-end on OCP 4.21 ROSA cluster. Content body identical to downstream devspaces-documentation. Co-authored-by: Cursor <cursoragent@cursor.com>
2ff1c64 to
0700526
Compare
|
@dkwon17 I have addressed your suggestions, could you please review? |
|
@gtrivedi88 thank you, LGTM |

Summary
What changed
modules/install/pages/proc_deploying-che-using-gitops.adocmodules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adocmodules/install/pages/con_installation-overview.adocmodules/install/nav.adocWhy
SME feedback: production deployments use GitOps (Argo CD), not CLI or web console. The GitOps procedure should be the primary installation method.
Two procedures cover:
Cluster testing
Tested end-to-end on OCP 4.21 ROSA cluster (Jul 2, 2026):
SkipDryRunOnMissingResource=trueworksDownstream alignment
Content body is identical to downstream
devspaces-documentationprocedures on thegitops-install-proceduresbranch. Only metadata wrappers differ (:_content-type:vs:_mod-docs-content-type:, no_{context}suffixes, Antora xrefs vslink:macros).Test plan
Made with Cursor