Skip to content

Commit cace2be

Browse files
authored
docs: primary to secondary mapper customization for dependent resources (#1186)
1 parent 4f7daa4 commit cace2be

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/documentation/dependent-resources.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,9 +279,19 @@ See the full source code of
279279
sample [here](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageStandaloneDependentsReconciler.java)
280280
.
281281

282-
## Other Dependent Resource features
283282

284-
### Caching and Event Handling in [KubernetesDependentResource](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResource.java)
283+
## Default `PrimaryToSecondaryMapper` And How to Override
284+
285+
[`KubernetesDependentResource`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java)
286+
automatically maps secondary resource to a primary by owner reference. This behavior can be customized by implementing
287+
[`PrimaryToSecondaryMapper`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/SecondaryToPrimaryMapper.java) by the dependent resource.
288+
.
289+
290+
See sample in one of the integration tests [here](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/primaryindexer/DependentPrimaryIndexerTestReconciler.java#L25-L25).
291+
292+
## Other Dependent Resource Features
293+
294+
### Caching and Event Handling in [KubernetesDependentResource](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java)
285295

286296
1. When a Kubernetes resource is created or updated the related informer (more precisely the `InformerEventSource`),
287297
eventually will receive an event and will cache the up-to-date resource. However, there might be a small time window

0 commit comments

Comments
 (0)