From ec1db6e50c1b17ef2e512399e5d7ed419a7c77cd Mon Sep 17 00:00:00 2001 From: roldanbob Date: Fri, 23 Aug 2024 00:16:02 -0400 Subject: [PATCH] DBZ-8090 Moves embedded passthru properties topics to their own files --- ...iguration-database-history-properties.adoc | 29 ------------------- ...notification-configuration-properties.adoc | 6 ++-- ...fka-consumer-configuration-properties.adoc | 5 ++++ 3 files changed, 8 insertions(+), 32 deletions(-) create mode 100644 documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-signals-kafka-consumer-configuration-properties.adoc diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-configuration-database-history-properties.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-configuration-database-history-properties.adoc index 6603dda36..e85ba84b1 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-configuration-database-history-properties.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-configuration-database-history-properties.adoc @@ -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]. diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc index 999e70d3f..261fa2182 100644 --- a/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc +++ b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc @@ -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. -|=== \ No newline at end of file +|=== diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-signals-kafka-consumer-configuration-properties.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-signals-kafka-consumer-configuration-properties.adoc new file mode 100644 index 000000000..8b471d3cd --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-signals-kafka-consumer-configuration-properties.adoc @@ -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.