Skip to content

[rhoso-gitops] Docs overhaul: diagrams, app table, cluster sizing, Secret zero - #716

Draft
cjeanner wants to merge 8 commits into
validatedpatterns:mainfrom
cjeanner:rhoso-gitops/update-diagrams
Draft

[rhoso-gitops] Docs overhaul: diagrams, app table, cluster sizing, Secret zero#716
cjeanner wants to merge 8 commits into
validatedpatterns:mainfrom
cjeanner:rhoso-gitops/update-diagrams

Conversation

@cjeanner

@cjeanner cjeanner commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Update diagrams — replace SVG with PNG for reliable rendering across all browsers
  • Deduplicate app tables — move the full applications table (with RHOSO doc links, enabled/sync columns) to the Configuration page; keep a compact name+purpose table on the Architecture page
  • Baremetal requirement — replace the cluster sizing intro with the shared cluster-sizing-template include and clarify that RHOSO requires baremetal (no cloud instances)
  • Remove "Next steps" footers — they conflicted with the built-in Previous/Next navigation links
  • Add warning about example overlays — note in Configuration that upstream example/ paths are reference samples only, with direct links to the GitHub directories
  • Correct Secret zero workflow — rewrite bootstrap credential steps: create namespace first, inject the secret out of band, then wire up Kustomize overlay and enable openstack-secrets

Also contains these two patches from #713

  • Remove sync-waves — drop application-level sync-wave docs to match the "eventually converging" pattern practice
  • Automated sync & dedicated namespace — document automated sync with retry, add targetRevision stability warning, update namespace refs from openshift-gitops to rhoso-gitops-standalone

Files changed (13)

  • 5 content pages (_index, cluster-sizing, configuration, getting-started, troubleshooting)
  • 3 modules (rhoso-gitops-about, rhoso-gitops-architecture, rhoso-gitops-configuration, rhoso-gitops-deploying)
  • 2 new PNG diagrams, 2 removed SVGs

cjeanner and others added 8 commits July 30, 2026 08:18
Child applications now use automated sync with a retry policy by
default. Document the targetRevision stability warning, add a section
for disabling automated sync, and update the apps table with a Sync
column. Update all namespace references from openshift-gitops to
rhoso-gitops-standalone to reflect the dedicated ArgoCD instance.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
After testings, it seems we don't need to set sync-waves at the
application level. This allows to be closer to Validated Patterns
"eventually converging" practices.

Depends-On: validatedpatterns-sandbox/rhoso-gitops#17
Also switch to PNG format to ensure images will display in any
condition.
We split the RHOSO deployment in applications following the RHOSO
documentation split directly. This is now properly shown in the
"configuration" part, with appropriate links to RHOSO-18 documentation
sections, allowing users to better understand the purpose of each
appliction.
Point to RHOSO official requirements for OCP and dataplane nodes.
This block conflicts with the "Previous|Next" links just bellow,
creating confusion. Now we have a single path to go to the previous or
next step, or we can use the side menu directly.
Also provide direct link to the application content to show the actual
example, and remove dead link to VERSIONS.md
@openshift-ci

openshift-ci Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Hi @cjeanner. Thanks for your PR.

I'm waiting for a validatedpatterns member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-ci openshift-ci Bot added the size/XL label Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant