Skip to content

Commit 012e8f0

Browse files
committed
Update reference.md
1 parent c1dba98 commit 012e8f0

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/reference.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ types - usually but not necessarily custom resources - watched.
8686

8787
See minimal `GlueOperator` [here](https://github.com/csviri/resource-workflow-operator/blob/main/src/test/resources/resourceglueoperator/Templating.yaml).
8888

89-
## Deployment
89+
## Deploying `resource-glue-operator`
9090

9191
Implementation is using [Quarkus Operator SDK (QOSDK)](https://github.com/quarkiverse/quarkus-operator-sdk),
9292
the default [configuration options](https://docs.quarkiverse.io/quarkus-operator-sdk/dev/includes/quarkus-operator-sdk.html)
@@ -125,6 +125,15 @@ Note that none of the limitations are unsolvable, and will be continuously remov
125125
Due to a bug in fabric8 client, after that is fixed, this is trivial to fix too:
126126
https://github.com/fabric8io/kubernetes-client/issues/5729~~
127127

128+
## Samples:
129+
130+
1. [WebPage](https://github.com/csviri/resource-glue-operator/tree/main/src/test/resources/sample/webpage) `GlueOperator`, serves a static website from the cluster.
131+
To achieve this, it creates three resources a `Deployment` running Nginx, a `ConfigMap` that contains the HTML file an mounted to nginx, a `Service` and an optional `Ingress`
132+
to expose the static web page.
133+
3. [Muatation Hook Deployment](https://github.com/csviri/resource-workflow-operator/tree/main/src/test/resources/sample/mutation), described on the project home page.
134+
4. [Additional `Glue` samples](https://github.com/csviri/resource-workflow-operator/tree/main/src/test/resources/resourceglue), note that these are used for integration testing.
135+
5. [Additional `GlueOperator` samples](https://github.com/csviri/resource-workflow-operator/tree/main/src/test/resources/resourceglueoperator), also used for integration testing.
136+
128137
## Related documents
129138

130139
- [Dependent Resources documentation in Java Operator SDK](https://javaoperatorsdk.io/docs/dependent-resources)

0 commit comments

Comments
 (0)