Skip to content

feat: add GitOps installation procedures - #3141

Open
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:gitops-install-procedures
Open

feat: add GitOps installation procedures#3141
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:gitops-install-procedures

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Summary

  • Add two new procedures for deploying Che using Argo CD (GitOps)
  • Update installation overview to include GitOps as a deployment method
  • Add "Deploy using GitOps" section to nav (before OpenShift deploy methods)

What changed

Action File
Created modules/install/pages/proc_deploying-che-using-gitops.adoc
Created modules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adoc
Modified modules/install/pages/con_installation-overview.adoc
Modified modules/install/nav.adoc

Why

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:

  1. Connected clusters: Argo CD pulling from an external Git repo
  2. Air-gapped clusters: Argo CD pulling from an internal Git repo + mirrored registry

Cluster testing

Tested end-to-end on OCP 4.21 ROSA cluster (Jul 2, 2026):

  • Single Argo CD Application with SkipDryRunOnMissingResource=true works
  • Operator installs via OLM, CheCluster CR applied after CRD is registered
  • Dashboard comes up, Phase: Active

Downstream alignment

Content body is identical to downstream devspaces-documentation procedures on the gitops-install-procedures branch. Only metadata wrappers differ (:_content-type: vs :_mod-docs-content-type:, no _{context} suffixes, Antora xrefs vs link: macros).

Test plan

  • Antora build succeeds
  • nav renders with "Deploy using GitOps" section
  • Vale passes on new files

Made with Cursor

@gtrivedi88
gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 2, 2026 09:21
@gtrivedi88
gtrivedi88 requested a review from ibuziuk July 2, 2026 09:21
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

🎊 Navigate the preview: https://6a67b54e32223d3fec9e4b61--eclipse-che-docs-pr.netlify.app 🎊

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@gtrivedi88
gtrivedi88 force-pushed the gitops-install-procedures branch 2 times, most recently from 8af33c4 to c9a12e3 Compare July 2, 2026 11:42
@gtrivedi88
gtrivedi88 force-pushed the gitops-install-procedures branch from b78e961 to a44cff4 Compare July 15, 2026 12:00
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>
@gtrivedi88
gtrivedi88 force-pushed the gitops-install-procedures branch from a44cff4 to ca5eac5 Compare July 27, 2026 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant