Skip to content

Commit 0c0c472

Browse files
committed
Update reference.md
1 parent cbada4a commit 0c0c472

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/reference.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The `resources` section is a list of resources to be reconciled. It has several
2020
- **`name`** - is a mandatory attribute. The resource is referenced by this name from other places, typically other resource templates and `JSCondition`.
2121
If it is used in a `JSCondition` the `name` must be a valid JavaScript variable name.
2222
- **`resource`** - is the desired state of the resource applied by default using Server Side Apply. The resource is templated using
23-
[Qute Templating Engine](https://quarkus.io/guides/qute-reference), other resources can be referenced from the templates, see below.
23+
[qute templating engine](https://quarkus.io/guides/qute-reference), other resources can be referenced from the templates, see below.
2424
There is a restriction, that the managed resource is namespaced, and the namespace is always the same as the namespace of the `Glue`
2525
(and/or parent for `GlueOperator`), so the `namespace` field in resource **metadata should not be specified**.
2626
- **`dependsOn`** - is a list of names of other managed resources (not related resources). The resource is not reconciled until all the resources
@@ -32,18 +32,20 @@ The `resources` section is a list of resources to be reconciled. It has several
3232
- **`readyPostCondition`** - condition to check if the resource is considered to be ready. If a resource is ready all the resources, which depend on it
3333
can proceed in reconciliation.
3434

35-
#### Reconciliation
35+
### Related resources
3636

37+
### Referencing other resources
3738

39+
### Built-in conditions
3840

39-
#### Referencing Other Resources
41+
### Reconciliation notes
4042

41-
#### Conditions
42-
43-
44-
### Related Resources
43+
The reconciliation is triggered either on a change of the `Glue` or any managed or related resources.
4544

45+
On every reconciliation, each managed resource is reconciled, and if a resource is updated, it is added to a cache, so it is available for templating
46+
for a resource that depends on it.
4647

48+
The `DependentResource` implementation of JOSDK makes all kinds of optimizations on the reconciliation which are utilized (or will be also here).
4749

4850
## [GlueOperator resource](https://github.com/csviri/resource-glue-operator/releases/latest/download/glueoperators.io.csviri.operator.resourceglue-v1.yml)
4951

@@ -75,7 +77,7 @@ resources containing the same resource type.
7577
The templating and some of the Javascript condition is probably the most time-consuming and resource-intensive part which will
7678
be continuously improved in the follow-up releases.
7779

78-
## Current Limitations
80+
## Current limitations
7981

8082
Note that none of the limitations are unsolvable, and will be continuously removed in the coming releases.
8183

@@ -86,7 +88,7 @@ Note that none of the limitations are unsolvable, and will be continuously remov
8688
Due to a bug in fabric8 client, after that is fixed, this is trivial to fix too:
8789
https://github.com/fabric8io/kubernetes-client/issues/5729~~
8890

89-
## Related Documents
91+
## Related documents
9092

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

0 commit comments

Comments
 (0)