DBZ-1944 moving files that are used only in includes to partials

... so that Antora doesn't create a separate page for them that would be meaningless or confusing to users or search engines
This commit is contained in:
Alexander Schwartz 2020-04-08 22:26:47 +02:00 committed by Gunnar Morling
parent 1e19270981
commit 13dbc1f31c
70 changed files with 80 additions and 80 deletions

View File

@ -11,10 +11,10 @@
toc::[]
include::../../modules/cdc-mysql-connector/r_configuration-and-startup-errors.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/r_configuration-and-startup-errors.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/r_mysql-is-unavailable.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/r_mysql-is-unavailable.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/r_kafka-connect-stops.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/r_kafka-connect-stops.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/r_mysql-purges-binlog-files.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/r_mysql-purges-binlog-files.adoc[leveloffset=+1]

View File

@ -11,10 +11,10 @@
toc::[]
include::../../modules/cdc-mysql-connector/p_install-the-mysql-connector.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/p_install-the-mysql-connector.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/p_configure-the-mysql-connector.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/p_configure-the-mysql-connector.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/r_mysql-connector-configuration-properties.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/r_mysql-connector-configuration-properties.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/r_mysql-connector-monitoring-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/r_mysql-connector-monitoring-metrics.adoc[leveloffset=+1]

View File

@ -13,16 +13,16 @@ toc::[]
The {prodname} MySQL connector tracks the structure of the tables, performs snapshots, transforms binlog events into {prodname} change events and records where those events are recorded in Kafka.
include::../../modules/cdc-mysql-connector/c_how-the-mysql-connector-uses-database-schemas.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/c_how-the-mysql-connector-uses-database-schemas.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/c_how-the-mysql-connector-performs-database-snapshots.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/c_how-the-mysql-connector-performs-database-snapshots.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/c_how-the-mysql-connector-handles-schema-change-topics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/c_how-the-mysql-connector-handles-schema-change-topics.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/c_mysql-connector-events.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/c_mysql-connector-events.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/c_how-the-mysql-connector-maps-data-types.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/c_how-the-mysql-connector-maps-data-types.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/r_the-mysql-connector-and-kafka-topics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/r_the-mysql-connector-and-kafka-topics.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/r_mysql-supported-topologies.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/r_mysql-supported-topologies.adoc[leveloffset=+1]

View File

@ -11,12 +11,12 @@
toc::[]
include::../../modules/cdc-mysql-connector/p_create-a-mysql-user-for-cdc.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/p_create-a-mysql-user-for-cdc.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/p_enable-the-mysql-binlog-for-cdc.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/p_enable-the-mysql-binlog-for-cdc.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/p_enable-mysql-gtids-for-cdc.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/p_enable-mysql-gtids-for-cdc.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/p_setup-session-timeouts-for-cdc.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/p_setup-session-timeouts-for-cdc.adoc[leveloffset=+1]
include::../../modules/cdc-mysql-connector/p_enable-query-log-events-for-cdc.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-mysql-connector/p_enable-query-log-events-for-cdc.adoc[leveloffset=+1]

View File

@ -1,13 +0,0 @@
:context: debezium
[id="enabling-jmx-local-installation"]
= Enabling JMX in local installations
With Zookeeper, Kafka, and Kafka Connect,
you enable JMX by setting the appropriate environment variables when you start each service.
include::../../modules/monitoring/r_zookeeper-jmx-environment-variables.adoc[leveloffset=+1]
include::../../modules/monitoring/r_kafka-jmx-environment-variables.adoc[leveloffset=+1]
include::../../modules/monitoring/r_kafka-connect-jmx-environment-variables.adoc[leveloffset=+1]

View File

@ -1171,7 +1171,7 @@ Please refer to the xref:operations/monitoring.adoc[monitoring documentation] fo
The *MBean* is `debezium.db2:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
[[monitoring-streaming]]
[[streaming-metrics]]
@ -1179,7 +1179,7 @@ include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.a
The *MBean* is `debezium.db2:type=connector-metrics,context=streaming,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
[[monitoring-schema-history]]
[[schema-history-metrics]]
@ -1187,7 +1187,7 @@ include::../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.
The *MBean* is `debezium.db2:type=connector-metrics,context=schema-history,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
[[connector-properties]]
=== Connector properties

View File

@ -631,7 +631,7 @@ Please refer to the xref:operations/monitoring.adoc[monitoring documentation] fo
The *MBean* is `debezium.mongodb:type=connector-metrics,context=snapshot,server=_<mongodb.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
[[monitoring-streaming]]
[[streaming-metrics]]
@ -639,7 +639,7 @@ include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.a
The *MBean* is `debezium.sql_server:type=connector-metrics,context=streaming,server=_<mongodb.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
[[mongodb-connector-properties]]
=== Connector properties

View File

@ -923,7 +923,7 @@ Please refer to the xref:operations/monitoring.adoc[monitoring documentation] fo
The *MBean* is `debezium.oracle:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
[[monitoring-streaming]]
[[streaming-metrics]]
@ -931,7 +931,7 @@ include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.a
The *MBean* is `debezium.oracle:type=connector-metrics,context=streaming,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
[[monitoring-schema-history]]
[[schema-history-metrics]]
@ -939,7 +939,7 @@ include::../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.
The *MBean* is `debezium.mysql:type=connector-metrics,context=schema-history,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
[[connector-properties]]
=== Connector Properties

View File

@ -1649,7 +1649,7 @@ Please refer to the xref:operations/monitoring.adoc[monitoring documentation] fo
The *MBean* is `debezium.postgres:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
[[monitoring-streaming]]
[[streaming-metrics]]
@ -1657,7 +1657,7 @@ include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.a
The *MBean* is `debezium.postres:type=connector-metrics,context=streaming,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
[[connector-properties]]
=== Connector Properties

View File

@ -1147,7 +1147,7 @@ Please refer to the xref:operations/monitoring.adoc[monitoring documentation] fo
The *MBean* is `debezium.sql_server:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
[[monitoring-streaming]]
[[streaming-metrics]]
@ -1155,7 +1155,7 @@ include::../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.a
The *MBean* is `debezium.sql_server:type=connector-metrics,context=streaming,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
[[monitoring-schema-history]]
[[schema-history-metrics]]
@ -1163,7 +1163,7 @@ include::../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.
The *MBean* is `debezium.sql_server:type=connector-metrics,context=schema-history,server=_<database.server.name>_`.
include::../modules/cdc-all-connectors/r_connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
[[sqlserver-connector-properties]]
=== Connector properties

View File

@ -19,10 +19,10 @@ This is often sufficient when the connector is operating normally,
but may not be enough when the connector is behaving unexpectedly.
In such cases, you can change the logging level so that the connector generates much more verbose log messages describing what the connector is doing and what it is not doing.
include::../modules/logging/c_logging-concepts.adoc[leveloffset=+1]
include::{partialsdir}/modules/logging/c_logging-concepts.adoc[leveloffset=+1]
include::../modules/logging/c_understanding-default-logging-configuration.adoc[leveloffset=+1]
include::{partialsdir}/modules/logging/c_understanding-default-logging-configuration.adoc[leveloffset=+1]
include::../assemblies/logging/as_configuring-logging.adoc[leveloffset=+1]
include::{partialsdir}/assemblies/logging/as_configuring-logging.adoc[leveloffset=+1]
include::../modules/logging/p_configuring-log-level-docker.adoc[leveloffset=+1]
include::{partialsdir}/modules/logging/p_configuring-log-level-docker.adoc[leveloffset=+1]

View File

@ -18,10 +18,10 @@ If you are running multiple services on the same machine,
be sure to use distinct JMX ports for each service.
====
include::../modules/monitoring/c_metrics-monitoring-connectors.adoc[leveloffset=+1]
include::{partialsdir}/modules/monitoring/c_metrics-monitoring-connectors.adoc[leveloffset=+1]
include::../assemblies/monitoring/as_enabling-jmx-local-installations.adoc[leveloffset=+1]
include::{partialsdir}/assemblies/monitoring/as_enabling-jmx-local-installations.adoc[leveloffset=+1]
include::../assemblies/monitoring/as_enabling-jmx-docker.adoc[leveloffset=+1]
include::{partialsdir}/assemblies/monitoring/as_enabling-jmx-docker.adoc[leveloffset=+1]
include::../modules/monitoring/c_using-prometheus-grafana.adoc[leveloffset=+1]
include::{partialsdir}/modules/monitoring/c_using-prometheus-grafana.adoc[leveloffset=+1]

View File

@ -30,14 +30,14 @@ For more information, see link:https://docs.docker.com/engine/installation/[the
For this tutorial, do not run Docker in a virtual machine (using Docker Machine).
====
include::modules/tutorial/c_introduction-debezium.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/c_introduction-debezium.adoc[leveloffset=+1]
include::assemblies/tutorial/as_starting-services.adoc[leveloffset=+1]
include::{partialsdir}/assemblies/tutorial/as_starting-services.adoc[leveloffset=+1]
include::assemblies/tutorial/as_deploying-mysql-connector.adoc[leveloffset=+1]
include::{partialsdir}/assemblies/tutorial/as_deploying-mysql-connector.adoc[leveloffset=+1]
include::assemblies/tutorial/as_viewing-change-events.adoc[leveloffset=+1]
include::{partialsdir}/assemblies/tutorial/as_viewing-change-events.adoc[leveloffset=+1]
include::modules/tutorial/p_cleaning-up.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_cleaning-up.adoc[leveloffset=+1]
include::modules/tutorial/c_next-steps.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/c_next-steps.adoc[leveloffset=+1]

View File

@ -14,6 +14,6 @@ For more information about using Log4j,
search for tutorials to set up and use appenders to send log messages to specific destinations.
====
include::../../modules/logging/p_changing-logging-level.adoc[leveloffset=+1]
include::{partialsdir}/modules/logging/p_changing-logging-level.adoc[leveloffset=+1]
include::../../modules/logging/p_adding-mapped-diagnostic-contexts.adoc[leveloffset=+1]
include::{partialsdir}/modules/logging/p_adding-mapped-diagnostic-contexts.adoc[leveloffset=+1]

View File

@ -10,8 +10,8 @@ Thus, {prodname}'s Docker images for Zookeeper, Kafka, and Kafka Connect use sev
Most of the environment variables are the same for all of the images,
but there are some minor differences.
include::../../modules/monitoring/r_zookeeper-jmx-environment-variables-docker.adoc[leveloffset=+1]
include::{partialsdir}/modules/monitoring/r_zookeeper-jmx-environment-variables-docker.adoc[leveloffset=+1]
include::../../modules/monitoring/r_kafka-jmx-environment-variables-docker.adoc[leveloffset=+1]
include::{partialsdir}/modules/monitoring/r_kafka-jmx-environment-variables-docker.adoc[leveloffset=+1]
include::../../modules/monitoring/r_kafka-connect-jmx-environment-variables-docker.adoc[leveloffset=+1]
include::{partialsdir}/modules/monitoring/r_kafka-connect-jmx-environment-variables-docker.adoc[leveloffset=+1]

View File

@ -0,0 +1,13 @@
:context: debezium
[id="enabling-jmx-local-installation"]
= Enabling JMX in local installations
With Zookeeper, Kafka, and Kafka Connect,
you enable JMX by setting the appropriate environment variables when you start each service.
include::{partialsdir}/modules/monitoring/r_zookeeper-jmx-environment-variables.adoc[leveloffset=+1]
include::{partialsdir}/modules/monitoring/r_kafka-jmx-environment-variables.adoc[leveloffset=+1]
include::{partialsdir}/modules/monitoring/r_kafka-connect-jmx-environment-variables.adoc[leveloffset=+1]

View File

@ -25,6 +25,6 @@ it will start monitoring the database server's `binlog` and it will generate cha
+
Reviewing the Kafka Connect log output as the connector starts helps you to better understand each task it must complete before it can start monitoring the `binlog`.
include::../../modules/tutorial/p_registering-connector-monitor-inventory-database.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_registering-connector-monitor-inventory-database.adoc[leveloffset=+1]
include::../../modules/tutorial/r_watching-connector-start-up.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/r_watching-connector-start-up.adoc[leveloffset=+1]

View File

@ -20,14 +20,14 @@ To start the services needed for this tutorial, you must:
* xref:starting-mysql-command-line-client[Start a MySQL command line client]
* xref:starting-kafka-connect[Start Kafka Connect]
include::../../modules/tutorial/c_considerations-running-debezium-with-docker.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/c_considerations-running-debezium-with-docker.adoc[leveloffset=+1]
include::../../modules/tutorial/p_starting-zookeeper.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_starting-zookeeper.adoc[leveloffset=+1]
include::../../modules/tutorial/p_starting-kafka.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_starting-kafka.adoc[leveloffset=+1]
include::../../modules/tutorial/p_starting-mysql-database.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_starting-mysql-database.adoc[leveloffset=+1]
include::../../modules/tutorial/p_starting-mysql-command-line-client.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_starting-mysql-command-line-client.adoc[leveloffset=+1]
include::../../modules/tutorial/p_starting-kafka-connect.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_starting-kafka-connect.adoc[leveloffset=+1]

View File

@ -36,10 +36,10 @@ In this topic, you will see different types of change events to see how the conn
* xref:deleting-record-database-viewing-delete-event[Deleting a record in the database and viewing the _delete_ event]
* xref:restarting-kafka-connect-service[Restarting Kafka Connect and changing the database]
include::../../modules/tutorial/p_viewing-create-event.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_viewing-create-event.adoc[leveloffset=+1]
include::../../modules/tutorial/p_updating-database-viewing-update-event.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_updating-database-viewing-update-event.adoc[leveloffset=+1]
include::../../modules/tutorial/p_deleting-record-database-viewing-delete-event.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_deleting-record-database-viewing-delete-event.adoc[leveloffset=+1]
include::../../modules/tutorial/p_restarting-kafka-connect-service.adoc[leveloffset=+1]
include::{partialsdir}/modules/tutorial/p_restarting-kafka-connect-service.adoc[leveloffset=+1]

View File

@ -17,7 +17,7 @@ Please refer to the xref:operations/monitoring.adoc[monitoring documentation] fo
The *MBean* is `debezium.mysql:type=connector-metrics,context=snapshot,server=<database.server.name>`.
include::../../modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
The {prodname} MySQL connector also provides the following custom snapshot metrics:
@ -39,7 +39,7 @@ The *MBean* is `debezium.mysql:type=connector-metrics,context=binlog,server=<dat
NOTE: The transaction-related attributes are only available if binlog event buffering is enabled. See xref:assemblies/cdc-mysql-connector/as_deploy-the-mysql-connector.adoc#mysql-connector-configuration-properties_{context}[binlog.buffer.size] in the advanced connector configuration properties for more details.
include::../../modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
The {prodname} MySQL connector also provides the following custom binlog metrics:
@ -98,4 +98,4 @@ The {prodname} MySQL connector also provides the following custom binlog metrics
The *MBean* is `debezium.mysql:type=connector-metrics,context=schema-history,server=<database.server.name>`.
include::../../modules/cdc-all-connectors/r_connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
include::{partialsdir}/modules/cdc-all-connectors/r_connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]