Skip to content

Commit 5cac495

Browse files
cjeannercjeanner
authored
docs(example): align example dirs with readme apps (#42)
Add openstack-networks and openstack-controlplane overlays (split from the former controlplane bundle), openstack-dataplane rename, and placeholders for openstack-operator and openstack-operator-cr. Document prerequisites in example/README.md. Related: https://redhat.atlassian.net/browse/OSPRH-28266 AI-Assist: Cursor; model=Composer; mode=agent; origin=cursor Made-with: Cursor
1 parent 70712c5 commit 5cac495

8 files changed

Lines changed: 89 additions & 5 deletions

File tree

‎example/README.md‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# Examples
22

3-
Shows how to consume the provided components. Run `kustomize build` to see the
4-
result in both [controplane](./controlplane) and [dataplane](./dataplane)
5-
directories to see the imported resources, and the applied sync-wave annotations.
3+
Sample overlays that consume this repository’s Kustomize components. Directory names match
4+
the **###** headings under *Application responsibilities and content* in the root
5+
`README.md`.
6+
7+
Run `kustomize build` in each directory to render manifests (and sync-wave annotations
8+
where the overlay includes `components/argocd/annotations`).
9+
10+
## Applications (per root README)
11+
12+
| Directory | Role |
13+
| --------- | ---- |
14+
| [openstack-operator](./openstack-operator/) | Foundational OpenStack operators, namespaces, subscription, install-plan approval (placeholder until a component exists). |
15+
| [openstack-operator-cr](./openstack-operator-cr/) | Main OpenStack custom resource (placeholder until a component exists). |
16+
| [openstack-networks](./openstack-networks/) | Underlying networks: NNCP, NAD, NetConfig, MetalLB pools / advertisements, etc. |
17+
| [openstack-controlplane](./openstack-controlplane/) | `OpenStackControlPlane` and optional watcher service (networking is a separate overlay). |
18+
| [openstack-dataplane](./openstack-dataplane/) | Data plane node set and deployment. |
19+
20+
## Prerequisites (not named in *Application responsibilities*)
21+
22+
These are called out separately in the root `README.md` (for example *What’s NOT covered
23+
by ArgoCD applications yet* or operator install procedures).
24+
25+
| Directory | Role |
26+
| --------- | ---- |
27+
| [dependencies](./dependencies/) | OLM-related dependencies from the architecture repo (MetalLB, NMState, cert-manager, etc. are not modeled as Argo CD Applications here yet). |
28+
29+
To deploy the Vault Secrets Operator via Argo CD, see the root `README.md` and
30+
`applications/vault-secrets-operator.yaml`.

example/controlplane/kustomization.yaml renamed to example/openstack-controlplane/kustomization.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ kind: Kustomization
55
components:
66
# Remote refs (for CI/ArgoCD):
77
- https://github.com/openstack-k8s-operators/gitops/components/argocd/annotations?ref=v0.1.0
8-
- https://github.com/openstack-k8s-operators/gitops/components/rhoso/controlplane?ref=v0.1.0
8+
- https://github.com/openstack-k8s-operators/gitops/components/rhoso/controlplane/controlplane?ref=v0.1.0
99
- https://github.com/openstack-k8s-operators/gitops/components/rhoso/controlplane/services/watcher?ref=v0.1.0
1010
# Local paths (for "kustomize build" testing):
1111
# - ../../components/argocd/annotations
12-
# - ../../components/rhoso/controlplane
12+
# - ../../components/rhoso/controlplane/controlplane
1313
# - ../../components/rhoso/controlplane/services/watcher
1414

1515
# Add needed patches according to your infrastructure

example/dataplane/kustomization.yaml renamed to example/openstack-dataplane/kustomization.yaml

File renamed without changes.

‎example/openstack-networks/kustomization.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
apiVersion: kustomize.config.k8s.io/v1beta1
3+
kind: Kustomization
4+
5+
components:
6+
# Remote refs (for CI/ArgoCD):
7+
- https://github.com/openstack-k8s-operators/gitops/components/argocd/annotations?ref=v0.1.0
8+
- https://github.com/openstack-k8s-operators/gitops/components/rhoso/controlplane/networking?ref=v0.1.0
9+
# Local paths (for "kustomize build" testing):
10+
# - ../../components/argocd/annotations
11+
# - ../../components/rhoso/controlplane/networking
12+
13+
# Add needed patches according to your infrastructure

‎example/openstack-operator-cr/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# openstack-operator-cr
2+
3+
Placeholder overlay for the **openstack-operator-cr** application described in the root
4+
`README.md` (*Application responsibilities and content*).
5+
6+
There is no matching component under `components/rhoso/` yet. Replace this directory's
7+
`kustomization.yaml` with real `components` / `resources` when a slice is added.
8+
9+
Upstream context: main OpenStack custom resource in the `openstack-operators`
10+
namespace.

‎example/openstack-operator-cr/kustomization.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
apiVersion: kustomize.config.k8s.io/v1beta1
3+
kind: Kustomization
4+
5+
resources: []
6+
7+
# No gitops component yet for this slice. See README.md.
8+
# Future: add components (remote refs and local paths), for example:
9+
# components:
10+
# - https://github.com/openstack-k8s-operators/gitops/components/argocd/annotations?ref=TAG
11+
# - https://github.com/openstack-k8s-operators/gitops/components/rhoso/...?ref=TAG
12+
# Local paths (for "kustomize build" testing):
13+
# - ../../components/argocd/annotations

‎example/openstack-operator/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# openstack-operator
2+
3+
Placeholder overlay for the **openstack-operator** application described in the root
4+
`README.md` (*Application responsibilities and content*).
5+
6+
There is no matching component under `components/rhoso/` yet. Replace this directory's
7+
`kustomization.yaml` with real `components` / `resources` when a slice is added.
8+
9+
Upstream context: Red Hat documentation *Installing and preparing the OpenStack
10+
operator* (namespaces, subscription, install-plan approval job).

‎example/openstack-operator/kustomization.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
apiVersion: kustomize.config.k8s.io/v1beta1
3+
kind: Kustomization
4+
5+
resources: []
6+
7+
# No gitops component yet for this slice. See README.md.
8+
# Future: add components (remote refs and local paths), for example:
9+
# components:
10+
# - https://github.com/openstack-k8s-operators/gitops/components/argocd/annotations?ref=TAG
11+
# - https://github.com/openstack-k8s-operators/gitops/components/rhoso/...?ref=TAG
12+
# Local paths (for "kustomize build" testing):
13+
# - ../../components/argocd/annotations

0 commit comments

Comments
 (0)