From e950100099dc0b395208d2ea99e8056850103615 Mon Sep 17 00:00:00 2001 From: roldanbob Date: Tue, 20 Aug 2024 22:50:46 -0400 Subject: [PATCH] DBZ-8090 Split content off to new file and add via include directives --- .../modules/ROOT/pages/connectors/db2.adoc | 10 +++++++- .../ROOT/pages/connectors/informix.adoc | 15 ++++++++--- .../ROOT/pages/connectors/mariadb.adoc | 6 +++++ .../modules/ROOT/pages/connectors/mysql.adoc | 7 ++++++ .../modules/ROOT/pages/connectors/oracle.adoc | 7 ++++++ .../ROOT/pages/connectors/postgresql.adoc | 6 +++++ .../ROOT/pages/connectors/sqlserver.adoc | 7 +++++- ...iguring-producer-and-consumer-clients.adoc | 25 +++++++++++++++++++ 8 files changed, 77 insertions(+), 6 deletions(-) create mode 100644 documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc diff --git a/documentation/modules/ROOT/pages/connectors/db2.adoc b/documentation/modules/ROOT/pages/connectors/db2.adoc index 80bec7683..977ec2276 100644 --- a/documentation/modules/ROOT/pages/connectors/db2.adoc +++ b/documentation/modules/ROOT/pages/connectors/db2.adoc @@ -2418,7 +2418,8 @@ Information about the properties is organized as follows: * xref:db2-required-configuration-properties[Required configuration properties] * xref:db2-advanced-configuration-properties[Advanced configuration properties] * xref:debezium-db2-connector-database-history-configuration-properties[Database schema history connector configuration properties] that control how {prodname} processes events that it reads from the database schema history topic. -** xref:debezium-db2-connector-pass-through-database-driver-configuration-properties[Pass-through database schema history properties] +* xref:debezium-db2-connector-pass-through-database-driver-configuration-properties[Pass-through database schema history properties] +* xref:db2-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients[Pass-through database schema history properties] * xref:debezium-db2-connector-pass-through-database-driver-configuration-properties[Pass-through database driver properties] that control the behavior of the database driver. @@ -3121,11 +3122,18 @@ include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-s include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1] +[id="debezium-db2-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients"] +==== Pass-through database schema history properties for configuring producer and consumer clients + +include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc[leveloffset=+1] + [id="debezium-db2-connector-pass-through-database-driver-configuration-properties"] ==== {prodname} connector pass-through database driver configuration properties include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-driver-configuration-properties.adoc[leveloffset=+1] + + // Type: assembly // ModuleID: monitoring-debezium-db2-connector-performance // Title: Monitoring {prodname} Db2 connector performance diff --git a/documentation/modules/ROOT/pages/connectors/informix.adoc b/documentation/modules/ROOT/pages/connectors/informix.adoc index 7a5e9be0f..fdebaac93 100644 --- a/documentation/modules/ROOT/pages/connectors/informix.adoc +++ b/documentation/modules/ROOT/pages/connectors/informix.adoc @@ -1967,7 +1967,9 @@ Information about the properties is organized as follows: * xref:informix-required-configuration-properties[Required configuration properties] * xref:informix-advanced-configuration-properties[Advanced configuration properties] * xref:debezium-informix-connector-database-history-configuration-properties[Database schema history connector configuration properties] that control how {prodname} processes events that it reads from the database schema history topic. -** xref:debezium-informix-connector-pass-through-database-driver-configuration-properties[Pass-through database schema history properties] +* xref:debezium-informix-connector-kafka-signals-configuration-properties[Kafka signals configuration properties] +* xref:debezium-informix-connector-kafka-notifications-configuration-properties[Sink notifications configuration properties] +* xref:debezium-informix-connector-pass-through-database-schema-history-properties[Pass-through database schema history properties] * xref:debezium-informix-connector-pass-through-database-driver-configuration-properties[Pass-through database driver properties] that control the behavior of the database driver. @@ -2679,16 +2681,21 @@ Set the value to `0` (zero) to remove the timeout limit. include::{partialsdir}/modules/all-connectors/ref-connector-configuration-database-history-properties.adoc[leveloffset=+1] -[id="debezium-{context}-connector-kafka-signals-configuration-properties"] +[id="debezium-informix-connector-kafka-signals-configuration-properties"] ==== {prodname} connector Kafka signals configuration properties include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc[leveloffset=+1] -[id="debezium-{context}-connector-kafka-notifications-configuration-properties"] -==== {prodname} connector sink notifications configuration properties +[id="debezium-informix-connector-kafka-notifications-configuration-properties"] +==== Pass-through Kafka sink notification configuration properties include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1] +[id="debezium-informix-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients"] +==== Pass-through database schema history properties for configuring producer and consumer clients + +include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc[leveloffset=+1] + [id="debezium-informix-connector-pass-through-database-driver-configuration-properties"] ==== {prodname} connector pass-through database driver configuration properties diff --git a/documentation/modules/ROOT/pages/connectors/mariadb.adoc b/documentation/modules/ROOT/pages/connectors/mariadb.adoc index 13fe58d9b..2b39b381b 100644 --- a/documentation/modules/ROOT/pages/connectors/mariadb.adoc +++ b/documentation/modules/ROOT/pages/connectors/mariadb.adoc @@ -455,6 +455,12 @@ include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-s include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1] + +[id="debezium-mariadb-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients"] +==== Pass-through database schema history properties for configuring producer and consumer clients + +include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc[leveloffset=+1] + [id="debezium-mariadb-connector-pass-through-database-driver-configuration-properties"] ==== {prodname} connector pass-through database driver configuration properties diff --git a/documentation/modules/ROOT/pages/connectors/mysql.adoc b/documentation/modules/ROOT/pages/connectors/mysql.adoc index 67ccb877c..ea5f28b25 100644 --- a/documentation/modules/ROOT/pages/connectors/mysql.adoc +++ b/documentation/modules/ROOT/pages/connectors/mysql.adoc @@ -549,11 +549,18 @@ include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-s include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1] +[id="debezium-mysql-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients"] +==== Pass-through database schema history properties for configuring producer and consumer clients + +include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc[leveloffset=+1] + [id="debezium-{context}-connector-pass-through-database-driver-configuration-properties"] ==== {prodname} connector pass-through database driver configuration properties include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-driver-configuration-properties.adoc[leveloffset=+1] + + // Type: assembly // ModuleID: monitoring-debezium-mysql-connector-performance // Title: Monitoring {prodname} MySQL connector performance diff --git a/documentation/modules/ROOT/pages/connectors/oracle.adoc b/documentation/modules/ROOT/pages/connectors/oracle.adoc index c314710f8..86d45c367 100644 --- a/documentation/modules/ROOT/pages/connectors/oracle.adoc +++ b/documentation/modules/ROOT/pages/connectors/oracle.adoc @@ -4284,11 +4284,18 @@ include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-s include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1] +[id="db2-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients"] +==== Pass-through database schema history properties for configuring producer and consumer clients + +include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc[leveloffset=+1] + [id="debezium-oracle-connector-pass-through-database-driver-configuration-properties"] ==== {prodname} Oracle connector pass-through database driver configuration properties include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-driver-configuration-properties.adoc[leveloffset=+1] + + // Type: assembly // ModuleID: monitoring-debezium-oracle-connector-performance // Title: Monitoring {prodname} Oracle connector performance diff --git a/documentation/modules/ROOT/pages/connectors/postgresql.adoc b/documentation/modules/ROOT/pages/connectors/postgresql.adoc index 14a916aa2..ba20dcff3 100644 --- a/documentation/modules/ROOT/pages/connectors/postgresql.adoc +++ b/documentation/modules/ROOT/pages/connectors/postgresql.adoc @@ -3820,6 +3820,12 @@ include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-s include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1] + +[id="postgresql-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients"] +==== Pass-through database schema history properties for configuring producer and consumer clients + +include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc[leveloffset=+1] + [id="debezium-{context}-connector-pass-through-database-driver-configuration-properties"] ==== {prodname} connector pass-through database driver configuration properties diff --git a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc index e1114c14b..c4f2b876f 100644 --- a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc +++ b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc @@ -3322,12 +3322,17 @@ include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-s include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1] + +[id="sqlserver-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients"] +==== Pass-through database schema history properties for configuring producer and consumer clients + +include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc[leveloffset=+1] + [id="debezium-sqlserver-connector-pass-through-database-driver-configuration-properties"] ==== {prodname} SQL Server connector pass-through database driver configuration properties include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-database-driver-configuration-properties.adoc[leveloffset=+1] - // Type: assembly // ModuleID: refreshing-capture-tables-after-a-schema-change // Title: Refreshing capture tables after a schema change diff --git a/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc new file mode 100644 index 000000000..24894581b --- /dev/null +++ b/documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-pass-through-database-history-properties-for-configuring-producer-and-consumer-clients.adoc @@ -0,0 +1,25 @@ +{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].