Skip to content

Commit e9862f2

Browse files
Adding configuration settings
1 parent 4b681fb commit e9862f2

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

  • content/en/docs/refguide/modeling/integration/change-data-capture

content/en/docs/refguide/modeling/integration/change-data-capture/_index.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,30 @@ To move the streamed data to a destination such as Azure Blob Storage or AWS S3,
3131
3. Deploy the app. The runtime creates Kafka topics for each tracked entity automatically.
3232
4. In the [Event Broker Manager](https://broker.mendix.com/), configure an [Event Broker Bridge](/appstore/services/event-broker/#manage-mx-broker-bridge) to route CDC events to your destination.
3333

34+
## Runtime Configuration {#runtime-configuration}
35+
36+
CDC requires runtime settings to connect to a Kafka broker. Set these in Studio Pro under **App Settings** > **Configurations** > **Custom**, or via your deployment environment's custom runtime settings.
37+
38+
### Running Locally {#local-configuration}
39+
40+
When running the app locally, only the bootstrap server address is required:
41+
42+
| Name | Description | Default Value |
43+
| --- | --- | --- |
44+
| `Kafka.BootstrapServers` | The address of the Kafka broker, in the format `host:port`. | |
45+
46+
### Bring Your Own Kafka (BYOK) {#byok-configuration}
47+
48+
When connecting to a BYOK Kafka cluster, provide the bootstrap server address and credentials for authentication. The supported authentication method is SASL/SCRAM-SHA-512.
49+
50+
| Name | Description | Default Value |
51+
| --- | --- | --- |
52+
| `Kafka.BootstrapServers` | The address of the Kafka broker, in the format `host:port`. | |
53+
| `Kafka.Username` | The username for SASL/SCRAM-SHA-512 authentication with the Kafka cluster. | |
54+
| `Kafka.Password` | The password for SASL/SCRAM-SHA-512 authentication with the Kafka cluster. | |
55+
56+
For details on setting up a BYOK cluster with the Mendix Event Broker, see [Mendix Event Broker](/appstore/services/event-broker/).
57+
3458
## Read More
3559

3660
* [Published CDC Services](/refguide/published-cdc-services/)

0 commit comments

Comments
 (0)