Skip to content

Commit 94755b2

Browse files
committed
docs update
Signed-off-by: Attila Mészáros <[email protected]>
1 parent 6392b75 commit 94755b2

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

docs/reference.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,17 @@ The `DependentResource` implementation of JOSDK makes all kinds of optimizations
8484

8585
## [GlueOperator resource](https://github.com/csviri/kubernetes-glue-operator/releases/latest/download/glueoperators.glue-v1.yml)
8686

87-
The specs of `GlueOperator` are almost identical to `Glue`, it just adds one additional attribute **`parent`**,
88-
which has the following sub-attributes:
89-
- **`apiVersion`** and **`kind`** - specifies the resources to reconciler according to the spec.
90-
Targets are usually custom resources but not necessarily, it also works with built-in Kubernetes
91-
resources.
92-
- **`labelSelector`** - an optional label selector for the target resources
87+
The specs of `GlueOperator` are almost identical to `Glue`, it just adds some additional attributes:
88+
89+
- **`parent`** - specifies the resources handled by the operator. Targets are usually custom resources but not necessarily,
90+
it also works with built-in Kubernetes resources. With the following sub-attributes:
91+
- **`apiVersion`** and **`kind`** - of the target custom resources.
92+
- **`labelSelector`** - optional label selector for the target resources.
93+
- **`clusterScoped`** - optional boolean value, if the parent resource is cluster scoped. Default is `false`.
94+
- **`glueMetadata`** - you can customize the `Glue` resource created for each parent resource.
95+
This is especially important when the parent is a cluster scoped resource. Using this
96+
you can specify the **`name`** and **`namespace`** of the created `Glue`.
97+
See usage on the sample [secret-copy-operator](https://github.com/csviri/kubernetes-glue-operator/blob/main/src/test/resources/sample/secretcopy/secret-copy.operator.yaml#L10-L12).
9398

9499
See minimal `GlueOperator` [here](https://github.com/csviri/kubernetes-glue-operator/blob/main/src/test/resources/glueoperator/SimpleGlueOperator.yaml).
95100

0 commit comments

Comments
 (0)