Skip to content

Commit 87541ae

Browse files
Merge pull request #290018 from PatAltimore/patricka-kafka-endpoint
Remove x509 from Kafka endpoint
2 parents 191a1dc + 5259fb8 commit 87541ae

File tree

1 file changed

+5
-58
lines changed

1 file changed

+5
-58
lines changed

articles/iot-operations/connect-to-cloud/howto-configure-kafka-endpoint.md

Lines changed: 5 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: patricka
66
ms.service: azure-iot-operations
77
ms.subservice: azure-data-flows
88
ms.topic: how-to
9-
ms.date: 11/04/2024
9+
ms.date: 11/06/2024
1010
ai-usage: ai-assisted
1111

1212
#CustomerIntent: As an operator, I want to understand how to configure dataflow endpoints for Kafka in Azure IoT Operations so that I can send data to and from Kafka endpoints.
@@ -27,7 +27,7 @@ To set up bi-directional communication between Azure IoT Operations Preview and
2727

2828
[Azure Event Hubs is compatible with the Kafka protocol](../../event-hubs/azure-event-hubs-kafka-overview.md) and can be used with dataflows with some limitations.
2929

30-
### Create an Azure Event Hubs namespace and event hub in it
30+
### Create an Azure Event Hubs namespace and event hub
3131

3232
First, [create a Kafka-enabled Azure Event Hubs namespace](../../event-hubs/event-hubs-quickstart-kafka-enabled-event-hubs.md)
3333

@@ -220,13 +220,11 @@ To configure a dataflow endpoint for non-Event-Hub Kafka brokers, set the host,
220220
| -------------------- | ------------------------------------------------------------------------------------------------- |
221221
| Name | The name of the dataflow endpoint. |
222222
| Host | The hostname of the Kafka broker in the format `<Kafa-broker-host>:xxxx`. Include port number in the host setting. |
223-
| Authentication method| The method used for authentication. Choose *SASL* or *X509 certificate*. |
223+
| Authentication method| The method used for authentication. Choose *SASL*. |
224224
| SASL type | The type of SASL authentication. Choose *Plain*, *ScramSha256*, or *ScramSha512*. Required if using *SASL*. |
225-
| Synced secret name | The name of the secret. Required if using *SASL* or *X509*. |
225+
| Synced secret name | The name of the secret. Required if using *SASL*. |
226226
| Username reference of token secret | The reference to the username in the SASL token secret. Required if using *SASL*. |
227-
| X509 client certificate | The X.509 client certificate used for authentication. Required if using *X509*. |
228-
| X509 intermediate certificates | The intermediate certificates for the X.509 client certificate chain. Required if using *X509*. |
229-
| X509 client key | The private key corresponding to the X.509 client certificate. Required if using *X509*. |
227+
230228

231229
1. Select **Apply** to provision the endpoint.
232230

@@ -352,57 +350,6 @@ The secret must be in the same namespace as the Kafka dataflow endpoint. The sec
352350

353351
<!-- TODO: double check! -->
354352

355-
### X.509
356-
357-
To use X.509 for authentication, update the authentication section of the Kafka settings to use the X509Certificate method and specify reference to the secret that holds the X.509 certificate.
358-
359-
# [Portal](#tab/portal)
360-
361-
In the operations experience dataflow endpoint settings page, select the **Basic** tab then choose **Authentication method** > **X509 certificate**.
362-
363-
Enter the following settings for the endpoint:
364-
365-
| Setting | Description |
366-
| --------------------- | ------------------------------------------------------------------------------------------------- |
367-
| Synced secret name | The name of the secret. |
368-
| X509 client certificate | The X.509 client certificate used for authentication. |
369-
| X509 intermediate certificates | The intermediate certificates for the X.509 client certificate chain. |
370-
| X509 client key | The private key corresponding to the X.509 client certificate. |
371-
372-
# [Bicep](#tab/bicep)
373-
374-
375-
```bicep
376-
kafkaSettings: {
377-
authentication: {
378-
method: 'X509Certificate'
379-
x509CertificateSettings: {
380-
secretRef: '<SECRET_NAME>'
381-
}
382-
}
383-
}
384-
```
385-
386-
# [Kubernetes](#tab/kubernetes)
387-
388-
The secret must be in the same namespace as the Kafka dataflow endpoint. Use Kubernetes TLS secret containing the public certificate and private key. For example:
389-
390-
```bash
391-
kubectl create secret tls my-tls-secret -n azure-iot-operations \
392-
--cert=path/to/cert/file \
393-
--key=path/to/key/file
394-
```
395-
396-
```yaml
397-
kafkaSettings:
398-
authentication:
399-
method: X509Certificate
400-
x509CertificateSettings:
401-
secretRef: <SECRET_NAME>
402-
```
403-
404-
---
405-
406353

407354
### System-assigned managed identity
408355

0 commit comments

Comments
 (0)