wip

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -10,9 +10,7 @@
 import org.slf4j.LoggerFactory;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.fabric8.kubernetes.client.ConfigBuilder;
 import io.fabric8.kubernetes.client.KubernetesClient;
-import io.fabric8.kubernetes.client.KubernetesClientBuilder;
 import io.fabric8.kubernetes.client.Version;
 import io.javaoperatorsdk.operator.api.config.BaseConfigurationService;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
@@ -26,7 +24,7 @@
 @SuppressWarnings("rawtypes")
 public class Operator implements LifecycleAware {
   private static final Logger log = LoggerFactory.getLogger(Operator.class);
-  private static final int DEFAULT_MAX_CONCURRENT_REQUEST = 512;
+
   private final KubernetesClient kubernetesClient;
   private final ControllerManager controllerManager;
   private final LeaderElectionManager leaderElectionManager;
@@ -38,8 +36,8 @@ public Operator() {
     this((KubernetesClient) null);
   }
 
-  public Operator(KubernetesClient kubernetesClient) {
-    this(kubernetesClient, new BaseConfigurationService());
+  Operator(KubernetesClient kubernetesClient) {
+    this(kubernetesClient, null);
   }
 
   /**
@@ -48,39 +46,43 @@ public Operator(KubernetesClient kubernetesClient) {
    */
   @Deprecated(forRemoval = true)
   public Operator(ConfigurationService configurationService) {
-    this(null, configurationService);
+    this(null, null);
   }
 
   public Operator(Consumer<ConfigurationServiceOverrider> overrider) {
     this(null, overrider);
   }
 
-  public Operator(KubernetesClient client, Consumer<ConfigurationServiceOverrider> overrider) {
-    this(client, ConfigurationService
-        .newOverriddenConfigurationService(new BaseConfigurationService(), overrider));
-  }
-
   /**
    * Note that Operator by default closes the client on stop, this can be changed using
    * {@link ConfigurationService}
    *
-   * @param kubernetesClient client to use to all Kubernetes related operations
-   * @param configurationService provides configuration
+   * @param client client to use to all Kubernetes related operations
+   * @param overrider a {@link ConfigurationServiceOverrider} consumer used to override the default
+   *        {@link ConfigurationService} values
    */
-  public Operator(KubernetesClient kubernetesClient, ConfigurationService configurationService) {
-    this.configurationService = configurationService;
+  public Operator(KubernetesClient client, Consumer<ConfigurationServiceOverrider> overrider) {
+    // initialize the client if the user didn't provide one
+    if (client == null) {
+      var configurationService = ConfigurationService.newOverriddenConfigurationService(new BaseConfigurationService(), overrider);
+      client = configurationService.getKubernetesClient();
+    }
+
+    this.kubernetesClient = client;
+
+    // override the configuration service to use the same client
+    if (overrider != null) {
+      overrider = overrider.andThen(o -> o.withKubernetesClient(this.kubernetesClient));
+    } else {
+      overrider = o -> o.withKubernetesClient(this.kubernetesClient);
+    }
+    this.configurationService = ConfigurationService.newOverriddenConfigurationService(new BaseConfigurationService(), overrider);
+
     final var executorServiceManager = configurationService.getExecutorServiceManager();
     controllerManager = new ControllerManager(executorServiceManager);
-    this.kubernetesClient =
-        kubernetesClient != null ? kubernetesClient
-            : new KubernetesClientBuilder()
-                .withConfig(new ConfigBuilder()
-                    .withMaxConcurrentRequests(DEFAULT_MAX_CONCURRENT_REQUEST).build())
-                .build();
-
 
     leaderElectionManager =
-        new LeaderElectionManager(kubernetesClient, controllerManager, configurationService);
+        new LeaderElectionManager(this.kubernetesClient, controllerManager, configurationService);
   }
 
   /**

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

@@ -11,14 +11,16 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.Config;
+import io.fabric8.kubernetes.client.ConfigBuilder;
 import io.fabric8.kubernetes.client.CustomResource;
-import io.fabric8.kubernetes.client.utils.Serialization;
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.fabric8.kubernetes.client.utils.KubernetesSerialization;
 import io.javaoperatorsdk.operator.api.monitoring.Metrics;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceFactory;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.ManagedWorkflowFactory;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import static io.javaoperatorsdk.operator.api.config.ExecutorServiceManager.newThreadPoolExecutor;
@@ -28,6 +30,8 @@ public interface ConfigurationService {
 
   Logger log = LoggerFactory.getLogger(ConfigurationService.class);
 
+  int DEFAULT_MAX_CONCURRENT_REQUEST = 512;
+
   /**
    * Retrieves the configuration associated with the specified reconciler
    *
@@ -43,9 +47,44 @@ public interface ConfigurationService {
    *
    * @return the configuration of the Kubernetes client, defaulting to the provided
    *         auto-configuration
+   * @deprecated Configure your client as needed using {@link #getKubernetesClient()} or a
+   *             {@link ConfigurationServiceOverrider} to pass your own client instance, configured
+   *             as needed, instead
    */
+  @Deprecated(since = "4.4.0", forRemoval = true)
   default Config getClientConfiguration() {
-    return Config.autoConfigure(null);
+    return getKubernetesClient().getConfiguration();
+  }
+
+
+  ObjectMapper mapper = new ObjectMapper();
+  default ObjectMapper getObjectMapper() {
+    return mapper;
+  }
+
+  /**
+   * Used to clone custom resources. It is strongly suggested that implementors override this method
+   * since the default implementation creates a new {@link Cloner} instance each time this method is
+   * called.
+   *
+   * @return the configured {@link Cloner}
+   */
+  default Cloner getResourceCloner() {
+    return new Cloner() {
+      @Override
+      public <R extends HasMetadata> R clone(R object) {
+        return getKubernetesClient().getKubernetesSerialization().clone(object);
+      }
+    };
+  }
+
+  default KubernetesClient getKubernetesClient() {
+    return new KubernetesClientBuilder()
+        .withConfig(new ConfigBuilder(Config.autoConfigure(null))
+            .withMaxConcurrentRequests(DEFAULT_MAX_CONCURRENT_REQUEST)
+            .build())
+        .withKubernetesSerialization(new KubernetesSerialization(getObjectMapper(), true))
+        .build();
   }
 
   /**
@@ -120,28 +159,6 @@ default int minConcurrentWorkflowExecutorThreads() {
     return MIN_DEFAULT_WORKFLOW_EXECUTOR_THREAD_NUMBER;
   }
 
-  /**
-   * Used to clone custom resources. It is strongly suggested that implementors override this method
-   * since the default implementation creates a new {@link Cloner} instance each time this method is
-   * called.
-   *
-   * @return the configured {@link Cloner}
-   */
-  default Cloner getResourceCloner() {
-    return new Cloner() {
-      @SuppressWarnings("unchecked")
-      @Override
-      public HasMetadata clone(HasMetadata object) {
-        try {
-          final var mapper = getObjectMapper();
-          return mapper.readValue(mapper.writeValueAsString(object), object.getClass());
-        } catch (JsonProcessingException e) {
-          throw new IllegalStateException(e);
-        }
-      }
-    };
-  }
-
   int DEFAULT_TERMINATION_TIMEOUT_SECONDS = 10;
 
   /**
@@ -176,10 +193,6 @@ default boolean closeClientOnStop() {
     return true;
   }
 
-  default ObjectMapper getObjectMapper() {
-    return Serialization.jsonMapper();
-  }
-
   @SuppressWarnings("rawtypes")
   default DependentResourceFactory dependentResourceFactory() {
     return DependentResourceFactory.DEFAULT;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java

@@ -6,13 +6,19 @@
 import java.util.concurrent.ExecutorService;
 import java.util.function.Consumer;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import io.fabric8.kubernetes.client.Config;
+import io.fabric8.kubernetes.client.KubernetesClient;
 import io.javaoperatorsdk.operator.api.monitoring.Metrics;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 @SuppressWarnings("unused")
 public class ConfigurationServiceOverrider {
+
+  private static final Logger log = LoggerFactory.getLogger(ConfigurationServiceOverrider.class);
   private final ConfigurationService original;
   private Metrics metrics;
   private Config clientConfig;
@@ -25,6 +31,7 @@ public class ConfigurationServiceOverrider {
   private Integer timeoutSeconds;
   private Boolean closeClientOnStop;
   private ObjectMapper objectMapper;
+  private KubernetesClient client;
   private ExecutorService executorService;
   private ExecutorService workflowExecutorService;
   private LeaderElectionConfiguration leaderElectionConfiguration;
@@ -113,6 +120,11 @@ public ConfigurationServiceOverrider withObjectMapper(ObjectMapper objectMapper)
     return this;
   }
 
+  public ConfigurationServiceOverrider withKubernetesClient(KubernetesClient client) {
+    this.client = client;
+    return this;
+  }
+
   public ConfigurationServiceOverrider withLeaderElectionConfiguration(
       LeaderElectionConfiguration leaderElectionConfiguration) {
     this.leaderElectionConfiguration = leaderElectionConfiguration;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResourceConfiguration.java

@@ -114,8 +114,7 @@ static Set<String> ensureValidNamespaces(Collection<String> namespaces) {
   default Set<String> getEffectiveNamespaces(ConfigurationService configurationService) {
     var targetNamespaces = getNamespaces();
     if (watchCurrentNamespace()) {
-      final String namespace =
-          configurationService.getClientConfiguration().getNamespace();
+      final String namespace = configurationService.getClientConfiguration().getNamespace();
       if (namespace == null) {
         throw new OperatorException(
             "Couldn't retrieve the currently connected namespace. Make sure it's correctly set in your ~/.kube/config file, using, e.g. 'kubectl config set-context <your context> --namespace=<your namespace>'");

operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/AbstractOperatorExtension.java

@@ -27,8 +27,6 @@
 import io.fabric8.kubernetes.client.dsl.Resource;
 import io.fabric8.kubernetes.client.utils.KubernetesResourceUtil;
 import io.fabric8.kubernetes.client.utils.Utils;
-import io.javaoperatorsdk.operator.api.config.BaseConfigurationService;
-import io.javaoperatorsdk.operator.api.config.ConfigurationService;
 import io.javaoperatorsdk.operator.api.config.ConfigurationServiceOverrider;
 
 public abstract class AbstractOperatorExtension implements HasKubernetesClient,
@@ -221,7 +219,7 @@ public static abstract class AbstractBuilder<T extends AbstractBuilder<T>> {
     protected boolean waitForNamespaceDeletion;
     protected boolean oneNamespacePerClass;
     protected int namespaceDeleteTimeout;
-    protected ConfigurationService configurationService = new BaseConfigurationService();
+    protected Consumer<ConfigurationServiceOverrider> configurationServiceOverrider;
 
     protected AbstractBuilder() {
       this.infrastructure = new ArrayList<>();
@@ -260,8 +258,7 @@ public T oneNamespacePerClass(boolean value) {
     }
 
     public T withConfigurationService(Consumer<ConfigurationServiceOverrider> overrider) {
-      configurationService =
-          ConfigurationService.newOverriddenConfigurationService(configurationService, overrider);
+      configurationServiceOverrider = overrider;
       return (T) this;
     }
 

operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java

@@ -24,7 +24,7 @@
 import io.javaoperatorsdk.operator.Operator;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.RegisteredController;
-import io.javaoperatorsdk.operator.api.config.ConfigurationService;
+import io.javaoperatorsdk.operator.api.config.ConfigurationServiceOverrider;
 import io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.processing.retry.Retry;
@@ -53,7 +53,7 @@ private LocallyRunOperatorExtension(
       boolean waitForNamespaceDeletion,
       boolean oneNamespacePerClass,
       KubernetesClient kubernetesClient,
-      ConfigurationService configurationService) {
+      Consumer<ConfigurationServiceOverrider> configurationServiceOverrider) {
     super(
         infrastructure,
         infrastructureTimeout,
@@ -65,7 +65,7 @@ private LocallyRunOperatorExtension(
     this.portForwards = portForwards;
     this.localPortForwards = new ArrayList<>(portForwards.size());
     this.additionalCustomResourceDefinitions = additionalCustomResourceDefinitions;
-    this.operator = new Operator(getKubernetesClient(), configurationService);
+    this.operator = new Operator(getKubernetesClient(), configurationServiceOverrider);
     this.registeredControllers = new HashMap<>();
   }
 
@@ -289,7 +289,7 @@ public LocallyRunOperatorExtension build() {
           waitForNamespaceDeletion,
           oneNamespacePerClass,
           kubernetesClient,
-          configurationService);
+          configurationServiceOverrider);
     }
   }
 

sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/TomcatOperator.java

@@ -9,7 +9,6 @@
 import org.takes.http.Exit;
 import org.takes.http.FtBasic;
 
-import io.fabric8.kubernetes.client.*;
 import io.javaoperatorsdk.operator.Operator;
 
 public class TomcatOperator {
@@ -18,10 +17,9 @@ public class TomcatOperator {
 
   public static void main(String[] args) throws IOException {
 
-    KubernetesClient client = new KubernetesClientBuilder().build();
-    Operator operator = new Operator(client);
+    Operator operator = new Operator();
     operator.register(new TomcatReconciler());
-    operator.register(new WebappReconciler(client));
+    operator.register(new WebappReconciler(operator.getKubernetesClient()));
     operator.start();
 
     new FtBasic(new TkFork(new FkRegex("/health", "ALL GOOD.")), 8080).start(Exit.NEVER);