Skip to content

Commit 8aab1cf

Browse files
authored
docs: additional docs for migration of SSA (#1962)
* docs: additional docs for migration of SSA * docs
1 parent 1042fc5 commit 8aab1cf

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

Diff for: docs/documentation/v4-4-migration.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,17 @@ see those
7373
in [ConfigurationService](https://github.com/java-operator-sdk/java-operator-sdk/blob/e95f9c8a8b8a8561c9a735e60fc5d82b7758df8e/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java#L268-L289)
7474

7575
Note that it is possible to override the related methods/behavior on class level when extending
76-
the `KubernetesDependentResource`.
76+
the `KubernetesDependentResource`.
77+
78+
### Migration from plain Update/Create to SSA Based Patch
79+
80+
Migration to SSA might not be trivial based on the uses cases and the type of managed resources.
81+
In general this is not a solved problem is Kubernetes. The Java Operator SDK Team tries to follow
82+
the related issues, but in terms of implementation this is not something that the framework explicitly
83+
supports. Thus, no code is added that tries to mitigate related issues. Users should thoroughly
84+
test the migration, and even consider not to migrate in some cases (see feature flags above).
85+
86+
See some related issues in [kubernetes](https://github.com/kubernetes/kubernetes/issues/118725) or
87+
[here](https://github.com/keycloak/keycloak/pull). Please create related issue in JOSDK if any.
88+
89+

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java

+2-4
Original file line numberDiff line numberDiff line change
@@ -334,8 +334,7 @@ default ExecutorServiceManager getExecutorServiceManager() {
334334
* Resources when set to {@code false}. The default approach how these resources are
335335
* created/updated was change to use
336336
* <a href="https://kubernetes.io/docs/reference/using-api/server-side-apply/">Server-Side
337-
* Apply</a> (SSA) by default. Note that the legacy approach, and this setting, might be removed
338-
* in the future.
337+
* Apply</a> (SSA) by default.
339338
*
340339
* @since 4.4.0
341340
*/
@@ -347,8 +346,7 @@ default boolean ssaBasedCreateUpdateForDependentResources() {
347346
* Allows to revert to the 4.3 generic matching algorithm for Kubernetes Dependent Resources when
348347
* set to {@code false}. Version 4.4 introduced a new generic matching algorithm for Kubernetes
349348
* Dependent Resources which is quite complex. As a consequence, we introduced this setting to
350-
* allow folks to revert to the previous matching algorithm if needed. Note, however, that the
351-
* legacy algorithm, and this setting, might be removed in the future.
349+
* allow folks to revert to the previous matching algorithm if needed.
352350
*
353351
* @since 4.4.0
354352
*/

0 commit comments

Comments
 (0)