docs

Signed-off-by: Attila Mészáros <csviri@gmail.com>

Author: csviri

docs/documentation/v5-0-migration.md

@@ -54,4 +54,5 @@ permalink: /docs/v5-0-migration
 9. `Operator.installShutdownHook()` has been removed, use `Operator.installShutdownHook(Duration)` instead
 10. Automated observed generation handling feature was removed, since it is trivial to do manually and
     since it cannot be done automatically in all cases with SSA, having different behavior for SSA and non-SSA
-    usage would be confusing.
+    usage would be confusing. See sample how to do observed generation handling manually 
+    [here](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/manualobservedgeneration/ManualObservedGenerationReconciler.java).

operator-framework/src/test/java/io/javaoperatorsdk/operator/ManualObservedGenerationIT.java

@@ -0,0 +1,61 @@
+package io.javaoperatorsdk.operator;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
+import io.javaoperatorsdk.operator.sample.manualobservedgeneration.ManualObservedGenerationCustomResource;
+import io.javaoperatorsdk.operator.sample.manualobservedgeneration.ManualObservedGenerationReconciler;
+import io.javaoperatorsdk.operator.sample.manualobservedgeneration.ManualObservedGenerationSpec;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
+public class ManualObservedGenerationIT {
+
+  public static final String RESOURCE_NAME = "test1";
+  @RegisterExtension
+  LocallyRunOperatorExtension extension =
+      LocallyRunOperatorExtension.builder().withReconciler(new ManualObservedGenerationReconciler())
+          .build();
+
+
+
+  @Test
+  void observedGenerationUpdated() {
+    extension.create(testResource());
+
+    await().untilAsserted(() -> {
+      var r = extension.get(ManualObservedGenerationCustomResource.class, RESOURCE_NAME);
+      assertThat(r).isNotNull();
+      assertThat(r.getStatus().getObservedGeneration()).isEqualTo(1);
+      assertThat(r.getStatus().getObservedGeneration()).isEqualTo(r.getMetadata().getGeneration());
+    });
+
+    var changed = testResource();
+    changed.getSpec().setValue("changed value");
+    extension.replace(changed);
+
+    await().untilAsserted(() -> {
+      var r = extension.get(ManualObservedGenerationCustomResource.class, RESOURCE_NAME);
+      assertThat(r).isNotNull();
+      assertThat(r.getStatus().getObservedGeneration()).isEqualTo(2);
+      assertThat(r.getStatus().getObservedGeneration()).isEqualTo(r.getMetadata().getGeneration());
+    });
+
+  }
+
+
+  ManualObservedGenerationCustomResource testResource() {
+    var res = new ManualObservedGenerationCustomResource();
+    res.setMetadata(new ObjectMetaBuilder()
+        .withName(RESOURCE_NAME)
+        .build());
+    res.setSpec(new ManualObservedGenerationSpec());
+    res.getSpec().setValue("Initial Value");
+    return res;
+  }
+
+
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/manualobservedgeneration/ManualObservedGenerationCustomResource.java

@@ -0,0 +1,15 @@
+package io.javaoperatorsdk.operator.sample.manualobservedgeneration;
+
+import io.fabric8.kubernetes.api.model.Namespaced;
+import io.fabric8.kubernetes.client.CustomResource;
+import io.fabric8.kubernetes.model.annotation.Group;
+import io.fabric8.kubernetes.model.annotation.ShortNames;
+import io.fabric8.kubernetes.model.annotation.Version;
+
+@Group("sample.javaoperatorsdk")
+@Version("v1")
+@ShortNames("mog")
+public class ManualObservedGenerationCustomResource
+    extends CustomResource<ManualObservedGenerationSpec, ManualObservedGenerationStatus>
+    implements Namespaced {
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/manualobservedgeneration/ManualObservedGenerationReconciler.java

@@ -0,0 +1,48 @@
+package io.javaoperatorsdk.operator.sample.manualobservedgeneration;
+
+import java.util.Objects;
+import java.util.concurrent.atomic.AtomicInteger;
+
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.api.reconciler.*;
+
+@ControllerConfiguration
+public class ManualObservedGenerationReconciler
+    implements Reconciler<ManualObservedGenerationCustomResource> {
+
+  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
+
+  @Override
+  public UpdateControl<ManualObservedGenerationCustomResource> reconcile(
+      ManualObservedGenerationCustomResource resource,
+      Context<ManualObservedGenerationCustomResource> context) {
+    numberOfExecutions.addAndGet(1);
+    var resourceForStatusPatch = resourceForStatusPatch(resource);
+    if (!Objects.equals(resource.getMetadata().getGeneration(),
+        resourceForStatusPatch.getStatus().getObservedGeneration())) {
+      resourceForStatusPatch.getStatus()
+          .setObservedGeneration(resource.getMetadata().getGeneration());
+      return UpdateControl.patchStatus(resourceForStatusPatch);
+    } else {
+      return UpdateControl.noUpdate();
+    }
+  }
+
+  private ManualObservedGenerationCustomResource resourceForStatusPatch(
+      ManualObservedGenerationCustomResource original) {
+    var res = new ManualObservedGenerationCustomResource();
+    res.setMetadata(new ObjectMetaBuilder()
+        .withName(original.getMetadata().getName())
+        .withNamespace(original.getMetadata().getNamespace())
+        .build());
+    res.setStatus(original.getStatus());
+    if (res.getStatus() == null) {
+      res.setStatus(new ManualObservedGenerationStatus());
+    }
+    return res;
+  }
+
+  public int getNumberOfExecutions() {
+    return numberOfExecutions.get();
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/manualobservedgeneration/ManualObservedGenerationSpec.java

@@ -0,0 +1,14 @@
+package io.javaoperatorsdk.operator.sample.manualobservedgeneration;
+
+public class ManualObservedGenerationSpec {
+
+  private String value;
+
+  public String getValue() {
+    return value;
+  }
+
+  public void setValue(String value) {
+    this.value = value;
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/manualobservedgeneration/ManualObservedGenerationStatus.java

@@ -0,0 +1,14 @@
+package io.javaoperatorsdk.operator.sample.manualobservedgeneration;
+
+public class ManualObservedGenerationStatus {
+
+  private long observedGeneration;
+
+  public long getObservedGeneration() {
+    return observedGeneration;
+  }
+
+  public void setObservedGeneration(long observedGeneration) {
+    this.observedGeneration = observedGeneration;
+  }
+}