Skip to content

Commit

Permalink
docs: improve javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
metacosm committed Sep 12, 2023
1 parent 15bb9bd commit 08a0f4a
Showing 1 changed file with 11 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ default ExecutorServiceManager getExecutorServiceManager() {
* resources are created/updated and match was change to use
* <a href="https://kubernetes.io/docs/reference/using-api/server-side-apply/">Server-Side
* Apply</a> (SSA) by default.
*
* <p>
* SSA based create/update can be still used with the legacy matching, just overriding the match
* method of Kubernetes Dependent Resource.
*
Expand All @@ -349,11 +349,16 @@ default boolean ssaBasedCreateUpdateMatchForDependentResources() {
}

/**
* There are certain resources where the intention is not use SSA in Kubernetes. Typical are
* ConfigMaps or Secrets. For these resources, if {@link KubernetesDependent#useSSA()} is not
* explicitly overriden for a dependent resource instance SSA will not be used, event if in
* general SSA is used for Dependent Resources, see
* {@link #ssaBasedCreateUpdateMatchForDependentResources()}.
* Returns the set of default resources for which Server-Side Apply (SSA) will not be used, even
* if it is the default behavior for dependent resources as specified by
* {@link #ssaBasedCreateUpdateMatchForDependentResources()}. The exception to this is in the case
* where the use of SSA is explicitly enabled on the dependent resource directly using
* {@link KubernetesDependent#useSSA()}.
* <p>
* By default, SSA is disabled for {@link ConfigMap} and {@link Secret} resources.
*
* @return The set of resource types for which SSA will not be used
* @since 4.4.0
*/
default Set<Class<? extends HasMetadata>> defaultNonSSAResource() {
return Set.of(ConfigMap.class, Secret.class);
Expand Down

0 comments on commit 08a0f4a

Please sign in to comment.