chore: add @ignore to internal/intermediate DependentResources (#1292)

The goal is to allow downstream processes (e.g. the Quarkus extension) which might need to introspect only user-defined DependentResource implementations, similarly to what was done for Reconciler implementations already.
operator-framework · Jun 17, 2022 · d99f65a · d99f65a
1 parent b2a8a14
commit d99f65a
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 0 deletions.
diff --git a/...main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResource.java b/...main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResource.java
@@ -5,11 +5,13 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
+@Ignore
 public abstract class AbstractDependentResource<R, P extends HasMetadata>
     implements DependentResource<R, P> {
   private static final Logger log = LoggerFactory.getLogger(AbstractDependentResource.class);

diff --git a/...operatorsdk/operator/processing/dependent/AbstractEventSourceHolderDependentResource.java b/...operatorsdk/operator/processing/dependent/AbstractEventSourceHolderDependentResource.java
@@ -2,12 +2,14 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceProvider;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.RecentOperationCacheFiller;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventSource;
 
+@Ignore
 public abstract class AbstractEventSourceHolderDependentResource<R, P extends HasMetadata, T extends ResourceEventSource<R, P>>
     extends AbstractDependentResource<R, P>
     implements EventSourceProvider<P> {

diff --git a/...aoperatorsdk/operator/processing/dependent/external/AbstractCachingDependentResource.java b/...aoperatorsdk/operator/processing/dependent/external/AbstractCachingDependentResource.java
@@ -3,9 +3,11 @@
 import java.util.Optional;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.processing.dependent.AbstractEventSourceHolderDependentResource;
 import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
 
+@Ignore
 public abstract class AbstractCachingDependentResource<R, P extends HasMetadata>
     extends
     AbstractEventSourceHolderDependentResource<R, P, ExternalResourceCachingEventSource<R, P>> {

diff --git a/...aoperatorsdk/operator/processing/dependent/external/AbstractPollingDependentResource.java b/...aoperatorsdk/operator/processing/dependent/external/AbstractPollingDependentResource.java
@@ -1,8 +1,10 @@
 package io.javaoperatorsdk.operator.processing.dependent.external;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
 
+@Ignore
 public abstract class AbstractPollingDependentResource<R, P extends HasMetadata>
     extends AbstractCachingDependentResource<R, P> implements CacheKeyMapper<R> {
 

diff --git a/...vaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java b/...vaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java
@@ -4,6 +4,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
 import io.javaoperatorsdk.operator.processing.dependent.AbstractDependentResource;
 import io.javaoperatorsdk.operator.processing.dependent.DesiredEqualsMatcher;
@@ -13,6 +14,7 @@
 import io.javaoperatorsdk.operator.processing.event.source.UpdatableCache;
 
 /** A base class for external dependent resources that don't have an event source. */
+@Ignore
 public abstract class AbstractSimpleDependentResource<R, P extends HasMetadata>
     extends AbstractDependentResource<R, P> {
 

diff --git a/...eratorsdk/operator/processing/dependent/external/PerResourcePollingDependentResource.java b/...eratorsdk/operator/processing/dependent/external/PerResourcePollingDependentResource.java
@@ -2,9 +2,11 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
 import io.javaoperatorsdk.operator.processing.event.source.polling.PerResourcePollingEventSource;
 
+@Ignore
 public abstract class PerResourcePollingDependentResource<R, P extends HasMetadata>
     extends AbstractPollingDependentResource<R, P>
     implements PerResourcePollingEventSource.ResourceFetcher<R, P> {

diff --git a/...a/io/javaoperatorsdk/operator/processing/dependent/external/PollingDependentResource.java b/...a/io/javaoperatorsdk/operator/processing/dependent/external/PollingDependentResource.java
@@ -2,10 +2,12 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
 import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
 import io.javaoperatorsdk.operator.processing.event.source.polling.PollingEventSource;
 
+@Ignore
 public abstract class PollingDependentResource<R, P extends HasMetadata>
     extends AbstractPollingDependentResource<R, P>
     implements PollingEventSource.GenericResourceFetcher<R> {

diff --git a/...operatorsdk/operator/processing/dependent/kubernetes/CRUDKubernetesDependentResource.java b/...operatorsdk/operator/processing/dependent/kubernetes/CRUDKubernetesDependentResource.java
@@ -1,6 +1,7 @@
 package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
 import io.javaoperatorsdk.operator.processing.dependent.Creator;
 import io.javaoperatorsdk.operator.processing.dependent.Updater;
@@ -11,6 +12,7 @@
  * @param <R> Managed resource
  * @param <P> Primary Resource
  */
+@Ignore
 public abstract class CRUDKubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
     extends
     KubernetesDependentResource<R, P> implements Creator<R, P>, Updater<R, P>, Deleter<P> {

diff --git a/...aoperatorsdk/operator/processing/dependent/kubernetes/CRUKubernetesDependentResource.java b/...aoperatorsdk/operator/processing/dependent/kubernetes/CRUKubernetesDependentResource.java
@@ -1,6 +1,7 @@
 package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.processing.dependent.Creator;
 import io.javaoperatorsdk.operator.processing.dependent.Updater;
 
@@ -10,6 +11,7 @@
  * @param <R> Managed resource
  * @param <P> Primary Resource
  */
+@Ignore
 public abstract class CRUKubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
     extends
     KubernetesDependentResource<R, P> implements Creator<R, P>, Updater<R, P> {

diff --git a/...javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java b/...javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java
@@ -15,6 +15,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Constants;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
+import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.DependentResourceConfigurator;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.KubernetesClientAware;
 import io.javaoperatorsdk.operator.processing.dependent.AbstractEventSourceHolderDependentResource;
@@ -25,6 +26,7 @@
 import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;
 import io.javaoperatorsdk.operator.processing.event.source.informer.Mappers;
 
+@Ignore
 public abstract class KubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
     extends AbstractEventSourceHolderDependentResource<R, P, InformerEventSource<R, P>>
     implements KubernetesClientAware,