Skip to content

docs: improve javadoc for ResourceOperation on resource cloning and matching #3502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csviri merged 1 commit into from
Jul 16, 2026
Merged

docs: improve javadoc for ResourceOperation on resource cloning and matching #3502

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions ...ork-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ResourceOperations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,15 @@
* from the desired one, thus also reducing the number of requests made against the Kubernetes API
* server.
*
* <p><strong>Matching against cached resources.</strong> When matching the actual resource (in most
* cases read from the cache) against the desired one for secondary resources, the matching must be
* done on a <em>cloned</em> version of the actual resource. Secondary resources are not cloned by
* default when read from the cache (see {@link
* io.javaoperatorsdk.operator.api.config.ConfigurationService#cloneSecondaryResourcesWhenGettingFromCache()}),
Comment thread
csviri marked this conversation as resolved.
* so mutating the resource obtained from the cache while matching would also mutate the copy stored
* in the cache. Either clone the resource explicitly before matching, or enable {@link
* io.javaoperatorsdk.operator.api.config.ConfigurationService#cloneSecondaryResourcesWhenGettingFromCache()}.
*
* @param <P> the primary resource type on which this object operates
*/
public class ResourceOperations<P extends HasMetadata> {
Expand Down
Loading