Skip to content

Commit e89c09d

Browse files
committed
feat(example): add openstack-operator-cr overlay
Add minimal OpenStack CR and kustomization under example/openstack-operator-cr. Update example READMEs, link from openstack-operator, and point to the overlay from the root README. AI-Assist: Cursor; model=auto; mode=agent; origin=cursor Made-with: Cursor
1 parent c9d2c18 commit e89c09d

6 files changed

Lines changed: 32 additions & 17 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ Creates the main OpenStack custom resource that defines the overall OpenStack de
8989

9090
#### Key resources
9191

92-
* **OpenStack CR:** Primary configuration object in `openstack-operators` namespace
92+
* **OpenStack CR:** Primary configuration object in `openstack-operators` namespace
93+
* **Example overlay:** [`example/openstack-operator-cr/`](example/openstack-operator-cr/)
9394

9495
### openstack-networks
9596

example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ where the overlay includes `components/argocd/annotations`).
1212
| Directory | Role |
1313
| --------- | ---- |
1414
| [openstack-operator](./openstack-operator/) | Foundational OpenStack operators: CDN catalog + pinned CSV, OLM subscription from `architecture` `olm-openstack-subscriptions`, InstallPlan approval Job, RBAC. |
15-
| [openstack-operator-cr](./openstack-operator-cr/) | Main OpenStack custom resource (placeholder until a component exists). |
15+
| [openstack-operator-cr](./openstack-operator-cr/) | Main `OpenStack` custom resource in `openstack-operators`. |
1616
| [openstack-networks](./openstack-networks/) | Underlying networks: NNCP, NAD, NetConfig, MetalLB pools / advertisements, etc. |
1717
| [openstack-controlplane](./openstack-controlplane/) | `OpenStackControlPlane` and optional watcher service (networking is a separate overlay). |
1818
| [openstack-dataplane](./openstack-dataplane/) | Data plane node set and deployment. |
Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
# openstack-operator-cr
22

3-
Placeholder overlay for the **openstack-operator-cr** application described in the root
4-
`README.md` (*Application responsibilities and content*).
3+
Example overlay for the **openstack-operator-cr** application described in the root
4+
`README.md` under *Application responsibilities and content*.
55

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.
6+
This directory applies a minimal **OpenStack** custom resource in the
7+
`openstack-operators` namespace. It is the primary configuration object for the overall
8+
OpenStack deployment on the cluster (see product documentation for full `spec` options).
89

9-
Upstream context: main OpenStack custom resource in the `openstack-operators`
10-
namespace.
10+
## Render
11+
12+
From this directory:
13+
14+
```shell
15+
kustomize build .
16+
```
17+
18+
## Layout
19+
20+
| File | Role |
21+
| ---- | ---- |
22+
| `openstack.yaml` | `OpenStack` CR (`operator.openstack.org/v1beta1`) |
23+
| `kustomization.yaml` | Sets namespace and includes the CR |

example/openstack-operator-cr/kustomization.yaml

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,7 @@
22
apiVersion: kustomize.config.k8s.io/v1beta1
33
kind: Kustomization
44

5-
resources: []
5+
namespace: openstack-operators
66

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
7+
resources:
8+
- openstack.yaml
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
apiVersion: operator.openstack.org/v1beta1
3+
kind: OpenStack
4+
metadata:
5+
name: openstack
6+
namespace: openstack-operators

example/openstack-operator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,5 @@ Clusters must be able to pull images from `registry.redhat.io` (pull secret / gl
4949
## Related
5050

5151
- [`components/utilities/`](../../components/utilities/) for shared helper components (including InstallPlan approval).
52-
- `openstack-operator-cr` example: main `OpenStack` CR (separate overlay).
52+
- [`openstack-operator-cr`](../openstack-operator-cr/): main `OpenStack` CR (separate overlay).
5353
- `example/dependencies` for other OLM-related dependencies (MetalLB, NMState, cert-manager, etc.).

0 commit comments

Comments
 (0)