Skip to content

Commit 108cb82

Browse files
committed
docs update
Signed-off-by: Attila Mészáros <[email protected]>
1 parent 261e741 commit 108cb82

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/content/en/docs/documentation/dependent-resource-and-workflows/dependent-resources.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -369,8 +369,12 @@ or we can use a matcher based SSA in most of the cases if the resource is manage
369369
### Selecting the target resource
370370

371371
Unfortunately this is not true for external resources. So to make sure we are selecting
372-
the target resources from an event source, we provide a [mechanism](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractExternalDependentResource.java#L114-L138) that helps with that logic.
373-
Your POJO representing an external resource can implement [`ResourceIDProvider`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ResourceIDProvider.java) :
372+
the target resources from an event source, we provide a [mechanism](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractExternalDependentResource.java#L133-L147) that helps with that logic.
373+
[`ResourceIDMapper`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ResourceIDMapper.java)
374+
maps the resource to and ID and the ID of desired and actual resource is checked for equality.
375+
376+
Your POJO representing an external resource can implement [`ResourceIDProvider`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ResourceIDProvider.java).
377+
The default `ResourceIDMapper` implementation works on top of resource which implement `ResourceIDProvider`:
374378

375379
```java
376380

@@ -380,8 +384,7 @@ public interface ResourceIDProvider<T> {
380384
}
381385
```
382386

383-
That will provide an ID, what is used to check for equality for desired state and resources from event source caches.
384-
Not that if some reason this mechanism does not suit for you, you can simply
387+
Note that if those approaches does not work for your use case, you can simply
385388
override [`selectTargetSecondaryResource`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractExternalDependentResource.java)
386389
method.
387390

0 commit comments

Comments
 (0)