Skip to content

Commit 6ea3982

Browse files
committed
feat(patterns): add rhoso-gitops pattern docs
Add sandbox-tier documentation for the RHOSO GitOps pattern: overview, getting started, cluster sizing, configuration, and troubleshooting pages, reusable AsciiDoc modules, metadata from pattern-metadata.yaml, shared RHOSO attributes, and spellcheck wordlist entries. Pattern repository links use cjeanner/pattern-rhoso-gitops for now. TODO(repo-move) comments mark github, bugs, and deploy URLs to update once the repo moves to validatedpatterns-sandbox/rhoso-gitops. Architecture diagrams (GitOps delivery and infrastructure topology) were created on Miro and exported as SVG under static/images/rhoso-gitops/. AI-Assist: Cursor; model=Composer; mode=agent; origin=cursor
1 parent 08c4f71 commit 6ea3982

14 files changed

Lines changed: 1166 additions & 4 deletions

.wordlist.txt

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ anattama
3939
anonymized
4040
anonymizer
4141
ansible
42-
api's
4342
apicast
4443
apicurito
44+
api's
4545
apis
4646
apiversion
4747
appdev
@@ -109,6 +109,7 @@ cacert
109109
cakephp
110110
canarypausestep
111111
cas
112+
ccvdr
112113
cdd
113114
cdh
114115
cdn
@@ -128,6 +129,7 @@ chown
128129
chroot
129130
cicd
130131
cj
132+
cjeanner
131133
ckollujlir
132134
claudiol
133135
cli
@@ -193,6 +195,7 @@ cryptographic
193195
csi
194196
csr
195197
csv
198+
csvs
196199
ctdim
197200
ctrl
198201
cuda
@@ -209,6 +212,7 @@ dasv
209212
datacenter
210213
dataflow
211214
datagrid
215+
dataplane
212216
dataset
213217
datasets
214218
datasheet
@@ -315,6 +319,7 @@ externalurl
315319
extraconfig
316320
facto
317321
fadc
322+
faipqlsci
318323
fc
319324
fcb
320325
fcea
@@ -340,6 +345,7 @@ fs
340345
fssl
341346
fsv
342347
fsync
348+
fu
343349
fvsm
344350
fx
345351
gapped
@@ -393,6 +399,7 @@ hc
393399
hcl
394400
hcp
395401
hdsr
402+
healthcheck
396403
helloworld
397404
helmoverrides
398405
helmrepourl
@@ -510,6 +517,8 @@ jtf
510517
jumpstart
511518
jupyter
512519
jws
520+
jyerthqlkjdugwqbg
521+
jyerthqlkjdugwqbg7vcg
513522
kafdrop
514523
kafkasource
515524
kafkatopic
@@ -708,11 +717,12 @@ opendatahub
708717
openid
709718
openjdk
710719
openshift
711-
openshift's
712720
openshiftpullsecret
721+
openshift's
713722
openshiftsdn
714723
openshiftversion
715724
openssl
725+
openstack
716726
openvino
717727
openvinotoolkit
718728
operatorchannel
@@ -776,6 +786,7 @@ predeploy
776786
prem
777787
preplay
778788
preprocess
789+
prereq
779790
prereqs
780791
prerequisitesrequirements
781792
privatekey
@@ -831,8 +842,8 @@ renderers
831842
replicaset
832843
replicasets
833844
repo
834-
repo's
835845
repolist
846+
repo's
836847
repos
837848
repourl
838849
reranked
@@ -852,6 +863,7 @@ rhoai
852863
rhocp
853864
rhodf
854865
rhods
866+
rhoso
855867
rhpam
856868
rhpds
857869
rhsm
@@ -961,6 +973,7 @@ svg
961973
synapseai
962974
synched
963975
syncpolicy
976+
syncwave
964977
sys
965978
syscall
966979
targetbucket
@@ -1037,8 +1050,8 @@ unsealvault
10371050
untrusted
10381051
updatingconfig
10391052
updatingversion
1040-
upstream's
10411053
upstreaming
1054+
upstream's
10421055
ure
10431056
uri
10441057
usecsv
@@ -1056,6 +1069,7 @@ vaultkeys
10561069
vaultpolicy
10571070
vaultprefixes
10581071
vaultproject
1072+
vcg
10591073
vcpu
10601074
vcpus
10611075
vdjtkgams
@@ -1065,6 +1079,7 @@ vectorized
10651079
veeam
10661080
vfio
10671081
vhjpkievife
1082+
viewform
10681083
virtualmachine
10691084
virtualmachines
10701085
vm
@@ -1091,6 +1106,7 @@ wip
10911106
wjalrxutnfemi/k7mdeng/bpxrficyexamplekey
10921107
wnklrcd
10931108
wtjq
1109+
wypu
10941110
wyr
10951111
xeon
10961112
xeons
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: RHOSO GitOps
3+
date: 2026-06-15
4+
tier: sandbox
5+
summary: Deploy Red Hat OpenStack Services on OpenShift using GitOps via the rhoso-gitops meta-chart.
6+
rh_products:
7+
- Red Hat OpenShift Container Platform
8+
- Red Hat OpenShift GitOps
9+
- Red Hat OpenStack Services on OpenShift
10+
industries:
11+
- General
12+
focus_areas:
13+
- DevSecOps
14+
aliases: /rhoso-gitops/
15+
# TODO(repo-move): update github and bugs URLs to validatedpatterns-sandbox/rhoso-gitops
16+
links:
17+
github: https://github.com/cjeanner/pattern-rhoso-gitops
18+
install: getting-started
19+
bugs: https://github.com/cjeanner/pattern-rhoso-gitops/issues
20+
feedback: https://docs.google.com/forms/d/e/1FAIpQLScI76b6tD1WyPu2-d_9CCVDr3Fu5jYERthqLKJDUGwqBg7Vcg/viewform
21+
---
22+
23+
:toc:
24+
:imagesdir: /images
25+
:_content-type: ASSEMBLY
26+
include::modules/comm-attributes.adoc[]
27+
28+
include::modules/rhoso-gitops/rhoso-gitops-about.adoc[leveloffset=+1]
29+
30+
include::modules/rhoso-gitops/rhoso-gitops-architecture.adoc[leveloffset=+1]
31+
32+
[id="next-steps_rhoso-gitops-index"]
33+
== Next steps
34+
35+
* link:getting-started[Deploy the pattern]
36+
* link:cluster-sizing[Review cluster sizing requirements]
37+
* link:configuration[Configure upstream pins and overrides]
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Cluster sizing
3+
weight: 20
4+
aliases: /rhoso-gitops/cluster-sizing/
5+
---
6+
7+
:toc:
8+
:imagesdir: /images
9+
:_content-type: ASSEMBLY
10+
include::modules/comm-attributes.adoc[]
11+
include::modules/rhoso-gitops/metadata-rhoso-gitops.adoc[]
12+
13+
include::modules/cluster-sizing-template.adoc[]
14+
15+
[id="rhoso-gitops-dataplane-hosts"]
16+
== Data plane host requirements
17+
18+
The hub cluster sizing tables above cover the {rh-ocp} nodes that host the
19+
{rh-rhoso-short} control plane. A full {rh-rhoso-short} deployment also
20+
requires separate {rhel-short} hosts for the data plane (compute nodes running
21+
dataplane elements).
22+
23+
Plan additional {rhel-short} capacity beyond the OpenShift worker sizing in
24+
`pattern-metadata.yaml`. Operator stages, sync order, and version pins are
25+
documented in the pattern repository
26+
link:https://github.com/cjeanner/pattern-rhoso-gitops/blob/main/VERSIONS.md[VERSIONS.md]
27+
file.
28+
29+
[id="next-steps_rhoso-gitops-cluster-sizing"]
30+
== Next steps
31+
32+
* link:../getting-started/[Deploy the pattern]
33+
* link:../configuration/[Configure upstream pins and overrides]
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Configuration
3+
weight: 30
4+
aliases: /rhoso-gitops/configuration/
5+
---
6+
7+
:toc:
8+
:imagesdir: /images
9+
:_content-type: ASSEMBLY
10+
include::modules/comm-attributes.adoc[]
11+
12+
include::modules/rhoso-gitops/rhoso-gitops-configuration.adoc[leveloffset=+1]
13+
14+
[id="next-steps_rhoso-gitops-configuration"]
15+
== Next steps
16+
17+
* link:../getting-started/[Deploy the pattern]
18+
* link:../troubleshooting/[Troubleshooting]
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Getting started
3+
weight: 10
4+
aliases: /rhoso-gitops/getting-started/
5+
---
6+
7+
:toc:
8+
:imagesdir: /images
9+
:_content-type: ASSEMBLY
10+
include::modules/comm-attributes.adoc[]
11+
12+
include::modules/rhoso-gitops/rhoso-gitops-deploying.adoc[leveloffset=+1]
13+
14+
[id="next-steps_rhoso-gitops-getting-started"]
15+
== Next steps
16+
17+
* link:../configuration/[Configure the pattern]
18+
* link:../cluster-sizing/[Review cluster sizing]
19+
* link:../troubleshooting/[Troubleshooting]
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: Troubleshooting
3+
weight: 40
4+
aliases: /rhoso-gitops/troubleshooting/
5+
---
6+
7+
:toc:
8+
:imagesdir: /images
9+
:_content-type: ASSEMBLY
10+
include::modules/comm-attributes.adoc[]
11+
12+
[id="troubleshooting-rhoso-gitops"]
13+
= Troubleshooting the {rhoso-gitops-pattern}
14+
15+
[id="rhoso-gitops-validate-pattern"]
16+
== Validating the pattern
17+
18+
Run pattern validation commands from the pattern repository root:
19+
20+
[source,terminal]
21+
----
22+
$ ./pattern.sh make validate-prereq
23+
$ ./pattern.sh make validate-schema
24+
$ ./pattern.sh make argo-healthcheck
25+
----
26+
27+
[id="rhoso-gitops-check-argocd"]
28+
== Checking Argo CD application status
29+
30+
The pattern uses two Argo CD namespaces. List applications in each:
31+
32+
[source,terminal]
33+
----
34+
$ oc get applications -n vp-gitops
35+
$ oc get applications -n openshift-gitops
36+
----
37+
38+
Inspect a child application that is out of sync or unhealthy:
39+
40+
[source,terminal]
41+
----
42+
$ oc describe application <application-name> -n openshift-gitops
43+
----
44+
45+
Use the Argo CD UI in the `openshift-gitops` namespace to review sync waves,
46+
resource health, and diff details for upstream overlays.
47+
48+
[id="rhoso-gitops-check-pods"]
49+
== Checking pod status
50+
51+
To verify that workloads deployed successfully, list pods that are not Running or
52+
Completed:
53+
54+
[source,terminal]
55+
----
56+
$ oc get pods -A | grep -v Running | grep -v Completed
57+
----
58+
59+
Review logs for a specific pod:
60+
61+
[source,terminal]
62+
----
63+
$ oc logs -n <namespace> <pod-name>
64+
----
65+
66+
[id="rhoso-gitops-known-issues"]
67+
== Known issues
68+
69+
* *`openstack-secrets` disabled* — The default pattern leaves
70+
`openstack-secrets` disabled because no Git path is configured (`path: TODO`).
71+
Enable it only after you configure secret wiring and a bootstrap credential
72+
out of band. See link:../configuration/#rhoso-gitops-secret-zero[Secret zero
73+
(bootstrap credential)].
74+
* *Upstream sync failures* — Confirm `targetRevision` and paths in
75+
`overrides/values-rhoso-gitops.yaml` match a tag or branch that exists in
76+
link:https://github.com/openstack-k8s-operators/gitops[openstack-k8s-operators/gitops].
77+
* *Operator install delays* — Infrastructure operators in `operator-dependencies`
78+
subscribe from the cluster catalog; allow time for OLM to resolve CSVs before
79+
later sync waves run.
80+
81+
For community support, open an issue in the
82+
link:https://github.com/cjeanner/pattern-rhoso-gitops/issues[pattern repository].
83+
84+
[id="next-steps_rhoso-gitops-troubleshooting"]
85+
== Next steps
86+
87+
* link:../getting-started/[Getting started]
88+
* link:../configuration/[Configuration]

modules/comm-attributes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,9 @@
115115
:kebab: image:kebab.png[title="Options menu"]
116116
:rh-openstack-first: Red{nbsp}Hat OpenStack Platform (RHOSP)
117117
:openstack-short: RHOSP
118+
:rh-rhoso: Red{nbsp}Hat OpenStack Services on OpenShift
119+
:rh-rhoso-short: RHOSO
120+
:rhoso-gitops-pattern: RHOSO GitOps pattern
118121
//Assisted Installer
119122
:ai-full: Assisted Installer
120123
:ai-version: 2.3
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// This file has been generated automatically from the pattern-metadata.yaml file
2+
// Do not edit manually!
3+
:metadata_version: 1.0
4+
:name: rhoso-gitops
5+
:description: Deploy Red Hat OpenStack Services on OpenShift (RHOSO) using GitOps via the rhoso-gitops meta-chart and upstream Kustomize example overlays.
6+
:pattern_version: 0.1.0
7+
:display_name: RHOSO GitOps
8+
:repo_url: https://github.com/cjeanner/pattern-rhoso-gitops
9+
:docs_repo_url: https://github.com/validatedpatterns/docs
10+
:issues_url: https://github.com/cjeanner/pattern-rhoso-gitops/issues
11+
:docs_url: https://github.com/cjeanner/pattern-rhoso-gitops#readme
12+
:tier: sandbox
13+
:owners: cjeanner
14+
:requirements_hub_compute_platform_aws_replicas: 3
15+
:requirements_hub_compute_platform_aws_type: m5.4xlarge
16+
:requirements_hub_compute_platform_azure_replicas: 3
17+
:requirements_hub_compute_platform_azure_type: Standard_D16s_v3
18+
:requirements_hub_compute_platform_gcp_replicas: 3
19+
:requirements_hub_compute_platform_gcp_type: n1-standard-16
20+
:requirements_hub_controlPlane_platform_aws_replicas: 3
21+
:requirements_hub_controlPlane_platform_aws_type: m5.2xlarge
22+
:requirements_hub_controlPlane_platform_azure_replicas: 3
23+
:requirements_hub_controlPlane_platform_azure_type: Standard_D8s_v3
24+
:requirements_hub_controlPlane_platform_gcp_replicas: 3
25+
:requirements_hub_controlPlane_platform_gcp_type: n1-standard-8
26+
:extra_features_hypershift_support: false
27+
:extra_features_spoke_support: false

0 commit comments

Comments
 (0)