DBZ-8090 Moves embedded passthru properties topics to their own files

This commit is contained in:
roldanbob 2024-08-23 00:16:02 -04:00
parent c60b03935a
commit ec1db6e50c
3 changed files with 8 additions and 32 deletions

View File

@ -64,32 +64,3 @@ Specify one of the following values:
`false`:: The connector records schema structures for all logical databases. +
|===
[id="{context}-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients"]
.Pass-through database schema history properties for configuring producer and consumer clients
{empty} +
{prodname} relies on a Kafka producer to write schema changes to database schema history topics.
Similarly, it relies on a Kafka consumer to read from database schema history topics when a connector starts.
You define the configuration for the Kafka producer and consumer clients by assigning values to a set of pass-through configuration properties that begin with the `schema.history.internal.producer.\*` and `schema.history.internal.consumer.*` prefixes.
The pass-through producer and consumer database schema history properties control a range of behaviors, such as how these clients secure connections with the Kafka broker, as shown in the following example:
[source,indent=0]
----
schema.history.internal.producer.security.protocol=SSL
schema.history.internal.producer.ssl.keystore.location=/var/private/ssl/kafka.server.keystore.jks
schema.history.internal.producer.ssl.keystore.password=test1234
schema.history.internal.producer.ssl.truststore.location=/var/private/ssl/kafka.server.truststore.jks
schema.history.internal.producer.ssl.truststore.password=test1234
schema.history.internal.producer.ssl.key.password=test1234
schema.history.internal.consumer.security.protocol=SSL
schema.history.internal.consumer.ssl.keystore.location=/var/private/ssl/kafka.server.keystore.jks
schema.history.internal.consumer.ssl.keystore.password=test1234
schema.history.internal.consumer.ssl.truststore.location=/var/private/ssl/kafka.server.truststore.jks
schema.history.internal.consumer.ssl.truststore.password=test1234
schema.history.internal.consumer.ssl.key.password=test1234
----
{prodname} strips the prefix from the property name before it passes the property to the Kafka client.
See the Kafka documentation for more details about link:https://kafka.apache.org/documentation.html#producerconfigs[Kafka producer configuration properties] and link:https://kafka.apache.org/documentation.html#consumerconfigs[Kafka consumer configuration properties].

View File

@ -1,4 +1,4 @@
The following table describes the `notification` properties.
The following table describes properties that you can use to configure the {prodname} sink `notification` channel.
.Sink notification configuration properties
[cols="33%a,17%a,50%a",options="header",subs="+attributes"]
@ -6,6 +6,6 @@ The following table describes the `notification` properties.
|Property |Default |Description
|[[{context}-property-notification-sink-topic-name]]<<{context}-property-notification-sink-topic-name, `+notification.sink.topic.name+`>>
|No default
|The name of the topic that receives notifications from {prodname}.
|The name of the topic that receives notifications from {prodname}.
This property is required when you configure the xref:{context}-property-notification-enabled-channels[`notification.enabled.channels`] property to include `sink` as one of the enabled notification channels.
|===
|===

View File

@ -0,0 +1,5 @@
The {prodname} connector provides for pass-through configuration of the signals Kafka consumer.
Pass-through signals properties begin with the prefix `signals.consumer.*`.
For example, the connector passes properties such as `signal.consumer.security.protocol=SSL` to the Kafka consumer.
{prodname} strips the prefixes from the properties before it passes the properties to the Kafka signals consumer.