Skip to content

feat: builder for kubernetes dependent configuration #2054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,24 @@ public class KubernetesDependentResourceConfig<R> {

public static final boolean DEFAULT_CREATE_RESOURCE_ONLY_IF_NOT_EXISTING_WITH_SSA = true;

private Set<String> namespaces = Constants.SAME_AS_CONTROLLER_NAMESPACES_SET;
private String labelSelector = NO_VALUE_SET;
private boolean namespacesWereConfigured = false;
private boolean createResourceOnlyIfNotExistingWithSSA;
private ResourceDiscriminator<R, ?> resourceDiscriminator;
private Boolean useSSA;

private OnAddFilter<R> onAddFilter;

private OnUpdateFilter<R> onUpdateFilter;

private OnDeleteFilter<R> onDeleteFilter;

private GenericFilter<R> genericFilter;

public KubernetesDependentResourceConfig() {}
private Set<String> namespaces;
private String labelSelector;
private final boolean namespacesWereConfigured;
private final boolean createResourceOnlyIfNotExistingWithSSA;
private final ResourceDiscriminator<R, ?> resourceDiscriminator;
private final Boolean useSSA;

private final OnAddFilter<R> onAddFilter;
private final OnUpdateFilter<R> onUpdateFilter;
private final OnDeleteFilter<R> onDeleteFilter;
private final GenericFilter<R> genericFilter;

public KubernetesDependentResourceConfig() {
this(Constants.SAME_AS_CONTROLLER_NAMESPACES_SET, NO_VALUE_SET, true,
DEFAULT_CREATE_RESOURCE_ONLY_IF_NOT_EXISTING_WITH_SSA,
null, null, null,
null, null, null);
}

public KubernetesDependentResourceConfig(Set<String> namespaces,
String labelSelector,
Expand All @@ -54,12 +56,16 @@ public KubernetesDependentResourceConfig(Set<String> namespaces,
this.useSSA = useSSA;
}

// use builder instead
@Deprecated(forRemoval = true)
public KubernetesDependentResourceConfig(Set<String> namespaces, String labelSelector) {
this(namespaces, labelSelector, true, DEFAULT_CREATE_RESOURCE_ONLY_IF_NOT_EXISTING_WITH_SSA,
null, null, null,
null, null, null);
}

// use builder instead
@Deprecated(forRemoval = true)
public KubernetesDependentResourceConfig<R> setLabelSelector(String labelSelector) {
this.labelSelector = labelSelector;
return this;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
package io.javaoperatorsdk.operator.processing.dependent.kubernetes;

import java.util.Set;

import io.javaoperatorsdk.operator.api.reconciler.ResourceDiscriminator;
import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
import io.javaoperatorsdk.operator.processing.event.source.filter.OnDeleteFilter;
import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;

public final class KubernetesDependentResourceConfigBuilder<R> {

private Set<String> namespaces;
private String labelSelector;
private boolean createResourceOnlyIfNotExistingWithSSA;
private ResourceDiscriminator<R, ?> resourceDiscriminator;
private Boolean useSSA;
private OnAddFilter<R> onAddFilter;
private OnUpdateFilter<R> onUpdateFilter;
private OnDeleteFilter<R> onDeleteFilter;
private GenericFilter<R> genericFilter;

public KubernetesDependentResourceConfigBuilder() {}

public static <R> KubernetesDependentResourceConfigBuilder<R> aKubernetesDependentResourceConfig() {
return new KubernetesDependentResourceConfigBuilder<>();
}

public KubernetesDependentResourceConfigBuilder<R> withNamespaces(Set<String> namespaces) {
this.namespaces = namespaces;
return this;
}

public KubernetesDependentResourceConfigBuilder<R> withLabelSelector(String labelSelector) {
this.labelSelector = labelSelector;
return this;
}

public KubernetesDependentResourceConfigBuilder<R> withCreateResourceOnlyIfNotExistingWithSSA(
boolean createResourceOnlyIfNotExistingWithSSA) {
this.createResourceOnlyIfNotExistingWithSSA = createResourceOnlyIfNotExistingWithSSA;
return this;
}

public KubernetesDependentResourceConfigBuilder<R> withResourceDiscriminator(
ResourceDiscriminator<R, ?> resourceDiscriminator) {
this.resourceDiscriminator = resourceDiscriminator;
return this;
}

public KubernetesDependentResourceConfigBuilder<R> withUseSSA(Boolean useSSA) {
this.useSSA = useSSA;
return this;
}

public KubernetesDependentResourceConfigBuilder<R> withOnAddFilter(OnAddFilter<R> onAddFilter) {
this.onAddFilter = onAddFilter;
return this;
}

public KubernetesDependentResourceConfigBuilder<R> withOnUpdateFilter(
OnUpdateFilter<R> onUpdateFilter) {
this.onUpdateFilter = onUpdateFilter;
return this;
}

public KubernetesDependentResourceConfigBuilder<R> withOnDeleteFilter(
OnDeleteFilter<R> onDeleteFilter) {
this.onDeleteFilter = onDeleteFilter;
return this;
}

public KubernetesDependentResourceConfigBuilder<R> withGenericFilter(
GenericFilter<R> genericFilter) {
this.genericFilter = genericFilter;
return this;
}

public KubernetesDependentResourceConfig<R> build() {
return new KubernetesDependentResourceConfig<>(namespaces, labelSelector, false,
createResourceOnlyIfNotExistingWithSSA, resourceDiscriminator, useSSA, onAddFilter,
onUpdateFilter, onDeleteFilter, genericFilter);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependent;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfig;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfigBuilder;
import io.javaoperatorsdk.operator.processing.dependent.workflow.Condition;

import static org.junit.jupiter.api.Assertions.assertEquals;
Expand Down Expand Up @@ -327,7 +328,10 @@ void replaceNamedDependentResourceConfigShouldWork() {
final var overridden = ControllerConfigurationOverrider.override(configuration)
.replacingNamedDependentResourceConfig(
DependentResource.defaultNameFor(ReadOnlyDependent.class),
new KubernetesDependentResourceConfig(Set.of(overriddenNS), labelSelector))
new KubernetesDependentResourceConfigBuilder<>()
.withNamespaces(Set.of(overriddenNS))
.withLabelSelector(labelSelector)
.build())
.build();
dependents = overridden.getDependentResources();
dependentSpec = dependents.stream().filter(dr -> dr.getName().equals(dependentResourceName))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfig;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfigBuilder;
import io.javaoperatorsdk.operator.processing.dependent.workflow.Workflow;
import io.javaoperatorsdk.operator.processing.dependent.workflow.WorkflowBuilder;
import io.javaoperatorsdk.operator.processing.event.source.EventSource;
Expand Down Expand Up @@ -91,8 +91,8 @@ private void initDependentResources(KubernetesClient client) {

Arrays.asList(configMapDR, deploymentDR, serviceDR, ingressDR).forEach(dr -> {
dr.setKubernetesClient(client);
dr.configureWith(new KubernetesDependentResourceConfig()
.setLabelSelector(DEPENDENT_RESOURCE_LABEL_SELECTOR));
dr.configureWith(new KubernetesDependentResourceConfigBuilder()
.withLabelSelector(DEPENDENT_RESOURCE_LABEL_SELECTOR).build());
});
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import io.fabric8.kubernetes.client.KubernetesClient;
import io.javaoperatorsdk.operator.api.reconciler.*;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfig;
import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResourceConfigBuilder;
import io.javaoperatorsdk.operator.processing.event.source.EventSource;
import io.javaoperatorsdk.operator.sample.customresource.WebPage;
import io.javaoperatorsdk.operator.sample.dependentresource.ConfigMapDependentResource;
Expand Down Expand Up @@ -79,21 +79,19 @@ public ErrorStatusUpdateControl<WebPage> updateErrorStatus(
return handleError(resource, e);
}

@SuppressWarnings("unchecked")
@SuppressWarnings({"unchecked", "rawtypes"})
private void createDependentResources(KubernetesClient client) {
this.configMapDR = new ConfigMapDependentResource();
this.deploymentDR = new DeploymentDependentResource();
this.serviceDR = new ServiceDependentResource();
this.ingressDR = new IngressDependentResource();


Arrays.asList(configMapDR, deploymentDR, serviceDR, ingressDR).forEach(dr -> {
dr.setKubernetesClient(client);
dr.configureWith(new KubernetesDependentResourceConfig()
.setLabelSelector(SELECTOR + "=true"));
dr.configureWith(new KubernetesDependentResourceConfigBuilder()
.withLabelSelector(SELECTOR + "=true").build());
});
}



}