reference.adoc

Debezium Operator Schema Reference

Condition Schema Reference

Used in: DebeziumServerStatus

Table 1. Condition properties

Property	Type	Default	Description
status	String		The status of the condition, either True, False or Unknown.
message	String		Human-readable message indicating details about the condition’s last transition.
type	String		Unique identifier of a condition.

ConfigMapOffsetStore Schema Reference

Used in: Offset

Table 2. ConfigMapOffsetStore properties

Property	Type	Default	Description
name	String		Name of the offset config map
config	Map		Additional store configuration properties.

ContainerEnvVar Schema Reference

Used in: RuntimeEnvironment

Table 3. ContainerEnvVar properties

Property	Type	Default	Description
name	String		The environment variable name.
value	String		The environment variable value.

ContainerTemplate Schema Reference

Used in: Templates

Table 4. ContainerTemplate properties

Property	Type	Default	Description
resources	ResourceRequirements		CPU and memory resource requirements.
securityContext	SecurityContext		Container security context.
probes	Probes		Container probes configuration.

CustomStore Schema Reference

Used in: Offset, SchemaHistory

Table 5. CustomStore properties

Property	Type	Default	Description
type	String		Fully qualified name of Java class implementing the store.
config	Map		Store configuration properties.

DataStorage Schema Reference

Used in: RuntimeStorage

Table 6. DataStorage properties

Property	Type	Default	Description
type	ephemeral,persistent	ephemeral	Storage type.
claimName	String		Name of persistent volume claim for persistent storage.

DebeziumServer Schema Reference

Table 7. DebeziumServer properties

Property	Type	Default	Description
spec	DebeziumServerSpec		The specification of Debezium Server
status	DebeziumServerStatus		The status of Debezium

DebeziumServerSpec Schema Reference

Used in: DebeziumServer

Table 8. DebeziumServerSpec properties

Property	Type	Default	Description
image	String		Image used for Debezium Server container. This property takes precedence over version.
version	String	same as operator	Version of Debezium Server to be used.
sink	Sink		Sink configuration.
source	Source		Debezium source connector configuration.
format	Format		Message output format configuration.
quarkus	Quarkus		Quarkus configuration passed down to Debezium Server process.
runtime	Runtime		Configuration allowing the modification of various aspects of Debezium Server runtime.
transforms	List<Transformation>		Single Message Transformations employed by this instance of Debezium Server.
predicates	Map<String, Predicate>		Predicates employed by this instance of Debezium Server.

DebeziumServerStatus Schema Reference

Used in: DebeziumServer

Table 9. DebeziumServerStatus properties

Property	Type	Default	Description
conditions	List<Condition>		List of status conditions
observedGeneration	Long	0L	Latest observed generation

FileOffsetStore Schema Reference

Used in: Offset

Table 10. FileOffsetStore properties

Property	Type	Default	Description
fileName	String		Name of the offset file (relative to data root)
config	Map		Additional store configuration properties.

FileSchemaHistoryStore Schema Reference

Used in: SchemaHistory

Table 11. FileSchemaHistoryStore properties

Property	Type	Default	Description
fileName	String		Name of the offset file (relative to data root)
config	Map		Additional store configuration properties.

Format Schema Reference

Used in: DebeziumServerSpec

Table 12. Format properties

Property	Type	Default	Description
key	FormatType		Message key format configuration.
value	FormatType		Message value format configuration.
header	FormatType		Message header format configuration.

FormatType Schema Reference

Used in: Format

Table 13. FormatType properties

Property	Type	Default	Description
type	String	json	Format type recognised by Debezium Server.
config	Map		Format configuration properties.

InMemoryOffsetStore Schema Reference

Used in: Offset

Table 14. InMemoryOffsetStore properties

Property	Type	Default	Description
config	Map		Additional store configuration properties.

InMemorySchemaHistoryStore Schema Reference

Used in: SchemaHistory

Table 15. InMemorySchemaHistoryStore properties

Property	Type	Default	Description
config	Map		Additional store configuration properties.

JdbcOffsetStore Schema Reference

Used in: Offset

Table 16. JdbcOffsetStore properties

Property	Type	Default	Description
table	JdbcOffsetTableConfig		The configuration of the offset table
url	String		JDBC connection URL
user	String		Username used to connect to the storage database
password	String		Password used to connect to the storage database
retryDelay	long		Retry delay on connection failure (in milliseconds)
maxRetries	int		Maximum number of retries on connection failure
config	Map		Additional store configuration properties.

JdbcOffsetTableConfig Schema Reference

Used in: JdbcOffsetStore

Table 17. JdbcOffsetTableConfig properties

Property	Type	Default	Description
name	String		The name of the offset table
ddl	String		DDL statement to create the offset table
select	String		Statement used to select from the offset table
insert	String		Statement used to insert into the offset table
delete	String		Statement used to update the offset table

JdbcSchemaHistoryStore Schema Reference

Used in: SchemaHistory

Table 18. JdbcSchemaHistoryStore properties

Property	Type	Default	Description
table	JdbcSchemaHistoryTableConfig		The configuration of the offset table
url	String		JDBC connection URL
user	String		Username used to connect to the storage database
password	String		Password used to connect to the storage database
retryDelay	long		Retry delay on connection failure (in milliseconds)
maxRetries	int		Maximum number of retries on connection failure
config	Map		Additional store configuration properties.

JdbcSchemaHistoryTableConfig Schema Reference

Used in: JdbcSchemaHistoryStore

Table 19. JdbcSchemaHistoryTableConfig properties

Property	Type	Default	Description
name	String		The name of the offset table
ddl	String		DDL statement to create the schema history table
select	String		Statement used to select from the schema history table
insert	String		Statement used to insert into the schema history table
dataExistsSelect	String		Statement used to check existence of some data in the schema history table

JmxAuthentication Schema Reference

Used in: JmxConfig

Table 20. JmxAuthentication properties

Property	Type	Default	Description
enabled	boolean	false	Whether JMX authentication should be enabled for this Debezium Server instance.
secret	String		Secret providing credential files
accessFile	String	jmxremote.access	JMX access file name and secret key
passwordFile	String	jmxremote.password	JMX password file name and secret key

JmxConfig Schema Reference

Used in: Runtime

Table 21. JmxConfig properties

Property	Type	Default	Description
enabled	boolean	false	Whether JMX should be enabled for this Debezium Server instance.
port	int	1099	JMX port.
authentication	JmxAuthentication		JMX authentication config.

JmxExporter Schema Reference

Used in: Metrics

Table 22. JmxExporter properties

Property	Type	Default	Description
enabled	boolean		Enables JMX Prometheus exporter
configFrom	ConfigMapKeySelector		Config map key reference which value will be used as configuration file

KafkaOffsetStore Schema Reference

Used in: Offset

Table 23. KafkaOffsetStore properties

Property	Type	Default	Description
props	Map		Additional Kafka client properties.
bootstrapServers	String		A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster
topic	String		The name of the Kafka topic where offsets are to be stored
partitions	int		The number of partitions used when creating the offset storage topic
replicationFactor	int		Replication factor used when creating the offset storage topic
config	Map		Additional store configuration properties.

KafkaSchemaHistoryStore Schema Reference

Used in: SchemaHistory

Table 24. KafkaSchemaHistoryStore properties

Property	Type	Default	Description
bootstrapServers	String		A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster
topic	String		The name of the Kafka topic where offsets are to be stored
partitions	int		The number of partitions used when creating the offset storage topic
replicationFactor	int		Replication factor used when creating the offset storage topic
config	Map		Additional store configuration properties.

MetadataTemplate Schema Reference

Used in: PodTemplate

Table 25. MetadataTemplate properties

Property	Type	Default	Description
labels	Map<String, String>		Labels added to the Kubernetes resource
annotations	Map<String, String>		Annotations added to the Kubernetes resource

Metrics Schema Reference

Used in: Runtime

Table 26. Metrics properties

Property	Type	Default	Description
jmxExporter	JmxExporter		Prometheus JMX exporter configuration

Offset Schema Reference

Used in: Source

Table 27. Offset properties

Property	Type	Default	Description
file	FileOffsetStore		File backed offset store configuration
memory	InMemoryOffsetStore		Memory backed offset store configuration
redis	RedisOffsetStore		Redis backed offset store configuration
kafka	KafkaOffsetStore		Kafka backing store configuration
jdbc	JdbcOffsetStore		JDBC backing store configuration
configMap	ConfigMapOffsetStore		Config map backed offset store configuration
store	CustomStore		Arbitrary offset store configuration
flushMs	long	60000	Interval at which to try commiting offsets

PodTemplate Schema Reference

Used in: Templates

Table 28. PodTemplate properties

Property	Type	Default	Description
metadata	MetadataTemplate		Metadata applied to the resource.
imagePullSecrets	List<LocalObjectReference>		List of local references to secrets used for pulling any of the images used by this Pod.
affinity	Affinity		Pod affinity rules
securityContext	PodSecurityContext		Pod-level security attributes and container settings

Predicate Schema Reference

Used in: DebeziumServerSpec

Table 29. Predicate properties

Property	Type	Default	Description
type	String		Fully qualified name of Java class implementing the predicate.
config	Map		Predicate configuration properties.

Probe Schema Reference

Used in: Probes

Table 30. Probe properties

Property	Type	Default	Description
initialDelaySeconds	int	5	Number of seconds after the container has started before probes are initiated.
periodSeconds	int	10	How often (in seconds) to perform the probe.
timeoutSeconds	int	10	Number of seconds after which the probe times out.
failureThreshold	int	3	Number of failures in a row before the overall check has failed.

Probes Schema Reference

Used in: ContainerTemplate

Table 31. Probes properties

Property	Type	Default	Description
readiness	Probe		Readiness probe configuration applied to the container.
liveness	Probe		Liveness probe configuration applied to the container.

Quarkus Schema Reference

Used in: DebeziumServerSpec

Table 32. Quarkus properties

Property	Type	Default	Description
config	Map		Quarkus configuration properties.

RedisOffsetStore Schema Reference

Used in: Offset

Table 33. RedisOffsetStore properties

Property	Type	Default	Description
address	String		Redis host:port used to connect
user	String		Redis username
password	String		Redis password
sslEnabled	boolean	false	Redis username
key	String		Redis hash key
wait	RedisStoreWaitConfig		Configures verification of replica writes
config	Map		Additional store configuration properties.

RedisSchemaHistoryStore Schema Reference

Used in: SchemaHistory

Table 34. RedisSchemaHistoryStore properties

Property	Type	Default	Description
address	String		Redis host:port used to connect
user	String		Redis username
password	String		Redis password
sslEnabled	boolean	false	Redis username
key	String		Redis hash key
wait	RedisStoreWaitConfig		Configures verification of replica writes
config	Map		Additional store configuration properties.

RedisStoreWaitConfig Schema Reference

Used in: RedisOffsetStore, RedisSchemaHistoryStore

Table 35. RedisStoreWaitConfig properties

Property	Type	Default	Description
enabled	boolean	false	In case of Redis with replica, this allows to verify that the data has been written to replica
timeoutMs	long	1000	Timeout in ms when waiting for replica
retry	boolean	false	Enables retry on wait for replica
retryDelayMs	long	1000	Delay of retry on wait

Runtime Schema Reference

Used in: DebeziumServerSpec

Table 36. Runtime properties

Property	Type	Default	Description
api	RuntimeApi		API configuration
storage	RuntimeStorage		Storage configuration
environment	RuntimeEnvironment		Additional environment variables used by this Debezium Server.
jmx	JmxConfig		JMX configuration.
templates	Templates		Debezium Server resource templates.
serviceAccount	String		An existing service account used to run the Debezium Server pod
metrics	Metrics		Metrics configuration

RuntimeApi Schema Reference

Used in: Runtime

Table 37. RuntimeApi properties

Property	Type	Default	Description
enabled	boolean		Whether the API should be enabled for this instance of Debezium Server
port	int	8080	Port number used by the k8s service exposing the API

RuntimeEnvironment Schema Reference

Used in: Runtime

Table 38. RuntimeEnvironment properties

Property	Type	Default	Description
vars	List<ContainerEnvVar>		Environment variables applied to the container.
from	List<EnvFromSource>		Additional environment variables set from ConfigMaps or Secrets in containers.

RuntimeStorage Schema Reference

Used in: Runtime

Table 39. RuntimeStorage properties

Property	Type	Default	Description
data	DataStorage		File storage configuration used by this instance of Debezium Server.
external	List<Volume>		Additional volumes mounted to /debezium/external

SchemaHistory Schema Reference

Used in: Source

Table 40. SchemaHistory properties

Property	Type	Default	Description
file	FileSchemaHistoryStore		File backed schema history store configuration
memory	InMemorySchemaHistoryStore		Memory backed schema history store configuration
redis	RedisSchemaHistoryStore		Redis backed schema history store configuration
kafka	KafkaSchemaHistoryStore		Kafka backed schema history store configuration
jdbc	JdbcSchemaHistoryStore		JDBC backed schema history store configuration
store	CustomStore		Arbitrary schema history store configuration
config	Map		Additional common schema history store configuration properties.

Sink Schema Reference

Used in: DebeziumServerSpec

Table 41. Sink properties

Property	Type	Default	Description
type	String		Sink type recognised by Debezium Server.
config	Map		Sink configuration properties.

Source Schema Reference

Used in: DebeziumServerSpec

Table 42. Source properties

Property	Type	Default	Description
sourceClass	String		Fully qualified name of source connector Java class.
offset	Offset		Offset store configuration
schemaHistory	SchemaHistory		Schema history store configuration
config	Map		Source connector configuration properties.

Templates Schema Reference

Used in: Runtime

Table 43. Templates properties

Property	Type	Default	Description
container	ContainerTemplate		Container template
pod	PodTemplate		Pod template.
volumeClaim	PersistentVolumeClaimSpec		PVC template for data volume if no explicit claim is specified.

Transformation Schema Reference

Used in: DebeziumServerSpec

Table 44. Transformation properties

Property	Type	Default	Description
type	String		Fully qualified name of Java class implementing the transformation.
predicate	String		The name of the predicate to be applied to this transformation.
negate	boolean	false	Determines if the result of the applied predicate will be negated.