io.strimzi.api.kafka.model.KafkaConnectSpec Maven / Gradle / Ivy
/*
* Copyright Strimzi authors.
* License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
*/
package io.strimzi.api.kafka.model;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import io.fabric8.kubernetes.api.model.Affinity;
import io.fabric8.kubernetes.api.model.ResourceRequirements;
import io.fabric8.kubernetes.api.model.Toleration;
import io.strimzi.api.annotations.DeprecatedProperty;
import io.strimzi.api.kafka.model.authentication.KafkaClientAuthentication;
import io.strimzi.api.kafka.model.connect.ExternalConfiguration;
import io.strimzi.api.kafka.model.template.KafkaConnectTemplate;
import io.strimzi.api.kafka.model.tracing.Tracing;
import io.strimzi.crdgenerator.annotations.Description;
import io.strimzi.crdgenerator.annotations.KubeLink;
import io.sundr.builder.annotations.Buildable;
import io.vertx.core.cli.annotations.DefaultValue;
import lombok.EqualsAndHashCode;
import java.io.Serializable;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@Buildable(
editableEnabled = false,
generateBuilderPackage = false,
builderPackage = "io.fabric8.kubernetes.api.builder"
)
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({ "replicas", "config", "image",
"livenessProbe", "readinessProbe", "jvmOptions",
"affinity", "tolerations", "logging", "metrics", "tracing", "template"})
@EqualsAndHashCode(doNotUseGetters = true)
public class KafkaConnectSpec implements Serializable, UnknownPropertyPreserving {
private static final long serialVersionUID = 1L;
public static final String FORBIDDEN_PREFIXES = "ssl., sasl., security., listeners, plugin.path, rest., bootstrap.servers, consumer.interceptor.classes, producer.interceptor.classes";
public static final String FORBIDDEN_PREFIX_EXCEPTIONS = "ssl.endpoint.identification.algorithm";
private Map config = new HashMap<>(0);
private Logging logging;
private Integer replicas;
private String version;
private String image;
private ResourceRequirements resources;
private Probe livenessProbe;
private Probe readinessProbe;
private JvmOptions jvmOptions;
private Map metrics;
private Tracing tracing;
private Affinity affinity;
private List tolerations;
private String bootstrapServers;
private KafkaConnectTls tls;
private KafkaClientAuthentication authentication;
private KafkaConnectTemplate template;
private ExternalConfiguration externalConfiguration;
private Map additionalProperties = new HashMap<>(0);
@Description("The number of pods in the Kafka Connect group.")
@DefaultValue("3")
public Integer getReplicas() {
return replicas;
}
@Description("The Kafka Connect configuration. Properties with the following prefixes cannot be set: " + FORBIDDEN_PREFIXES)
public Map getConfig() {
return config;
}
public void setConfig(Map config) {
this.config = config;
}
@Description("Logging configuration for Kafka Connect")
@JsonInclude(value = JsonInclude.Include.NON_NULL)
public Logging getLogging() {
return logging == null ? new InlineLogging() : logging;
}
public void setLogging(Logging logging) {
this.logging = logging;
}
public void setReplicas(Integer replicas) {
this.replicas = replicas;
}
@Description("The Kafka Connect version. Defaults to {DefaultKafkaVersion}. " +
"Consult the user documentation to understand the process required to upgrade or downgrade the version.")
public String getVersion() {
return version;
}
public void setVersion(String version) {
this.version = version;
}
@Description("The docker image for the pods.")
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
public String getImage() {
return image;
}
public void setImage(String image) {
this.image = image;
}
@JsonInclude(JsonInclude.Include.NON_NULL)
@Description("CPU and memory resources to reserve.")
public ResourceRequirements getResources() {
return resources;
}
public void setResources(ResourceRequirements resources) {
this.resources = resources;
}
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@Description("Pod liveness checking.")
public Probe getLivenessProbe() {
return livenessProbe;
}
public void setLivenessProbe(Probe livenessProbe) {
this.livenessProbe = livenessProbe;
}
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
@Description("Pod readiness checking.")
public Probe getReadinessProbe() {
return readinessProbe;
}
public void setReadinessProbe(Probe readinessProbe) {
this.readinessProbe = readinessProbe;
}
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@Description("JVM Options for pods")
public JvmOptions getJvmOptions() {
return jvmOptions;
}
public void setJvmOptions(JvmOptions jvmOptions) {
this.jvmOptions = jvmOptions;
}
@JsonInclude(JsonInclude.Include.NON_NULL)
@Description("The Prometheus JMX Exporter configuration. " +
"See https://github.com/prometheus/jmx_exporter for details of the structure of this configuration.")
public Map getMetrics() {
return metrics;
}
public void setMetrics(Map metrics) {
this.metrics = metrics;
}
@JsonInclude(JsonInclude.Include.NON_NULL)
@Description("The configuration of tracing in Kafka Connect.")
public Tracing getTracing() {
return tracing;
}
public void setTracing(Tracing tracing) {
this.tracing = tracing;
}
@Description("The pod's affinity rules.")
@KubeLink(group = "core", version = "v1", kind = "affinity")
@JsonInclude(JsonInclude.Include.NON_NULL)
@DeprecatedProperty(movedToPath = "spec.template.pod.affinity")
@Deprecated
public Affinity getAffinity() {
return affinity;
}
@Deprecated
public void setAffinity(Affinity affinity) {
this.affinity = affinity;
}
@Description("The pod's tolerations.")
@KubeLink(group = "core", version = "v1", kind = "toleration")
@JsonInclude(JsonInclude.Include.NON_NULL)
@DeprecatedProperty(movedToPath = "spec.template.pod.tolerations")
@Deprecated
public List getTolerations() {
return tolerations;
}
@Deprecated
public void setTolerations(List tolerations) {
this.tolerations = tolerations;
}
@Description("Bootstrap servers to connect to. This should be given as a comma separated list of __:\u200D__ pairs.")
@JsonProperty(required = true)
public String getBootstrapServers() {
return bootstrapServers;
}
public void setBootstrapServers(String bootstrapServers) {
this.bootstrapServers = bootstrapServers;
}
@Description("TLS configuration")
@JsonInclude(JsonInclude.Include.NON_NULL)
public KafkaConnectTls getTls() {
return tls;
}
public void setTls(KafkaConnectTls tls) {
this.tls = tls;
}
@Description("Authentication configuration for Kafka Connect")
@JsonInclude(JsonInclude.Include.NON_NULL)
public KafkaClientAuthentication getAuthentication() {
return authentication;
}
public void setAuthentication(KafkaClientAuthentication authentication) {
this.authentication = authentication;
}
@Description("Template for Kafka Connect and Kafka Connect S2I resources. " +
"The template allows users to specify how is the `Deployment`, `Pods` and `Service` generated.")
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public KafkaConnectTemplate getTemplate() {
return template;
}
public void setTemplate(KafkaConnectTemplate template) {
this.template = template;
}
@Description("Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.")
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public ExternalConfiguration getExternalConfiguration() {
return externalConfiguration;
}
public void setExternalConfiguration(ExternalConfiguration externalConfiguration) {
this.externalConfiguration = externalConfiguration;
}
@Override
public Map getAdditionalProperties() {
return this.additionalProperties;
}
@Override
public void setAdditionalProperty(String name, Object value) {
this.additionalProperties.put(name, value);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy