operator-framework · csviri · Feb 21, 2023 · Feb 15, 2023 · Feb 15, 2023 · Feb 16, 2023
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java
@@ -91,7 +91,7 @@ public void installShutdownHook() {
 
   /**
    * Adds a shutdown hook that automatically calls {@link #stop()} when the app shuts down. Note
-   * that graceful shutdown is usually not needed, but your {@link Reconciler} implementations might
+   * that graceful shutdown is usually not needed, but some {@link Reconciler} implementations might
    * require it.
    * <p>
    * Note that you might want to tune "terminationGracePeriodSeconds" for the Pod running the

diff --git a/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/Utils.java b/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/Utils.java
@@ -2,60 +2,62 @@
 
 import io.fabric8.kubernetes.api.model.networking.v1.Ingress;
 import io.javaoperatorsdk.operator.api.reconciler.ErrorStatusUpdateControl;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
+import io.javaoperatorsdk.operator.sample.customresource.WebPageStatus;
 
 import static io.javaoperatorsdk.operator.ReconcilerUtils.loadYaml;
 
 public class Utils {
 
   private Utils() {}
 
-  static WebPageStatus createStatus(String configMapName) {
+  public static WebPageStatus createStatus(String configMapName) {
     WebPageStatus status = new WebPageStatus();
     status.setHtmlConfigMap(configMapName);
     status.setAreWeGood(true);
     status.setErrorMessage(null);
     return status;
   }
 
-  static String configMapName(WebPage nginx) {
+  public static String configMapName(WebPage nginx) {
     return nginx.getMetadata().getName() + "-html";
   }
 
-  static String deploymentName(WebPage nginx) {
+  public static String deploymentName(WebPage nginx) {
     return nginx.getMetadata().getName();
   }
 
-  static String serviceName(WebPage webPage) {
+  public static String serviceName(WebPage webPage) {
     return webPage.getMetadata().getName();
   }
 
-  static ErrorStatusUpdateControl<WebPage> handleError(WebPage resource, Exception e) {
+  public static ErrorStatusUpdateControl<WebPage> handleError(WebPage resource, Exception e) {
     resource.getStatus().setErrorMessage("Error: " + e.getMessage());
     return ErrorStatusUpdateControl.updateStatus(resource);
   }
 
-  static void simulateErrorIfRequested(WebPage webPage) throws ErrorSimulationException {
+  public static void simulateErrorIfRequested(WebPage webPage) throws ErrorSimulationException {
     if (webPage.getSpec().getHtml().contains("error")) {
       // special case just to showcase error if doing a demo
       throw new ErrorSimulationException("Simulating error");
     }
   }
 
-  static boolean isValidHtml(WebPage webPage) {
+  public static boolean isValidHtml(WebPage webPage) {
     // very dummy html validation
     var lowerCaseHtml = webPage.getSpec().getHtml().toLowerCase();
     return lowerCaseHtml.contains("<html>") && lowerCaseHtml.contains("</html>");
   }
 
-  static WebPage setInvalidHtmlErrorMessage(WebPage webPage) {
+  public static WebPage setInvalidHtmlErrorMessage(WebPage webPage) {
     if (webPage.getStatus() == null) {
       webPage.setStatus(new WebPageStatus());
     }
     webPage.getStatus().setErrorMessage("Invalid html.");
     return webPage;
   }
 
-  static Ingress makeDesiredIngress(WebPage webPage) {
+  public static Ingress makeDesiredIngress(WebPage webPage) {
     Ingress ingress = loadYaml(Ingress.class, Utils.class, "ingress.yaml");
     ingress.getMetadata().setName(webPage.getMetadata().getName());
     ingress.getMetadata().setNamespace(webPage.getMetadata().getNamespace());

diff --git a/...src/main/java/io/javaoperatorsdk/operator/sample/WebPageDependentsWorkflowReconciler.java b/...src/main/java/io/javaoperatorsdk/operator/sample/WebPageDependentsWorkflowReconciler.java
@@ -21,6 +21,8 @@
 import io.javaoperatorsdk.operator.processing.dependent.workflow.Workflow;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.WorkflowBuilder;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
+import io.javaoperatorsdk.operator.sample.dependentresource.*;
 
 import static io.javaoperatorsdk.operator.sample.Utils.createStatus;
 import static io.javaoperatorsdk.operator.sample.Utils.handleError;

diff --git a/.../src/main/java/io/javaoperatorsdk/operator/sample/WebPageManagedDependentsReconciler.java b/.../src/main/java/io/javaoperatorsdk/operator/sample/WebPageManagedDependentsReconciler.java
@@ -3,6 +3,8 @@
 import io.fabric8.kubernetes.api.model.ConfigMap;
 import io.javaoperatorsdk.operator.api.reconciler.*;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
+import io.javaoperatorsdk.operator.sample.dependentresource.*;
 
 import static io.javaoperatorsdk.operator.sample.Utils.createStatus;
 import static io.javaoperatorsdk.operator.sample.Utils.handleError;

diff --git a/...e-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageOperator.java b/...e-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageOperator.java
@@ -9,6 +9,8 @@
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
 import io.javaoperatorsdk.operator.Operator;
+import io.javaoperatorsdk.operator.sample.probes.LivenessHandler;
+import io.javaoperatorsdk.operator.sample.probes.StartupHandler;
 
 import com.sun.net.httpserver.HttpServer;
 
@@ -19,6 +21,10 @@ public class WebPageOperator {
   private static final Logger log = LoggerFactory.getLogger(WebPageOperator.class);
 
 
+  /**
+   * Based on env variables a different flavor of Reconciler is used, showcasing how the same logic
+   * can be implemented using the low level and higher level APIs.
+   */
   public static void main(String[] args) throws IOException {
     log.info("WebServer Operator starting!");
 

diff --git a/...operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java b/...operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java
@@ -29,6 +29,7 @@
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimited;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
 
 import static io.javaoperatorsdk.operator.sample.Utils.configMapName;
 import static io.javaoperatorsdk.operator.sample.Utils.createStatus;

diff --git a/...c/main/java/io/javaoperatorsdk/operator/sample/WebPageStandaloneDependentsReconciler.java b/...c/main/java/io/javaoperatorsdk/operator/sample/WebPageStandaloneDependentsReconciler.java
@@ -15,6 +15,11 @@
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfig;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
+import io.javaoperatorsdk.operator.sample.dependentresource.ConfigMapDependentResource;
+import io.javaoperatorsdk.operator.sample.dependentresource.DeploymentDependentResource;
+import io.javaoperatorsdk.operator.sample.dependentresource.IngressDependentResource;
+import io.javaoperatorsdk.operator.sample.dependentresource.ServiceDependentResource;
 
 import static io.javaoperatorsdk.operator.sample.Utils.*;
 import static io.javaoperatorsdk.operator.sample.WebPageManagedDependentsReconciler.SELECTOR;

diff --git a/...aoperatorsdk/operator/sample/WebPage.java → ...erator/sample/customresource/WebPage.java b/...aoperatorsdk/operator/sample/WebPage.java → ...erator/sample/customresource/WebPage.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.customresource;
 
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.client.CustomResource;

diff --git a/...ratorsdk/operator/sample/WebPageSpec.java → ...or/sample/customresource/WebPageSpec.java b/...ratorsdk/operator/sample/WebPageSpec.java → ...or/sample/customresource/WebPageSpec.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.customresource;
 
 public class WebPageSpec {
 

diff --git a/...torsdk/operator/sample/WebPageStatus.java → .../sample/customresource/WebPageStatus.java b/...torsdk/operator/sample/WebPageStatus.java → .../sample/customresource/WebPageStatus.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.customresource;
 
 import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
 

diff --git a/...or/sample/ConfigMapDependentResource.java → ...tresource/ConfigMapDependentResource.java b/...or/sample/ConfigMapDependentResource.java → ...tresource/ConfigMapDependentResource.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.dependentresource;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -12,6 +12,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
 
 import static io.javaoperatorsdk.operator.sample.Utils.configMapName;
 import static io.javaoperatorsdk.operator.sample.Utils.deploymentName;

diff --git a/...r/sample/DeploymentDependentResource.java → ...resource/DeploymentDependentResource.java b/...r/sample/DeploymentDependentResource.java → ...resource/DeploymentDependentResource.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.dependentresource;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -8,6 +8,8 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
+import io.javaoperatorsdk.operator.sample.Utils;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
 
 import static io.javaoperatorsdk.operator.ReconcilerUtils.loadYaml;
 import static io.javaoperatorsdk.operator.sample.Utils.configMapName;
@@ -28,7 +30,7 @@ protected Deployment desired(WebPage webPage, Context<WebPage> context) {
     Map<String, String> labels = new HashMap<>();
     labels.put(SELECTOR, "true");
     var deploymentName = deploymentName(webPage);
-    Deployment deployment = loadYaml(Deployment.class, getClass(), "deployment.yaml");
+    Deployment deployment = loadYaml(Deployment.class, Utils.class, "deployment.yaml");
     deployment.getMetadata().setName(deploymentName);
     deployment.getMetadata().setNamespace(webPage.getMetadata().getNamespace());
     deployment.getMetadata().setLabels(labels);

diff --git a/...rator/sample/ExposedIngressCondition.java → ...dentresource/ExposedIngressCondition.java b/...rator/sample/ExposedIngressCondition.java → ...dentresource/ExposedIngressCondition.java
@@ -1,9 +1,10 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.dependentresource;
 
 import io.fabric8.kubernetes.api.model.networking.v1.Ingress;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.Condition;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
 
 public class ExposedIngressCondition implements Condition<Ingress, WebPage> {
 

diff --git a/...ator/sample/IngressDependentResource.java → ...entresource/IngressDependentResource.java b/...ator/sample/IngressDependentResource.java → ...entresource/IngressDependentResource.java
@@ -1,9 +1,11 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.dependentresource;
 
 import io.fabric8.kubernetes.api.model.networking.v1.Ingress;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.CRUDKubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
+import io.javaoperatorsdk.operator.sample.WebPageManagedDependentsReconciler;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
 
 import static io.javaoperatorsdk.operator.sample.Utils.makeDesiredIngress;
 

diff --git a/...ator/sample/ServiceDependentResource.java → ...entresource/ServiceDependentResource.java b/...ator/sample/ServiceDependentResource.java → ...entresource/ServiceDependentResource.java
@@ -1,11 +1,13 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.dependentresource;
 
 import java.util.HashMap;
 import java.util.Map;
 
 import io.fabric8.kubernetes.api.model.Service;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
+import io.javaoperatorsdk.operator.sample.Utils;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
 
 import static io.javaoperatorsdk.operator.ReconcilerUtils.loadYaml;
 import static io.javaoperatorsdk.operator.sample.Utils.deploymentName;
@@ -25,7 +27,7 @@ public ServiceDependentResource() {
   protected Service desired(WebPage webPage, Context<WebPage> context) {
     Map<String, String> serviceLabels = new HashMap<>();
     serviceLabels.put(SELECTOR, "true");
-    Service service = loadYaml(Service.class, getClass(), "service.yaml");
+    Service service = loadYaml(Service.class, Utils.class, "service.yaml");
     service.getMetadata().setName(serviceName(webPage));
     service.getMetadata().setNamespace(webPage.getMetadata().getNamespace());
     service.getMetadata().setLabels(serviceLabels);

diff --git a/...rsdk/operator/sample/LivenessHandler.java → ...erator/sample/probes/LivenessHandler.java b/...rsdk/operator/sample/LivenessHandler.java → ...erator/sample/probes/LivenessHandler.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.probes;
 
 import java.io.IOException;
 
@@ -7,7 +7,7 @@
 import com.sun.net.httpserver.HttpExchange;
 import com.sun.net.httpserver.HttpHandler;
 
-import static io.javaoperatorsdk.operator.sample.StartupHandler.sendMessage;
+import static io.javaoperatorsdk.operator.sample.probes.StartupHandler.sendMessage;
 
 public class LivenessHandler implements HttpHandler {
 

diff --git a/...orsdk/operator/sample/StartupHandler.java → ...perator/sample/probes/StartupHandler.java b/...orsdk/operator/sample/StartupHandler.java → ...perator/sample/probes/StartupHandler.java
@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.sample;
+package io.javaoperatorsdk.operator.sample.probes;
 
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;

diff --git a/...erators/webpage/src/main/resources/io/javaoperatorsdk/operator/sample/html-configmap.yaml b/...erators/webpage/src/main/resources/io/javaoperatorsdk/operator/sample/html-configmap.yaml
diff --git a/...webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorAbstractTest.java b/...webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorAbstractTest.java
@@ -18,6 +18,8 @@
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
 import io.fabric8.kubernetes.client.LocalPortForward;
 import io.javaoperatorsdk.operator.junit.AbstractOperatorExtension;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
+import io.javaoperatorsdk.operator.sample.customresource.WebPageSpec;
 
 import static io.javaoperatorsdk.operator.sample.Utils.deploymentName;
 import static io.javaoperatorsdk.operator.sample.Utils.serviceName;

diff --git a/...perators/webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorE2E.java b/...perators/webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorE2E.java
@@ -12,6 +12,7 @@
 import io.javaoperatorsdk.operator.junit.AbstractOperatorExtension;
 import io.javaoperatorsdk.operator.junit.ClusterDeployedOperatorExtension;
 import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
+import io.javaoperatorsdk.operator.sample.customresource.WebPage;
 
 import static io.javaoperatorsdk.operator.sample.WebPageOperator.WEBPAGE_CLASSIC_RECONCILER_ENV_VALUE;
 import static io.javaoperatorsdk.operator.sample.WebPageOperator.WEBPAGE_RECONCILER_ENV;