feat: provide and use Kubernetes client directly

Author: metacosm

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

@@ -9,7 +9,6 @@
 
 import io.fabric8.kubernetes.api.model.authorization.v1.SelfSubjectRulesReview;
 import io.fabric8.kubernetes.api.model.authorization.v1.SelfSubjectRulesReviewSpecBuilder;
-import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.extended.leaderelection.LeaderCallbacks;
 import io.fabric8.kubernetes.client.extended.leaderelection.LeaderElectionConfig;
 import io.fabric8.kubernetes.client.extended.leaderelection.LeaderElector;
@@ -32,14 +31,11 @@ public class LeaderElectionManager {
   private final ControllerManager controllerManager;
   private String identity;
   private CompletableFuture<?> leaderElectionFuture;
-  private KubernetesClient kubernetesClient;
   private final ConfigurationService configurationService;
   private String leaseNamespace;
 
-  public LeaderElectionManager(KubernetesClient kubernetesClient,
-      ControllerManager controllerManager,
+  public LeaderElectionManager(ControllerManager controllerManager,
       ConfigurationService configurationService) {
-    this.kubernetesClient = kubernetesClient;
     this.controllerManager = controllerManager;
     this.configurationService = configurationService;
   }
@@ -52,7 +48,7 @@ private void init(LeaderElectionConfiguration config) {
     this.identity = identity(config);
     leaseNamespace =
         config.getLeaseNamespace().orElseGet(
-            () -> configurationService.getClientConfiguration().getNamespace());
+            () -> configurationService.getKubernetesClient().getConfiguration().getNamespace());
     if (leaseNamespace == null) {
       final var message =
           "Lease namespace is not set and cannot be inferred. Leader election cannot continue.";
@@ -62,7 +58,8 @@ private void init(LeaderElectionConfiguration config) {
     final var lock = new LeaseLock(leaseNamespace, config.getLeaseName(), identity);
     // releaseOnCancel is not used in the underlying implementation
     leaderElector = new LeaderElectorBuilder(
-        kubernetesClient, configurationService.getExecutorServiceManager().cachingExecutorService())
+        configurationService.getKubernetesClient(),
+        configurationService.getExecutorServiceManager().cachingExecutorService())
         .withConfig(
             new LeaderElectionConfig(
                 lock,
@@ -122,7 +119,7 @@ private void checkLeaseAccess() {
     var verbs = Arrays.asList("create", "update", "get");
     SelfSubjectRulesReview review = new SelfSubjectRulesReview();
     review.setSpec(new SelfSubjectRulesReviewSpecBuilder().withNamespace(leaseNamespace).build());
-    var reviewResult = kubernetesClient.resource(review).create();
+    var reviewResult = configurationService.getKubernetesClient().resource(review).create();
     log.debug("SelfSubjectRulesReview result: {}", reviewResult);
     var foundRule = reviewResult.getStatus().getResourceRules().stream()
         .filter(rule -> rule.getApiGroups().contains(COORDINATION_GROUP)

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

@@ -12,7 +12,6 @@
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.Version;
-import io.javaoperatorsdk.operator.api.config.BaseConfigurationService;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
 import io.javaoperatorsdk.operator.api.config.ConfigurationServiceOverrider;
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
@@ -60,12 +59,14 @@ public Operator(Consumer<ConfigurationServiceOverrider> overrider) {
    * @param client client to use to all Kubernetes related operations
    * @param overrider a {@link ConfigurationServiceOverrider} consumer used to override the default
    *        {@link ConfigurationService} values
+   * @deprecated Use {@link Operator#Operator(Consumer)} instead, passing your custom client with
+   *             {@link ConfigurationServiceOverrider#withKubernetesClient(KubernetesClient)}
    */
+  @Deprecated
   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);
+      var configurationService = ConfigurationService.newOverriddenConfigurationService(overrider);
       client = configurationService.getKubernetesClient();
     }
 
@@ -77,14 +78,12 @@ public Operator(KubernetesClient client, Consumer<ConfigurationServiceOverrider>
     } else {
       overrider = o -> o.withKubernetesClient(this.kubernetesClient);
     }
-    this.configurationService = ConfigurationService
-        .newOverriddenConfigurationService(new BaseConfigurationService(), overrider);
+    this.configurationService = ConfigurationService.newOverriddenConfigurationService(overrider);
 
     final var executorServiceManager = configurationService.getExecutorServiceManager();
     controllerManager = new ControllerManager(executorServiceManager);
 
-    leaderElectionManager =
-        new LeaderElectionManager(this.kubernetesClient, controllerManager, configurationService);
+    leaderElectionManager = new LeaderElectionManager(controllerManager, configurationService);
   }
 
   /**

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

@@ -9,44 +9,38 @@
 import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-
 @SuppressWarnings("rawtypes")
 public class AbstractConfigurationService implements ConfigurationService {
   private final Map<String, ControllerConfiguration> configurations = new ConcurrentHashMap<>();
   private final Version version;
   private Cloner cloner;
-  private ObjectMapper mapper;
   private ExecutorServiceManager executorServiceManager;
 
   public AbstractConfigurationService(Version version) {
-    this(version, null, null, null);
+    this(version, null, null);
   }
 
   public AbstractConfigurationService(Version version, Cloner cloner) {
-    this(version, cloner, null, null);
+    this(version, cloner, null);
   }
 
-  public AbstractConfigurationService(Version version, Cloner cloner, ObjectMapper mapper,
+  public AbstractConfigurationService(Version version, Cloner cloner,
       ExecutorServiceManager executorServiceManager) {
     this.version = version;
-    init(cloner, mapper, executorServiceManager);
+    init(cloner, executorServiceManager);
   }
 
   /**
-   * Subclasses can call this method to more easily initialize the {@link Cloner}
-   * {@link ObjectMapper} and {@link ExecutorServiceManager} associated with this
-   * ConfigurationService implementation. This is useful in situations where the cloner depends on a
-   * mapper that might require additional configuration steps before it's ready to be used.
+   * Subclasses can call this method to more easily initialize the {@link Cloner} and
+   * {@link ExecutorServiceManager} associated with this ConfigurationService implementation. This
+   * is useful in situations where the cloner depends on a mapper that might require additional
+   * configuration steps before it's ready to be used.
    *
    * @param cloner the {@link Cloner} instance to be used
-   * @param mapper the {@link ObjectMapper} instance to be used
    * @param executorServiceManager the {@link ExecutorServiceManager} instance to be used
    */
-  protected void init(Cloner cloner, ObjectMapper mapper,
-      ExecutorServiceManager executorServiceManager) {
+  protected void init(Cloner cloner, ExecutorServiceManager executorServiceManager) {
     this.cloner = cloner != null ? cloner : ConfigurationService.super.getResourceCloner();
-    this.mapper = mapper != null ? mapper : ConfigurationService.super.getObjectMapper();
     this.executorServiceManager = executorServiceManager;
   }
 
@@ -133,11 +127,6 @@ public Cloner getResourceCloner() {
     return cloner;
   }
 
-  @Override
-  public ObjectMapper getObjectMapper() {
-    return mapper;
-  }
-
   @Override
   public ExecutorServiceManager getExecutorServiceManager() {
     // lazy init to avoid initializing thread pools for nothing in an overriding scenario

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

@@ -31,8 +31,6 @@
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
 import io.javaoperatorsdk.operator.processing.retry.Retry;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-
 import static io.javaoperatorsdk.operator.api.config.ControllerConfiguration.CONTROLLER_NAME_AS_FIELD_MANAGER;
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
 
@@ -45,10 +43,6 @@ public BaseConfigurationService(Version version) {
     super(version);
   }
 
-  public BaseConfigurationService(Version version, Cloner cloner, ObjectMapper mapper) {
-    super(version, cloner, mapper, null);
-  }
-
   public BaseConfigurationService(Version version, Cloner cloner) {
     super(version, cloner);
   }

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

@@ -21,8 +21,6 @@
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceFactory;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.ManagedWorkflowFactory;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-
 import static io.javaoperatorsdk.operator.api.config.ExecutorServiceManager.newThreadPoolExecutor;
 
 /** An interface from which to retrieve configuration information. */
@@ -42,26 +40,6 @@ public interface ConfigurationService {
    */
   <R extends HasMetadata> ControllerConfiguration<R> getConfigurationFor(Reconciler<R> reconciler);
 
-  /**
-   * Retrieves the Kubernetes client configuration
-   *
-   * @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 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
@@ -84,7 +62,7 @@ default KubernetesClient getKubernetesClient() {
         .withConfig(new ConfigBuilder(Config.autoConfigure(null))
             .withMaxConcurrentRequests(DEFAULT_MAX_CONCURRENT_REQUEST)
             .build())
-        .withKubernetesSerialization(new KubernetesSerialization(getObjectMapper(), true))
+        .withKubernetesSerialization(new KubernetesSerialization())
         .build();
   }
 
@@ -275,6 +253,11 @@ static ConfigurationService newOverriddenConfigurationService(
     return baseConfiguration;
   }
 
+  static ConfigurationService newOverriddenConfigurationService(
+      Consumer<ConfigurationServiceOverrider> overrider) {
+    return newOverriddenConfigurationService(new BaseConfigurationService(), overrider);
+  }
+
   default ExecutorServiceManager getExecutorServiceManager() {
     return new ExecutorServiceManager(this);
   }

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

@@ -9,19 +9,15 @@
 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;
   private Boolean checkCR;
   private Integer concurrentReconciliationThreads;
   private Integer minConcurrentReconciliationThreads;
@@ -30,7 +26,6 @@ public class ConfigurationServiceOverrider {
   private Cloner cloner;
   private Integer timeoutSeconds;
   private Boolean closeClientOnStop;
-  private ObjectMapper objectMapper;
   private KubernetesClient client;
   private ExecutorService executorService;
   private ExecutorService workflowExecutorService;
@@ -46,11 +41,6 @@ public class ConfigurationServiceOverrider {
     this.original = original;
   }
 
-  public ConfigurationServiceOverrider withClientConfiguration(Config configuration) {
-    this.clientConfig = configuration;
-    return this;
-  }
-
   public ConfigurationServiceOverrider checkingCRDAndValidateLocalModel(boolean check) {
     this.checkCR = check;
     return this;
@@ -115,11 +105,6 @@ public ConfigurationServiceOverrider withWorkflowExecutorService(
     return this;
   }
 
-  public ConfigurationServiceOverrider withObjectMapper(ObjectMapper objectMapper) {
-    this.objectMapper = objectMapper;
-    return this;
-  }
-
   public ConfigurationServiceOverrider withKubernetesClient(KubernetesClient client) {
     this.client = client;
     return this;
@@ -166,18 +151,12 @@ public ConfigurationServiceOverrider withSSABasedDefaultMatchingForDependentReso
   }
 
   public ConfigurationService build() {
-    return new BaseConfigurationService(original.getVersion(), cloner, objectMapper) {
+    return new BaseConfigurationService(original.getVersion(), cloner) {
       @Override
       public Set<String> getKnownReconcilerNames() {
         return original.getKnownReconcilerNames();
       }
 
-      @Override
-      public Config getClientConfiguration() {
-        //todo: check if client exists
-        return clientConfig != null ? clientConfig : (client != null ? client.getConfiguration() : original.getClientConfiguration());
-      }
-
       @Override
       public boolean checkCRDAndValidateLocalModel() {
         return checkCR != null ? checkCR : original.checkCRDAndValidateLocalModel();
@@ -242,15 +221,8 @@ public ExecutorService getWorkflowExecutorService() {
             : super.getWorkflowExecutorService();
       }
 
-      @Override
-      public ObjectMapper getObjectMapper() {
-        // todo: check if client exits
-        return objectMapper != null ? objectMapper : original.getObjectMapper();
-      }
-
       @Override
       public KubernetesClient getKubernetesClient() {
-        // TODO: we need to use the client's mapper if we provided a client
         return client != null ? client : original.getKubernetesClient();
       }
 

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

@@ -113,7 +113,8 @@ 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.getKubernetesClient().getConfiguration().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-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/SSABasedGenericKubernetesResourceMatcher.java

@@ -21,7 +21,6 @@
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.core.type.TypeReference;
 
 /**
  * Matches the actual state on the server vs the desired state. Based on the managedFields of SSA.
@@ -53,8 +52,6 @@ public static <L extends HasMetadata> SSABasedGenericKubernetesResourceMatcher<L
     return INSTANCE;
   }
 
-  private static final TypeReference<HashMap<String, Object>> typeRef = new TypeReference<>() {};
-
   private static final String F_PREFIX = "f:";
   private static final String K_PREFIX = "k:";
   private static final String V_PREFIX = "v:";
@@ -83,7 +80,7 @@ public boolean matches(R actual, R desired, Context<?> context) {
       var managedFieldsEntry = optionalManagedFieldsEntry.orElseThrow();
 
       var objectMapper = context.getClient().getKubernetesSerialization();
-
+                                            
       var actualMap = objectMapper.convertValue(actual, Map.class);
       var desiredMap = objectMapper.convertValue(desired, Map.class);