Skip to content

Ignore user config provider aliases with conflict #11486

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Ignore user config provider aliases with conflict #11486

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97c7107
Ignore user config provider aliases with conflict
MichaelMorrisEst May 29, 2025
5a2831c
Addressed code review comment
MichaelMorrisEst Jun 11, 2025
087779e
Corrected javadoc comment
MichaelMorrisEst Jun 13, 2025
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
47 changes: 39 additions & 8 deletions ...ator/src/main/java/io/strimzi/operator/cluster/model/KafkaBrokerConfigurationBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,18 @@
import io.strimzi.operator.cluster.model.metrics.MetricsModel;
import io.strimzi.operator.cluster.model.metrics.StrimziMetricsReporterModel;
import io.strimzi.operator.common.Reconciliation;
import io.strimzi.operator.common.ReconciliationLogger;
import io.strimzi.operator.common.model.cruisecontrol.CruiseControlConfigurationParameters;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
Expand All @@ -58,6 +61,7 @@
* generate the configuration file, it is using the PrintWriter.
*/
public class KafkaBrokerConfigurationBuilder {
private final static ReconciliationLogger LOGGER = ReconciliationLogger.create(KafkaBrokerConfigurationBuilder.class.getName());
private final static String CONTROL_PLANE_LISTENER_NAME = "CONTROLPLANE-9090";
private final static String REPLICATION_LISTENER_NAME = "REPLICATION-9091";
// Names of environment variables expanded through config providers inside the Kafka node
Expand Down Expand Up @@ -780,16 +784,14 @@ private void configProviders(KafkaConfiguration userConfig) {
} else {
strimziConfigProviders = "strimzienv";
}

if (userConfig != null
&& !userConfig.getConfiguration().isEmpty()
&& userConfig.getConfigOption("config.providers") != null) {
writer.println("# Configuration providers configured by the user and by Strimzi");
writer.println("config.providers=" + userConfig.getConfigOption("config.providers") + "," + strimziConfigProviders);
userConfig.removeConfigOption("config.providers");
} else {

final String userConfigProviders = getUserConfigProviderAliases(strimziConfigProviders, userConfig);
if ("".equals(userConfigProviders)) {
writer.println("# Configuration providers configured by Strimzi");
writer.println("config.providers=" + strimziConfigProviders);
} else {
writer.println("# Configuration providers configured by the user and by Strimzi");
writer.println("config.providers=" + userConfigProviders + "," + strimziConfigProviders);
}

writer.println("config.providers.strimzienv.class=org.apache.kafka.common.config.provider.EnvVarConfigProvider");
Expand All @@ -805,6 +807,35 @@ private void configProviders(KafkaConfiguration userConfig) {

writer.println();
}

/**
* Get the user provided Kafka configuration provider aliases, dropping any that would overwrite the Strimzi defined configuration providers
*
* @param strimziConfigProviders The Strimzi defined configuration providers
* @param userConfig The user configuration to extract the possible user-provided config provider configuration from
* @return The user defined Kafka configuration provider aliases or empty string
*/
private String getUserConfigProviderAliases(String strimziConfigProviders, KafkaConfiguration userConfig) {
if (userConfig != null
&& !userConfig.getConfiguration().isEmpty()
&& userConfig.getConfigOption("config.providers") != null) {
Collection<String> userAliases = Arrays.asList(userConfig.getConfigOption("config.providers").split(","));
Collection<String> strimziAliases = Arrays.asList(strimziConfigProviders.split(","));

Set<String> validUserAliases = new HashSet<>();
userAliases.stream().forEach(alias -> {
if (strimziAliases.contains(alias)) {
LOGGER.warnCr(reconciliation, "config.provider " + alias + " ignored as it is not permitted. Not permitted aliases: " + strimziAliases);
userConfig.removeConfigOption("config.providers." + alias + ".class");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A simple warning log can be easily missed. Also, the operator should never change the user-provided configuration, even if it's wrong or conflicting.

As suggested in the bug report, we can raise an InvalidConfigurationException, and let the reconciliation fail. With that, the error would be logged and surfaced in the Kafka resource status. Wdyt?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if it is that simple, as we need to keep backwards compatibility in mind as well.

So what do we do today? IIRC, we just overwrite it? In which case warning while overwritting it is likely much better than failing the whole reconciliation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't overwrite. We keep both configurations and the user-provided one wins because it is applied last. Obviously, this make the operator fails if it is not compatible with what it expects (see the issue report). For this reason, I don't think there is a backwards compatibility issue raising an config exception. Of course, we can leave a release note about this change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I thought we just overwrote it. But if it is as you say, throwing the exception is good. Thanks for the clarification! 👍

} else {
validUserAliases.add(alias);
}
});
userConfig.removeConfigOption("config.providers");
return String.join(",", validUserAliases);
}
return "";
}

/**
* Adds the configurations passed by the user in the Kafka CR, injecting Strimzi configurations when needed.
Expand Down
3 changes: 2 additions & 1 deletion .../src/test/java/io/strimzi/operator/cluster/model/KafkaBrokerConfigurationBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,8 +569,9 @@ public void testUserConfiguration() {
@ParallelTest
public void testUserConfigurationWithConfigProviders() {
Map<String, Object> userConfiguration = new HashMap<>();
userConfiguration.put("config.providers", "env");
userConfiguration.put("config.providers", "env,strimzienv");
userConfiguration.put("config.providers.env.class", "org.apache.kafka.common.config.provider.EnvVarConfigProvider");
userConfiguration.put("config.providers.strimzienv.class", "org.apache.kafka.common.config.provider.UserConfigProvider");

KafkaConfiguration kafkaConfiguration = new KafkaConfiguration(Reconciliation.DUMMY_RECONCILIATION, userConfiguration.entrySet());

Expand Down
Loading