Skip to content

Commit 04153e1

Browse files
committed
Update concept section with a tls example
1 parent c1d1628 commit 04153e1

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

content/event-platform/concepts.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,12 @@ For the `kafka` subscription type, the `config` property requires the Kafka clus
236236
"mechanism": "plain",
237237
"username": "your_kafka_username",
238238
"password": "your_kafka_password"
239+
},
240+
"tls": {
241+
"server_name": "kafka.example.com",
242+
"ca_pem": "-----BEGIN CERTIFICATE-----\n...",
243+
"client_cert_pem": "-----BEGIN CERTIFICATE-----\n...",
244+
"client_key_pem": "-----BEGIN PRIVATE KEY-----\n..."
239245
}
240246
}
241247
}
@@ -271,13 +277,36 @@ For the `kafka` subscription type, the `config` property requires the Kafka clus
271277
}
272278
```
273279

280+
#### TLS Configuration (Optional)
281+
282+
For secure connections, you can optionally configure TLS settings in the `config` object:
283+
284+
```json
285+
"tls": {
286+
"server_name": "kafka.example.com",
287+
"ca_pem": "-----BEGIN CERTIFICATE-----a-valid-certificate-----END CERTIFICATE-----",
288+
"client_cert_pem": "-----BEGIN CERTIFICATE-----a-valid-certificate-----END CERTIFICATE-----",
289+
"client_key_pem": "-----BEGIN PRIVATE KEY-----a-valid-private-key-----END PRIVATE KEY-----"
290+
}
291+
```
292+
293+
#### TLS Configuration Properties
294+
295+
| Property | Description | Required |
296+
| --- | --- | --- |
297+
| `server_name` | Server name for TLS verification | Yes |
298+
| `ca_pem` | Certificate Authority (CA) certificate in PEM format | Yes |
299+
| `client_cert_pem` | Client certificate in PEM format | Yes |
300+
| `client_key_pem` | Client private key in PEM format | Yes |
301+
274302
#### Required Configuration Properties
275303

276304
| Property | Description | Required |
277305
| --- | --- | --- |
278306
| `broker` | Kafka broker address | Yes |
279307
| `topic` | Name of the Kafka topic where events will be published | Yes |
280308
| `sasl_auth` | SASL authentication configuration object | Yes |
309+
| `tls` | TLS configuration for secure connections | No |
281310

282311
#### SASL Authentication Properties
283312

0 commit comments

Comments
 (0)