Skip to content

Commit d99f65a

Browse files
authored
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.
1 parent b2a8a14 commit d99f65a

10 files changed

+20
-0
lines changed

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55

66
import io.fabric8.kubernetes.api.model.HasMetadata;
77
import io.javaoperatorsdk.operator.api.reconciler.Context;
8+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
89
import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
910
import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
1011
import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
1112
import io.javaoperatorsdk.operator.processing.event.ResourceID;
1213

14+
@Ignore
1315
public abstract class AbstractDependentResource<R, P extends HasMetadata>
1416
implements DependentResource<R, P> {
1517
private static final Logger log = LoggerFactory.getLogger(AbstractDependentResource.class);

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractEventSourceHolderDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22

33
import io.fabric8.kubernetes.api.model.HasMetadata;
44
import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
5+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
56
import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceProvider;
67
import io.javaoperatorsdk.operator.api.reconciler.dependent.RecentOperationCacheFiller;
78
import io.javaoperatorsdk.operator.processing.event.ResourceID;
89
import io.javaoperatorsdk.operator.processing.event.source.EventSource;
910
import io.javaoperatorsdk.operator.processing.event.source.ResourceEventSource;
1011

12+
@Ignore
1113
public abstract class AbstractEventSourceHolderDependentResource<R, P extends HasMetadata, T extends ResourceEventSource<R, P>>
1214
extends AbstractDependentResource<R, P>
1315
implements EventSourceProvider<P> {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractCachingDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
import java.util.Optional;
44

55
import io.fabric8.kubernetes.api.model.HasMetadata;
6+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
67
import io.javaoperatorsdk.operator.processing.dependent.AbstractEventSourceHolderDependentResource;
78
import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
89

10+
@Ignore
911
public abstract class AbstractCachingDependentResource<R, P extends HasMetadata>
1012
extends
1113
AbstractEventSourceHolderDependentResource<R, P, ExternalResourceCachingEventSource<R, P>> {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractPollingDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
package io.javaoperatorsdk.operator.processing.dependent.external;
22

33
import io.fabric8.kubernetes.api.model.HasMetadata;
4+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
45
import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
56

7+
@Ignore
68
public abstract class AbstractPollingDependentResource<R, P extends HasMetadata>
79
extends AbstractCachingDependentResource<R, P> implements CacheKeyMapper<R> {
810

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
import io.fabric8.kubernetes.api.model.HasMetadata;
66
import io.javaoperatorsdk.operator.api.reconciler.Context;
7+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
78
import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
89
import io.javaoperatorsdk.operator.processing.dependent.AbstractDependentResource;
910
import io.javaoperatorsdk.operator.processing.dependent.DesiredEqualsMatcher;
@@ -13,6 +14,7 @@
1314
import io.javaoperatorsdk.operator.processing.event.source.UpdatableCache;
1415

1516
/** A base class for external dependent resources that don't have an event source. */
17+
@Ignore
1618
public abstract class AbstractSimpleDependentResource<R, P extends HasMetadata>
1719
extends AbstractDependentResource<R, P> {
1820

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/PerResourcePollingDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
import io.fabric8.kubernetes.api.model.HasMetadata;
44
import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
5+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
56
import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
67
import io.javaoperatorsdk.operator.processing.event.source.polling.PerResourcePollingEventSource;
78

9+
@Ignore
810
public abstract class PerResourcePollingDependentResource<R, P extends HasMetadata>
911
extends AbstractPollingDependentResource<R, P>
1012
implements PerResourcePollingEventSource.ResourceFetcher<R, P> {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/PollingDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
import io.fabric8.kubernetes.api.model.HasMetadata;
44
import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
5+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
56
import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
67
import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
78
import io.javaoperatorsdk.operator.processing.event.source.polling.PollingEventSource;
89

10+
@Ignore
911
public abstract class PollingDependentResource<R, P extends HasMetadata>
1012
extends AbstractPollingDependentResource<R, P>
1113
implements PollingEventSource.GenericResourceFetcher<R> {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDKubernetesDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
22

33
import io.fabric8.kubernetes.api.model.HasMetadata;
4+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
45
import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
56
import io.javaoperatorsdk.operator.processing.dependent.Creator;
67
import io.javaoperatorsdk.operator.processing.dependent.Updater;
@@ -11,6 +12,7 @@
1112
* @param <R> Managed resource
1213
* @param <P> Primary Resource
1314
*/
15+
@Ignore
1416
public abstract class CRUDKubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
1517
extends
1618
KubernetesDependentResource<R, P> implements Creator<R, P>, Updater<R, P>, Deleter<P> {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUKubernetesDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
22

33
import io.fabric8.kubernetes.api.model.HasMetadata;
4+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
45
import io.javaoperatorsdk.operator.processing.dependent.Creator;
56
import io.javaoperatorsdk.operator.processing.dependent.Updater;
67

@@ -10,6 +11,7 @@
1011
* @param <R> Managed resource
1112
* @param <P> Primary Resource
1213
*/
14+
@Ignore
1315
public abstract class CRUKubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
1416
extends
1517
KubernetesDependentResource<R, P> implements Creator<R, P>, Updater<R, P> {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
import io.javaoperatorsdk.operator.api.reconciler.Constants;
1616
import io.javaoperatorsdk.operator.api.reconciler.Context;
1717
import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
18+
import io.javaoperatorsdk.operator.api.reconciler.Ignore;
1819
import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.DependentResourceConfigurator;
1920
import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.KubernetesClientAware;
2021
import io.javaoperatorsdk.operator.processing.dependent.AbstractEventSourceHolderDependentResource;
@@ -25,6 +26,7 @@
2526
import io.javaoperatorsdk.operator.processing.event.source.informer.InformerEventSource;
2627
import io.javaoperatorsdk.operator.processing.event.source.informer.Mappers;
2728

29+
@Ignore
2830
public abstract class KubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
2931
extends AbstractEventSourceHolderDependentResource<R, P, InformerEventSource<R, P>>
3032
implements KubernetesClientAware,

0 commit comments

Comments
 (0)