Skip to content

Commit

Permalink
feat: update to informer configuration changes for controller (#895)
Browse files Browse the repository at this point in the history 
Requires JOSDK PR 2455

Signed-off-by: Chris Laprun <[email protected]>
  • Loading branch information
@metacosm
metacosm committed Jul 4, 2024
1 parent c2de9d9 commit a9728b6
Show file tree
Hide file tree
Showing 7 changed files with 179 additions and 139 deletions.
115 changes: 70 additions & 45 deletions ...n/java/io/quarkiverse/operatorsdk/deployment/QuarkusControllerConfigurationBuildStep.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import java.util.*;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;

import org.jboss.jandex.*;
Expand All @@ -24,6 +25,7 @@
import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
import io.javaoperatorsdk.operator.api.reconciler.MaxReconciliationInterval;
import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.InformerConfigHolder;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentConverter;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
Expand Down Expand Up @@ -70,6 +72,10 @@ public KubernetesDependentResourceConfig configFrom(KubernetesDependent configAn
new QuarkusInformerConfigHolder(original.informerConfig()));
}
};
private static final Supplier<AnnotationInstance> NULL_ANNOTATION_SUPPLIER = () -> null;
public static final Supplier<String[]> NULL_STRING_ARRAY_SUPPLIER = () -> null;
public static final Supplier<String> NULL_STRING_SUPPLIER = () -> null;

static {
// register Quarkus-specific converter for Kubernetes dependent resources
DependentResourceConfigurationResolver.registerConverter(KubernetesDependentResource.class,
Expand Down Expand Up @@ -159,10 +165,13 @@ static QuarkusControllerConfiguration createConfiguration(
Long nullableInformerListLimit = null;
String fieldManager = null;
ItemStore<?> itemStore = null;
Set<String> namespaces = null;
String informerName = null;
String labelSelector = null;
if (controllerAnnotation != null) {
final var intervalFromAnnotation = ConfigurationUtils.annotationValueOrDefault(
controllerAnnotation, "maxReconciliationInterval", AnnotationValue::asNested,
() -> null);
NULL_ANNOTATION_SUPPLIER);
final var interval = ConfigurationUtils.annotationValueOrDefault(
intervalFromAnnotation, "interval", AnnotationValue::asLong,
() -> MaxReconciliationInterval.DEFAULT_INTERVAL);
Expand All @@ -175,32 +184,53 @@ static QuarkusControllerConfiguration createConfiguration(
maxReconciliationInterval = Duration.of(interval, timeUnit.toChronoUnit());
}

onAddFilter = ConfigurationUtils.instantiateImplementationClass(
controllerAnnotation, "onAddFilter", OnAddFilter.class, OnAddFilter.class, true, index);
onUpdateFilter = ConfigurationUtils.instantiateImplementationClass(
controllerAnnotation, "onUpdateFilter", OnUpdateFilter.class, OnUpdateFilter.class,
true, index);
genericFilter = ConfigurationUtils.instantiateImplementationClass(
controllerAnnotation, "genericFilter", GenericFilter.class, GenericFilter.class,
true, index);
retryClass = ConfigurationUtils.annotationValueOrDefault(controllerAnnotation,
"retry", av -> loadClass(av.asClass().name().toString(), Retry.class), () -> GenericRetry.class);
// deal with informer configuration
final var informerConfigAnnotation = ConfigurationUtils.annotationValueOrDefault(controllerAnnotation,
"informerConfig", AnnotationValue::asNested, NULL_ANNOTATION_SUPPLIER);
if (informerConfigAnnotation != null) {
onAddFilter = ConfigurationUtils.instantiateImplementationClass(
informerConfigAnnotation, "onAddFilter", OnAddFilter.class, OnAddFilter.class, true, index);
onUpdateFilter = ConfigurationUtils.instantiateImplementationClass(
informerConfigAnnotation, "onUpdateFilter", OnUpdateFilter.class, OnUpdateFilter.class,
true, index);
genericFilter = ConfigurationUtils.instantiateImplementationClass(
informerConfigAnnotation, "genericFilter", GenericFilter.class, GenericFilter.class,
true, index);
retryClass = ConfigurationUtils.annotationValueOrDefault(informerConfigAnnotation,
"retry", av -> loadClass(av.asClass().name().toString(), Retry.class), () -> GenericRetry.class);
nullableInformerListLimit = ConfigurationUtils.annotationValueOrDefault(
informerConfigAnnotation, "informerListLimit", AnnotationValue::asLong,
() -> null);
itemStore = ConfigurationUtils.instantiateImplementationClass(informerConfigAnnotation, "itemStore",
ItemStore.class,
ItemStore.class, true, index);
informerName = ConfigurationUtils.annotationValueOrDefault(informerConfigAnnotation, "name",
AnnotationValue::asString, NULL_STRING_SUPPLIER);
labelSelector = ConfigurationUtils.annotationValueOrDefault(informerConfigAnnotation,
"labelSelector",
AnnotationValue::asString,
NULL_STRING_SUPPLIER);

// extract the namespaces
// first check if we explicitly set the namespaces via the annotations
namespaces = Optional.ofNullable(informerConfigAnnotation.value("namespaces"))
.map(v -> new HashSet<>(Arrays.asList(v.asStringArray())))
.orElse(null);
}

final var retryConfigurableInfo = configurableInfos.get(retryClass.getName());
retryConfigurationClass = getConfigurationAnnotationClass(reconcilerInfo, retryConfigurableInfo);

rateLimiterClass = ConfigurationUtils.annotationValueOrDefault(
controllerAnnotation,
"rateLimiter", av -> loadClass(av.asClass().name().toString(), RateLimiter.class),
() -> DefaultRateLimiter.class);
final var rateLimiterConfigurableInfo = configurableInfos.get(rateLimiterClass.getName());
rateLimiterConfigurationClass = getConfigurationAnnotationClass(reconcilerInfo,
rateLimiterConfigurableInfo);
nullableInformerListLimit = ConfigurationUtils.annotationValueOrDefault(
controllerAnnotation, "informerListLimit", AnnotationValue::asLong,
() -> null);

fieldManager = ConfigurationUtils.annotationValueOrDefault(controllerAnnotation, "fieldManager",
AnnotationValue::asString, () -> null);
itemStore = ConfigurationUtils.instantiateImplementationClass(controllerAnnotation, "itemStore", ItemStore.class,
ItemStore.class, true, index);
AnnotationValue::asString, NULL_STRING_SUPPLIER);
}

// check if we have additional RBAC rules to handle
Expand All @@ -209,14 +239,6 @@ static QuarkusControllerConfiguration createConfiguration(
// check if we have additional RBAC role refs to handle
final var additionalRBACRoleRefs = extractAdditionalRBACRoleRefs(info);

// extract the namespaces
// first check if we explicitly set the namespaces via the annotations
Set<String> namespaces = null;
if (controllerAnnotation != null) {
namespaces = Optional.ofNullable(controllerAnnotation.value("namespaces"))
.map(v -> new HashSet<>(Arrays.asList(v.asStringArray())))
.orElse(null);
}
// remember whether or not we explicitly set the namespaces
final boolean wereNamespacesSet;
if (namespaces == null) {
Expand All @@ -236,26 +258,36 @@ static QuarkusControllerConfiguration createConfiguration(
// create the configuration
final ReconciledAugmentedClassInfo<?> primaryInfo = reconcilerInfo.associatedResourceInfo();
final var primaryAsResource = primaryInfo.asResourceTargeting();
final var resourceClass = primaryInfo.loadAssociatedClass();
final Class<? extends HasMetadata> resourceClass = (Class<? extends HasMetadata>) primaryInfo.loadAssociatedClass();
final String resourceFullName = primaryAsResource.fullResourceName();

final var informerConfigHolder = InformerConfigHolder.builder(resourceClass)
.withName(informerName)
.withNamespaces(namespaces)
.withLabelSelector(labelSelector)
.withGenericFilter(genericFilter)
.withOnAddFilter(onAddFilter)
.withOnUpdateFilter(onUpdateFilter)
.withItemStore(itemStore)
.withInformerListLimit(nullableInformerListLimit)
.buildForController();
final var informerConfig = new QuarkusInformerConfigHolder(informerConfigHolder);

configuration = new QuarkusControllerConfiguration(
reconcilerClassName,
name,
resourceFullName,
primaryAsResource.version(),
configExtractor.generationAware(),
resourceClass,
nullableInformerListLimit,
namespaces,
wereNamespacesSet,
getFinalizer(controllerAnnotation, resourceFullName),
getLabelSelector(controllerAnnotation),
primaryAsResource.hasNonVoidStatus(),
maxReconciliationInterval,
onAddFilter, onUpdateFilter, genericFilter, retryClass, retryConfigurationClass, rateLimiterClass,
retryClass, retryConfigurationClass, rateLimiterClass,
rateLimiterConfigurationClass, additionalRBACRules, additionalRBACRoleRefs,
fieldManager, itemStore);
fieldManager,
informerConfig);

// compute workflow and set it
initializeWorkflowIfNeeded(configuration, reconcilerInfo, index);
Expand Down Expand Up @@ -341,27 +373,27 @@ private static PolicyRule extractRule(AnnotationInstance ruleAnnotation) {
builder.withApiGroups(ConfigurationUtils.annotationValueOrDefault(ruleAnnotation,
"apiGroups",
AnnotationValue::asStringArray,
() -> null));
NULL_STRING_ARRAY_SUPPLIER));

builder.withVerbs(ConfigurationUtils.annotationValueOrDefault(ruleAnnotation,
"verbs",
AnnotationValue::asStringArray,
() -> null));
NULL_STRING_ARRAY_SUPPLIER));

builder.withResources(ConfigurationUtils.annotationValueOrDefault(ruleAnnotation,
"resources",
AnnotationValue::asStringArray,
() -> null));
NULL_STRING_ARRAY_SUPPLIER));

builder.withResourceNames(ConfigurationUtils.annotationValueOrDefault(ruleAnnotation,
"resourceNames",
AnnotationValue::asStringArray,
() -> null));
NULL_STRING_ARRAY_SUPPLIER));

builder.withNonResourceURLs(ConfigurationUtils.annotationValueOrDefault(ruleAnnotation,
"nonResourceURLs",
AnnotationValue::asStringArray,
() -> null));
NULL_STRING_ARRAY_SUPPLIER));

return builder.build();
}
Expand All @@ -378,7 +410,7 @@ private static RoleRef extractRoleRef(AnnotationInstance roleRefAnnotation) {
builder.withName(ConfigurationUtils.annotationValueOrDefault(roleRefAnnotation,
"name",
AnnotationValue::asString,
() -> null));
NULL_STRING_SUPPLIER));

return builder.build();
}
Expand Down Expand Up @@ -440,7 +472,7 @@ private static DependentResourceSpecMetadata createDependentResourceSpec(

final var useEventSourceWithName = ConfigurationUtils.annotationValueOrDefault(
dependentConfig, "useEventSourceWithName", AnnotationValue::asString,
() -> null);
NULL_STRING_SUPPLIER);

final var spec = new DependentResourceSpecMetadata(dependentClass, dependent.nameOrFailIfUnset(),
dependsOn, readyCondition, reconcilePrecondition, deletePostcondition, activationCondition,
Expand All @@ -457,11 +489,4 @@ private static String getFinalizer(AnnotationInstance controllerAnnotation, Stri
AnnotationValue::asString,
() -> ReconcilerUtils.getDefaultFinalizerName(crdName));
}

private static String getLabelSelector(AnnotationInstance controllerAnnotation) {
return ConfigurationUtils.annotationValueOrDefault(controllerAnnotation,
"labelSelector",
AnnotationValue::asString,
() -> null);
}
}
36 changes: 36 additions & 0 deletions core/deployment/src/test/java/io/quarkiverse/operatorsdk/test/OneNSConfigurationTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package io.quarkiverse.operatorsdk.test;

import static org.junit.jupiter.api.Assertions.assertEquals;

import java.util.Set;

import jakarta.inject.Inject;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.javaoperatorsdk.operator.api.config.ConfigurationService;
import io.quarkiverse.operatorsdk.test.sources.OneNSReconciler;
import io.quarkiverse.operatorsdk.test.sources.TestCR;
import io.quarkus.test.QuarkusUnitTest;

public class OneNSConfigurationTest {

@RegisterExtension
static QuarkusUnitTest runner = new QuarkusUnitTest()
.overrideConfigKey("quarkus.operator-sdk.start-operator", "false")
.withApplicationRoot(
jar -> jar.addClasses(OneNSReconciler.class, TestCR.class));

@Inject
ConfigurationService configurationService;

@Inject
OneNSReconciler testReconciler;

@Test
void checkDefaultOperatorLevelNamespaces() {
final var config = configurationService.getConfigurationFor(testReconciler);
assertEquals(Set.of(OneNSReconciler.NS), config.getNamespaces());
}
}
18 changes: 18 additions & 0 deletions core/deployment/src/test/java/io/quarkiverse/operatorsdk/test/sources/OneNSReconciler.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package io.quarkiverse.operatorsdk.test.sources;

import io.javaoperatorsdk.operator.api.reconciler.Context;
import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.InformerConfig;

@ControllerConfiguration(informerConfig = @InformerConfig(namespaces = OneNSReconciler.NS))
public class OneNSReconciler implements Reconciler<TestCR> {

public static final String NS = "foo";

@Override
public UpdateControl<TestCR> reconcile(TestCR testCR, Context<TestCR> context) throws Exception {
return null;
}
}
Loading

0 comments on commit a9728b6

Please sign in to comment.