Skip to content

Commit 9dde87f

Browse files
committed
Add warning about ConfigMap naming constraint for trustedClientCaCert
The broker operator uses the trustedClientCaCert ConfigMap name as a Kubernetes volume name. Volume names must follow RFC 1123 label rules (no dots). If the name contains dots, reconciliation fails silently and listeners don't provision. Add an IMPORTANT callout to the X.509 authentication docs.
1 parent 8c0c726 commit 9dde87f

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

articles/iot-operations/manage-mqtt-broker/howto-configure-authentication.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: sethm
66
ms.service: azure-iot-operations
77
ms.subservice: azure-mqtt-broker
88
ms.topic: how-to
9-
ms.date: 04/10/2025
9+
ms.date: 03/25/2026
1010
ms.custom:
1111
- ignite-2023
1212
- sfi-image-nochange
@@ -458,6 +458,9 @@ To get started with X.509 authentication, import the trusted CA certificate into
458458
kubectl create configmap client-ca --from-file=ca.pem -n azure-iot-operations
459459
```
460460

461+
> [!IMPORTANT]
462+
> The ConfigMap name is used as a Kubernetes volume name internally by the broker operator. Volume names must conform to [RFC 1123 label rules](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names), which means they can only contain lowercase alphanumeric characters and hyphens. For example, `client-ca` and `my-root-ca` are valid names, but `my-root-ca.crt` is not. If the ConfigMap name contains dots or other invalid characters, the broker's reconciliation fails silently and listeners don't provision correctly.
463+
461464
In this example, the CA certificate is imported under the key `ca.pem`. The MQTT broker trusts all CA certificates in the ConfigMap, so you can use anything for the name of the key.
462465

463466
To check that the root CA certificate is properly imported, run `kubectl describe configmap`. The result shows the same Base64 encoding of the PEM certificate file.

0 commit comments

Comments
 (0)