From c6dd04094b9c31d8d288bcb0953e871a195d71af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Attila=20M=C3=A9sz=C3=A1ros?= Date: Thu, 2 May 2024 19:19:31 +0200 Subject: [PATCH 1/3] improve: remove deprecated APIs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Attila Mészáros --- .../micrometer/MicrometerMetrics.java | 14 ----- .../io/javaoperatorsdk/operator/Operator.java | 16 +---- .../api/config/ConfigurationService.java | 32 ---------- .../config/ConfigurationServiceOverrider.java | 45 -------------- .../operator/api/monitoring/Metrics.java | 58 +------------------ .../managed/KubernetesClientAware.java | 15 ----- .../KubernetesDependentResourceConfig.java | 15 ----- .../workflow/DefaultManagedWorkflow.java | 5 -- .../dependent/workflow/WorkflowResult.java | 9 --- .../processing/event/EventSourceManager.java | 12 ---- .../source/informer/InformerEventSource.java | 12 ---- .../ConfigurationServiceOverriderTest.java | 21 ------- .../junit/AbstractOperatorExtension.java | 15 ----- .../operator/junit/KubernetesClientAware.java | 13 ----- .../junit/LocallyRunOperatorExtension.java | 3 +- .../operator/InformerRelatedBehaviorITS.java | 3 +- .../operator/LeaderElectionPermissionIT.java | 3 +- .../PerResourcePollingEventSourceIT.java | 4 +- .../sample/LeaderElectionTestOperator.java | 4 +- .../operator/sample/WebPageOperator.java | 7 +-- .../operator/sample/WebPageReconciler.java | 17 +++--- .../operator/sample/WebPageOperatorE2E.java | 2 +- 22 files changed, 23 insertions(+), 302 deletions(-) delete mode 100644 operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/KubernetesClientAware.java delete mode 100644 operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/KubernetesClientAware.java diff --git a/micrometer-support/src/main/java/io/javaoperatorsdk/operator/monitoring/micrometer/MicrometerMetrics.java b/micrometer-support/src/main/java/io/javaoperatorsdk/operator/monitoring/micrometer/MicrometerMetrics.java index b819bd0ca3..07106d9b3c 100644 --- a/micrometer-support/src/main/java/io/javaoperatorsdk/operator/monitoring/micrometer/MicrometerMetrics.java +++ b/micrometer-support/src/main/java/io/javaoperatorsdk/operator/monitoring/micrometer/MicrometerMetrics.java @@ -59,20 +59,6 @@ public class MicrometerMetrics implements Metrics { private final Map gauges = new ConcurrentHashMap<>(); private final Cleaner cleaner; - /** - * Creates a default micrometer-based Metrics implementation, collecting metrics on a per resource - * basis and not dealing with cleaning these after these resources are deleted. Note that this - * probably will change in a future release. If you want more control over what the implementation - * actually does, please use the static factory methods instead. - * - * @param registry the {@link MeterRegistry} instance to use for metrics recording - * @deprecated Use the factory methods / builders instead - */ - @Deprecated - public MicrometerMetrics(MeterRegistry registry) { - this(registry, Cleaner.NOOP, true); - } - /** * Creates a MicrometerMetrics instance configured to not collect per-resource metrics, just * aggregates per resource **type** 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 index d3f2f57c6d..d85de6b1e5 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java @@ -35,7 +35,7 @@ public Operator() { } Operator(KubernetesClient kubernetesClient) { - this(kubernetesClient, null); + this(initConfigurationService(kubernetesClient, null)); } /** @@ -63,19 +63,7 @@ public Operator(ConfigurationService configurationService) { * {@link ConfigurationService} values */ public Operator(Consumer overrider) { - this(null, 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(since = "4.4.0") - public Operator(KubernetesClient client, Consumer overrider) { - this(initConfigurationService(client, overrider)); + this(initConfigurationService(null, overrider)); } private static ConfigurationService initConfigurationService(KubernetesClient client, diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java index 93985bd556..2f85944155 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java @@ -128,11 +128,6 @@ default boolean checkCRDAndValidateLocalModel() { } int DEFAULT_RECONCILIATION_THREADS_NUMBER = 50; - /** - * @deprecated Not used anymore in the default implementation - */ - @Deprecated(forRemoval = true) - int MIN_DEFAULT_RECONCILIATION_THREADS_NUMBER = 10; /** * The number of threads the operator can spin out to dispatch reconciliation requests to @@ -144,23 +139,7 @@ default int concurrentReconciliationThreads() { return DEFAULT_RECONCILIATION_THREADS_NUMBER; } - /** - * The minimum number of threads the operator starts in the thread pool for reconciliations. - * - * @deprecated not used anymore by default executor implementation - * @return the minimum number of concurrent reconciliation threads - */ - @Deprecated(forRemoval = true) - default int minConcurrentReconciliationThreads() { - return MIN_DEFAULT_RECONCILIATION_THREADS_NUMBER; - } - int DEFAULT_WORKFLOW_EXECUTOR_THREAD_NUMBER = DEFAULT_RECONCILIATION_THREADS_NUMBER; - /** - * @deprecated Not used anymore in the default implementation - */ - @Deprecated(forRemoval = true) - int MIN_DEFAULT_WORKFLOW_EXECUTOR_THREAD_NUMBER = MIN_DEFAULT_RECONCILIATION_THREADS_NUMBER; /** * Number of threads the operator can spin out to be used in the workflows with the default @@ -172,17 +151,6 @@ default int concurrentWorkflowExecutorThreads() { return DEFAULT_WORKFLOW_EXECUTOR_THREAD_NUMBER; } - /** - * The minimum number of threads the operator starts in the thread pool for workflows. - * - * @deprecated not used anymore by default executor implementation - * @return the minimum number of concurrent workflow threads - */ - @Deprecated(forRemoval = true) - default int minConcurrentWorkflowExecutorThreads() { - return MIN_DEFAULT_WORKFLOW_EXECUTOR_THREAD_NUMBER; - } - default Metrics getMetrics() { return Metrics.NOOP; } diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java index add050c6f0..d2c153e150 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java @@ -4,7 +4,6 @@ import java.util.Optional; import java.util.Set; import java.util.concurrent.ExecutorService; -import java.util.function.Consumer; import java.util.function.Function; import org.slf4j.Logger; @@ -67,19 +66,6 @@ private int minimumMaxValueFor(Integer minValue) { return minValue != null ? (minValue < 0 ? 0 : minValue) + 1 : 1; } - public ConfigurationServiceOverrider withMinConcurrentReconciliationThreads(int threadNumber) { - this.minConcurrentReconciliationThreads = Utils.ensureValid(threadNumber, - "minimum reconciliation threads", ExecutorServiceManager.MIN_THREAD_NUMBER, - original.minConcurrentReconciliationThreads()); - return this; - } - - public ConfigurationServiceOverrider withMinConcurrentWorkflowExecutorThreads(int threadNumber) { - this.minConcurrentWorkflowExecutorThreads = Utils.ensureValid(threadNumber, - "minimum workflow execution threads", ExecutorServiceManager.MIN_THREAD_NUMBER, - original.minConcurrentWorkflowExecutorThreads()); - return this; - } public ConfigurationServiceOverrider withDependentResourceFactory( DependentResourceFactory dependentResourceFactory) { @@ -233,26 +219,6 @@ public int concurrentWorkflowExecutorThreads() { original.concurrentWorkflowExecutorThreads()); } - /** - * @deprecated Not used anymore in the default implementation - */ - @Deprecated(forRemoval = true) - @Override - public int minConcurrentReconciliationThreads() { - return overriddenValueOrDefault(minConcurrentReconciliationThreads, - ConfigurationService::minConcurrentReconciliationThreads); - } - - /** - * @deprecated Not used anymore in the default implementation - */ - @Override - @Deprecated(forRemoval = true) - public int minConcurrentWorkflowExecutorThreads() { - return overriddenValueOrDefault(minConcurrentWorkflowExecutorThreads, - ConfigurationService::minConcurrentWorkflowExecutorThreads); - } - @Override public Metrics getMetrics() { return overriddenValueOrDefault(metrics, ConfigurationService::getMetrics); @@ -341,15 +307,4 @@ public boolean cloneSecondaryResourcesWhenGettingFromCache() { }; } - /** - * @deprecated Use - * {@link ConfigurationService#newOverriddenConfigurationService(ConfigurationService, Consumer)} - * instead - * @param original that will be overridden - * @return current overrider - */ - @Deprecated(since = "2.2.0") - public static ConfigurationServiceOverrider override(ConfigurationService original) { - return new ConfigurationServiceOverrider(original); - } } diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java index 42fee488d7..bb34e5f760 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java @@ -1,6 +1,5 @@ package io.javaoperatorsdk.operator.api.monitoring; -import java.util.Collections; import java.util.Map; import io.fabric8.kubernetes.api.model.HasMetadata; @@ -37,16 +36,6 @@ default void controllerRegistered(Controller controller) */ default void receivedEvent(Event event, Map metadata) {} - /** - * @param metadata additional metadata - * @param resourceID of primary resource - * @param retryInfo for current execution - * @deprecated Use {@link #reconcileCustomResource(HasMetadata, RetryInfo, Map)} instead - */ - @Deprecated(forRemoval = true) - @SuppressWarnings("unused") - default void reconcileCustomResource(ResourceID resourceID, RetryInfo retryInfo, - Map metadata) {} /** * Called right before a resource is dispatched to the ExecutorService for reconciliation. @@ -56,19 +45,6 @@ default void reconcileCustomResource(ResourceID resourceID, RetryInfo retryInfo, * @param metadata metadata associated with the resource being processed */ default void reconcileCustomResource(HasMetadata resource, RetryInfo retryInfo, - Map metadata) { - reconcileCustomResource(ResourceID.fromResource(resource), retryInfo, metadata); - } - - /** - * @param exception actual exception - * @param metadata additional metadata - * @param resourceID of primary resource - * @deprecated Use {@link #failedReconciliation(HasMetadata, Exception, Map)} instead - */ - @Deprecated(forRemoval = true) - @SuppressWarnings("unused") - default void failedReconciliation(ResourceID resourceID, Exception exception, Map metadata) {} /** @@ -81,9 +57,7 @@ default void failedReconciliation(ResourceID resourceID, Exception exception, * @param metadata metadata associated with the resource being processed */ default void failedReconciliation(HasMetadata resource, Exception exception, - Map metadata) { - failedReconciliation(ResourceID.fromResource(resource), exception, metadata); - } + Map metadata) {} default void reconciliationExecutionStarted(HasMetadata resource, Map metadata) {} @@ -91,14 +65,6 @@ default void reconciliationExecutionStarted(HasMetadata resource, Map metadata) {} - /** - * @param resourceID of primary resource - * @deprecated Use (and implement) {@link #cleanupDoneFor(ResourceID, Map)} instead - */ - @Deprecated - default void cleanupDoneFor(ResourceID resourceID) { - cleanupDoneFor(resourceID, Collections.emptyMap()); - } /** * Called when the resource associated with the specified {@link ResourceID} has been successfully @@ -109,24 +75,6 @@ default void cleanupDoneFor(ResourceID resourceID) { */ default void cleanupDoneFor(ResourceID resourceID, Map metadata) {} - /** - * @param resourceID of primary resource - * @deprecated Use (and implement) {@link #finishedReconciliation(ResourceID, Map)} instead - */ - @Deprecated - default void finishedReconciliation(ResourceID resourceID) { - finishedReconciliation(resourceID, Collections.emptyMap()); - } - - /** - * @param resourceID of primary resource - * @param metadata additional metadata - * @deprecated Use {@link #finishedReconciliation(HasMetadata, Map)} instead - */ - @Deprecated(forRemoval = true) - @SuppressWarnings("unused") - default void finishedReconciliation(ResourceID resourceID, Map metadata) {} - /** * Called when the * {@link io.javaoperatorsdk.operator.api.reconciler.Reconciler#reconcile(HasMetadata, Context)} @@ -136,9 +84,7 @@ default void finishedReconciliation(ResourceID resourceID, Map m * @param resource the {@link ResourceID} associated with the resource being processed * @param metadata metadata associated with the resource being processed */ - default void finishedReconciliation(HasMetadata resource, Map metadata) { - finishedReconciliation(ResourceID.fromResource(resource), metadata); - } + default void finishedReconciliation(HasMetadata resource, Map metadata) {} /** * Encapsulates the information about a controller execution i.e. a call to either diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/KubernetesClientAware.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/KubernetesClientAware.java deleted file mode 100644 index d6c743f22b..0000000000 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/KubernetesClientAware.java +++ /dev/null @@ -1,15 +0,0 @@ -package io.javaoperatorsdk.operator.api.reconciler.dependent.managed; - -import io.fabric8.kubernetes.client.KubernetesClient; -import io.javaoperatorsdk.operator.api.reconciler.Context; - -/** - * @deprecated It shouldn't be needed to pass a {@link KubernetesClient} instance anymore as the - * client should be accessed via {@link Context#getClient()} instead. - */ -@Deprecated(since = "4.5.0", forRemoval = true) -public interface KubernetesClientAware { - void setKubernetesClient(KubernetesClient kubernetesClient); - - KubernetesClient getKubernetesClient(); -} diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResourceConfig.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResourceConfig.java index b1cb743232..e302ad437a 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResourceConfig.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResourceConfig.java @@ -52,21 +52,6 @@ public KubernetesDependentResourceConfig(Set namespaces, this.useSSA = useSSA; } - // use builder instead - @Deprecated(forRemoval = true) - public KubernetesDependentResourceConfig(Set namespaces, String labelSelector) { - this(namespaces, labelSelector, true, DEFAULT_CREATE_RESOURCE_ONLY_IF_NOT_EXISTING_WITH_SSA, - null, null, - null, null, null); - } - - // use builder instead - @Deprecated(forRemoval = true) - public KubernetesDependentResourceConfig setLabelSelector(String labelSelector) { - this.labelSelector = labelSelector; - return this; - } - public Set namespaces() { return namespaces; } diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultManagedWorkflow.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultManagedWorkflow.java index 03ed24d6df..43bb807e30 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultManagedWorkflow.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/DefaultManagedWorkflow.java @@ -13,7 +13,6 @@ import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource; import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceReferencer; import io.javaoperatorsdk.operator.api.reconciler.dependent.NameSetter; -import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.KubernetesClientAware; import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_VALUE_SET; @@ -112,10 +111,6 @@ private DependentResource resolve(DependentResourceSpec spec, ((NameSetter) dependentResource).setName(name); } - if (dependentResource instanceof KubernetesClientAware) { - ((KubernetesClientAware) dependentResource).setKubernetesClient(client); - } - spec.getUseEventSourceWithName() .ifPresent(esName -> { if (dependentResource instanceof EventSourceReferencer) { diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowResult.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowResult.java index d442c75c09..7014ccd5d4 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowResult.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/workflow/WorkflowResult.java @@ -21,15 +21,6 @@ public Map getErroredDependents() { return erroredDependents; } - /** - * @deprecated Use {@link #erroredDependentsExist()} instead - * @return if any dependents are in error state - */ - @Deprecated(forRemoval = true) - public boolean erroredDependentsExists() { - return !erroredDependents.isEmpty(); - } - @SuppressWarnings("unused") public boolean erroredDependentsExist() { return !erroredDependents.isEmpty(); diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventSourceManager.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventSourceManager.java index 512ab3bde1..30e0cc845e 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventSourceManager.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventSourceManager.java @@ -237,18 +237,6 @@ public EventSourceContext

eventSourceContextForDynamicRegistration() { return controller.eventSourceContext(); } - /** - * @deprecated Use {@link #getResourceEventSourceFor(Class)} instead - * - * @param target resource type - * @param dependentType target resource class - * @return list of related event sources - */ - @Deprecated - public List> getEventSourcesFor(Class dependentType) { - return getResourceEventSourcesFor(dependentType); - } - @Override public ResourceEventSource getResourceEventSourceFor( Class dependentType, String name) { diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java index 8759410b81..571e02dbc2 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java @@ -255,18 +255,6 @@ public Set getSecondaryResources(P primary) { .collect(Collectors.toSet()); } - /** - * Returns the configuration object for the informer. - * - * @return the informer configuration object - * - * @deprecated Use {@link #configuration()} instead - */ - @Deprecated(forRemoval = true) - public InformerConfiguration getConfiguration() { - return configuration(); - } - @Override public synchronized void handleRecentResourceUpdate(ResourceID resourceID, R resource, R previousVersionOfResource) { diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverriderTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverriderTest.java index 2d8444af68..4c374e09f2 100644 --- a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverriderTest.java +++ b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverriderTest.java @@ -8,7 +8,6 @@ import io.fabric8.kubernetes.api.model.HasMetadata; import io.javaoperatorsdk.operator.api.monitoring.Metrics; -import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotEquals; class ConfigurationServiceOverriderTest { @@ -80,24 +79,4 @@ public R clone(R object) { overridden.getLeaderElectionConfiguration()); } - @Test - void shouldReplaceInvalidValues() { - final var original = new BaseConfigurationService(); - - final var service = ConfigurationService.newOverriddenConfigurationService(original, - o -> o - .withConcurrentReconciliationThreads(0) - .withMinConcurrentReconciliationThreads(-1) - .withConcurrentWorkflowExecutorThreads(2) - .withMinConcurrentWorkflowExecutorThreads(3)); - - assertEquals(original.minConcurrentReconciliationThreads(), - service.minConcurrentReconciliationThreads()); - assertEquals(original.concurrentReconciliationThreads(), - service.concurrentReconciliationThreads()); - assertEquals(3, service.minConcurrentWorkflowExecutorThreads()); - assertEquals(original.concurrentWorkflowExecutorThreads(), - service.concurrentWorkflowExecutorThreads()); - } - } diff --git a/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/AbstractOperatorExtension.java b/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/AbstractOperatorExtension.java index 1ce14b73ed..1f9db8f999 100644 --- a/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/AbstractOperatorExtension.java +++ b/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/AbstractOperatorExtension.java @@ -111,30 +111,15 @@ public T create(T resource) { return kubernetesClient.resource(resource).inNamespace(namespace).create(); } - @Deprecated(forRemoval = true) - public T create(Class type, T resource) { - return create(resource); - } - public T replace(T resource) { return kubernetesClient.resource(resource).inNamespace(namespace).replace(); } - @Deprecated(forRemoval = true) - public T replace(Class type, T resource) { - return replace(resource); - } - public boolean delete(T resource) { var res = kubernetesClient.resource(resource).inNamespace(namespace).delete(); return res.size() == 1 && res.get(0).getCauses().isEmpty(); } - @Deprecated(forRemoval = true) - public boolean delete(Class type, T resource) { - return delete(resource); - } - protected void beforeAllImpl(ExtensionContext context) { if (oneNamespacePerClass) { namespace = perClassNamespaceNameSupplier.apply(context); diff --git a/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/KubernetesClientAware.java b/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/KubernetesClientAware.java deleted file mode 100644 index 8e94e71b53..0000000000 --- a/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/KubernetesClientAware.java +++ /dev/null @@ -1,13 +0,0 @@ -package io.javaoperatorsdk.operator.junit; - -import io.fabric8.kubernetes.client.KubernetesClient; -import io.javaoperatorsdk.operator.api.reconciler.Context; - -/** - * @deprecated It shouldn't be needed to pass a {@link KubernetesClient} instance to the reconciler - * anymore as the client should be accessed via {@link Context#getClient()} instead. - */ -@Deprecated(since = "4.5.0", forRemoval = true) -public interface KubernetesClientAware extends HasKubernetesClient { - void setKubernetesClient(KubernetesClient kubernetesClient); -} diff --git a/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java b/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java index 61916f14bc..3d84685206 100644 --- a/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java +++ b/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java @@ -70,7 +70,8 @@ private LocallyRunOperatorExtension( this.portForwards = portForwards; this.localPortForwards = new ArrayList<>(portForwards.size()); this.additionalCustomResourceDefinitions = additionalCustomResourceDefinitions; - this.operator = new Operator(getKubernetesClient(), configurationServiceOverrider); + this.operator = new Operator( + configurationServiceOverrider.andThen(o -> o.withKubernetesClient(getKubernetesClient()))); this.registeredControllers = new HashMap<>(); } diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/InformerRelatedBehaviorITS.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/InformerRelatedBehaviorITS.java index 8b3c7afca8..52360d17e7 100644 --- a/operator-framework/src/test/java/io/javaoperatorsdk/operator/InformerRelatedBehaviorITS.java +++ b/operator-framework/src/test/java/io/javaoperatorsdk/operator/InformerRelatedBehaviorITS.java @@ -316,8 +316,9 @@ Operator startOperator(boolean stopOnInformerErrorDuringStartup, boolean addStop reconciler = new InformerRelatedBehaviorTestReconciler(); - Operator operator = new Operator(clientUsingServiceAccount(), + Operator operator = new Operator( co -> { + co.withKubernetesClient(clientUsingServiceAccount()); co.withStopOnInformerErrorDuringStartup(stopOnInformerErrorDuringStartup); co.withCacheSyncTimeout(Duration.ofMillis(3000)); if (addStopHandler) { diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/LeaderElectionPermissionIT.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/LeaderElectionPermissionIT.java index e1c8435b8a..c1b30277c7 100644 --- a/operator-framework/src/test/java/io/javaoperatorsdk/operator/LeaderElectionPermissionIT.java +++ b/operator-framework/src/test/java/io/javaoperatorsdk/operator/LeaderElectionPermissionIT.java @@ -32,7 +32,8 @@ void operatorStopsIfNoLeaderElectionPermission() { .withImpersonateUsername("leader-elector-stop-noaccess") .build()).build(); - var operator = new Operator(client, o -> { + var operator = new Operator(o -> { + o.withKubernetesClient(client); o.withLeaderElectionConfiguration( new LeaderElectionConfiguration("lease1", "default")); o.withStopOnInformerErrorDuringStartup(false); diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/PerResourcePollingEventSourceIT.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/PerResourcePollingEventSourceIT.java index a4b850b9d4..3a827572e5 100644 --- a/operator-framework/src/test/java/io/javaoperatorsdk/operator/PerResourcePollingEventSourceIT.java +++ b/operator-framework/src/test/java/io/javaoperatorsdk/operator/PerResourcePollingEventSourceIT.java @@ -28,8 +28,8 @@ class PerResourcePollingEventSourceIT { **/ @Test void fetchedAndReconciledMultipleTimes() { - operator.create(PerResourceEventSourceCustomResource.class, resource(NAME_1)); - operator.create(PerResourceEventSourceCustomResource.class, resource(NAME_2)); + operator.create(resource(NAME_1)); + operator.create(resource(NAME_2)); var reconciler = operator.getReconcilerOfType(PerResourcePollingEventSourceTestReconciler.class); diff --git a/sample-operators/leader-election/src/main/java/io/javaoperatorsdk/operator/sample/LeaderElectionTestOperator.java b/sample-operators/leader-election/src/main/java/io/javaoperatorsdk/operator/sample/LeaderElectionTestOperator.java index 262c0a7c70..359272e0ef 100644 --- a/sample-operators/leader-election/src/main/java/io/javaoperatorsdk/operator/sample/LeaderElectionTestOperator.java +++ b/sample-operators/leader-election/src/main/java/io/javaoperatorsdk/operator/sample/LeaderElectionTestOperator.java @@ -3,7 +3,6 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import io.fabric8.kubernetes.client.KubernetesClientBuilder; import io.javaoperatorsdk.operator.Operator; import io.javaoperatorsdk.operator.api.config.LeaderElectionConfiguration; @@ -22,9 +21,8 @@ public static void main(String[] args) { ? new LeaderElectionConfiguration("leader-election-test") : new LeaderElectionConfiguration("leader-election-test", namespace, identity); - var client = new KubernetesClientBuilder().build(); Operator operator = - new Operator(client, c -> c.withLeaderElectionConfiguration(leaderElectionConfiguration)); + new Operator(c -> c.withLeaderElectionConfiguration(leaderElectionConfiguration)); operator.register(new LeaderElectionTestReconciler(identity)); operator.start(); diff --git a/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageOperator.java b/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageOperator.java index e3ab63dc54..ff80cc5901 100644 --- a/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageOperator.java +++ b/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageOperator.java @@ -6,8 +6,6 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -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; @@ -28,11 +26,10 @@ public class WebPageOperator { public static void main(String[] args) throws IOException { log.info("WebServer Operator starting!"); - KubernetesClient client = new KubernetesClientBuilder().build(); - Operator operator = new Operator(client, o -> o.withStopOnInformerErrorDuringStartup(false)); + Operator operator = new Operator(o -> o.withStopOnInformerErrorDuringStartup(false)); String reconcilerEnvVar = System.getenv(WEBPAGE_RECONCILER_ENV); if (WEBPAGE_CLASSIC_RECONCILER_ENV_VALUE.equals(reconcilerEnvVar)) { - operator.register(new WebPageReconciler(client)); + operator.register(new WebPageReconciler()); } else if (WEBPAGE_MANAGED_DEPENDENT_RESOURCE_ENV_VALUE .equals(reconcilerEnvVar)) { operator.register(new WebPageManagedDependentsReconciler()); diff --git a/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java b/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java index dfe6a10a71..6669d3a1f5 100644 --- a/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java +++ b/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java @@ -12,7 +12,6 @@ import io.fabric8.kubernetes.api.model.*; import io.fabric8.kubernetes.api.model.apps.Deployment; import io.fabric8.kubernetes.api.model.networking.v1.Ingress; -import io.fabric8.kubernetes.client.KubernetesClient; import io.javaoperatorsdk.operator.ReconcilerUtils; import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration; import io.javaoperatorsdk.operator.api.reconciler.*; @@ -35,10 +34,8 @@ public class WebPageReconciler private static final Logger log = LoggerFactory.getLogger(WebPageReconciler.class); - private final KubernetesClient kubernetesClient; + public WebPageReconciler() { - public WebPageReconciler(KubernetesClient kubernetesClient) { - this.kubernetesClient = kubernetesClient; } @Override @@ -89,7 +86,7 @@ public UpdateControl reconcile(WebPage webPage, Context contex "Creating or updating ConfigMap {} in {}", desiredHtmlConfigMap.getMetadata().getName(), ns); - kubernetesClient.configMaps().inNamespace(ns).resource(desiredHtmlConfigMap) + context.getClient().configMaps().inNamespace(ns).resource(desiredHtmlConfigMap) .serverSideApply(); } @@ -99,7 +96,7 @@ public UpdateControl reconcile(WebPage webPage, Context contex "Creating or updating Deployment {} in {}", desiredDeployment.getMetadata().getName(), ns); - kubernetesClient.apps().deployments().inNamespace(ns).resource(desiredDeployment) + context.getClient().apps().deployments().inNamespace(ns).resource(desiredDeployment) .serverSideApply(); } @@ -109,7 +106,7 @@ public UpdateControl reconcile(WebPage webPage, Context contex "Creating or updating Deployment {} in {}", desiredDeployment.getMetadata().getName(), ns); - kubernetesClient.services().inNamespace(ns).resource(desiredService) + context.getClient().services().inNamespace(ns).resource(desiredService) .serverSideApply(); } @@ -117,11 +114,11 @@ public UpdateControl reconcile(WebPage webPage, Context contex if (Boolean.TRUE.equals(webPage.getSpec().getExposed())) { var desiredIngress = makeDesiredIngress(webPage); if (existingIngress.isEmpty() || !match(desiredIngress, existingIngress.get())) { - kubernetesClient.resource(desiredIngress).inNamespace(ns).serverSideApply(); + context.getClient().resource(desiredIngress).inNamespace(ns).serverSideApply(); } } else existingIngress.ifPresent( - ingress -> kubernetesClient.resource(ingress).delete()); + ingress -> context.getClient().resource(ingress).delete()); // not that this is not necessary, eventually mounted config map would be updated, just this way // is much faster; what is handy for demo purposes. @@ -130,7 +127,7 @@ public UpdateControl reconcile(WebPage webPage, Context contex previousConfigMap.getData().get(INDEX_HTML), desiredHtmlConfigMap.getData().get(INDEX_HTML))) { log.info("Restarting pods because HTML has changed in {}", ns); - kubernetesClient.pods().inNamespace(ns).withLabel("app", deploymentName(webPage)).delete(); + context.getClient().pods().inNamespace(ns).withLabel("app", deploymentName(webPage)).delete(); } return UpdateControl.patchStatus( diff --git a/sample-operators/webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorE2E.java b/sample-operators/webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorE2E.java index 03c3d2c2e0..45fc4cd5ba 100644 --- a/sample-operators/webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorE2E.java +++ b/sample-operators/webpage/src/test/java/io/javaoperatorsdk/operator/sample/WebPageOperatorE2E.java @@ -27,7 +27,7 @@ public WebPageOperatorE2E() throws FileNotFoundException {} isLocal() ? LocallyRunOperatorExtension.builder() .waitForNamespaceDeletion(false) - .withReconciler(new WebPageReconciler(client)) + .withReconciler(new WebPageReconciler()) .build() : ClusterDeployedOperatorExtension.builder() .waitForNamespaceDeletion(false) From e4fea03b4dab862677598676a49c04bea0639092 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Attila=20M=C3=A9sz=C3=A1ros?= Date: Fri, 3 May 2024 09:44:41 +0200 Subject: [PATCH 2/3] fix MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Attila Mészáros --- .../operator/junit/LocallyRunOperatorExtension.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java b/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java index 3d84685206..4e3e38caa4 100644 --- a/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java +++ b/operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/LocallyRunOperatorExtension.java @@ -71,7 +71,9 @@ private LocallyRunOperatorExtension( this.localPortForwards = new ArrayList<>(portForwards.size()); this.additionalCustomResourceDefinitions = additionalCustomResourceDefinitions; this.operator = new Operator( - configurationServiceOverrider.andThen(o -> o.withKubernetesClient(getKubernetesClient()))); + configurationServiceOverrider == null ? o -> o.withKubernetesClient(getKubernetesClient()) + : configurationServiceOverrider + .andThen(o -> o.withKubernetesClient(getKubernetesClient()))); this.registeredControllers = new HashMap<>(); } From 0c5da9f853c20361040242b17f27cc6922f31701 Mon Sep 17 00:00:00 2001 From: Chris Laprun Date: Thu, 16 May 2024 09:14:29 +0200 Subject: [PATCH 3/3] refactor: more clean-ups Signed-off-by: Chris Laprun --- .../api/config/ConfigurationServiceOverrider.java | 13 ++++--------- .../operator/api/config/ExecutorServiceManager.java | 1 - 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java index d2c153e150..f073b98b8a 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java @@ -22,9 +22,7 @@ public class ConfigurationServiceOverrider { private Metrics metrics; private Boolean checkCR; private Integer concurrentReconciliationThreads; - private Integer minConcurrentReconciliationThreads; private Integer concurrentWorkflowExecutorThreads; - private Integer minConcurrentWorkflowExecutorThreads; private Cloner cloner; private Boolean closeClientOnStop; private KubernetesClient client; @@ -41,6 +39,7 @@ public class ConfigurationServiceOverrider { private Boolean parseResourceVersions; private Boolean useSSAToPatchPrimaryResource; private Boolean cloneSecondaryResourcesWhenGettingFromCache; + @SuppressWarnings("rawtypes") private DependentResourceFactory dependentResourceFactory; ConfigurationServiceOverrider(ConfigurationService original) { @@ -62,11 +61,7 @@ public ConfigurationServiceOverrider withConcurrentWorkflowExecutorThreads(int t return this; } - private int minimumMaxValueFor(Integer minValue) { - return minValue != null ? (minValue < 0 ? 0 : minValue) + 1 : 1; - } - - + @SuppressWarnings("rawtypes") public ConfigurationServiceOverrider withDependentResourceFactory( DependentResourceFactory dependentResourceFactory) { this.dependentResourceFactory = dependentResourceFactory; @@ -205,7 +200,7 @@ public int concurrentReconciliationThreads() { overriddenValueOrDefault(concurrentReconciliationThreads, ConfigurationService::concurrentReconciliationThreads), "maximum reconciliation threads", - minimumMaxValueFor(minConcurrentReconciliationThreads), + 1, original.concurrentReconciliationThreads()); } @@ -215,7 +210,7 @@ public int concurrentWorkflowExecutorThreads() { overriddenValueOrDefault(concurrentWorkflowExecutorThreads, ConfigurationService::concurrentWorkflowExecutorThreads), "maximum workflow execution threads", - minimumMaxValueFor(minConcurrentWorkflowExecutorThreads), + 1, original.concurrentWorkflowExecutorThreads()); } diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ExecutorServiceManager.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ExecutorServiceManager.java index 112ab7188a..c35281e822 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ExecutorServiceManager.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ExecutorServiceManager.java @@ -22,7 +22,6 @@ public class ExecutorServiceManager { private static final Logger log = LoggerFactory.getLogger(ExecutorServiceManager.class); - public static final int MIN_THREAD_NUMBER = 0; private ExecutorService executor; private ExecutorService workflowExecutor; private ExecutorService cachingExecutorService;