Merge pull request #288741 from PatAltimore/patricka-mqtt-portal

Fix MQTT default reference names

Author: prmerger-automator[bot]

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

@@ -30,10 +30,10 @@ To link a BrokerListener to a *BrokerAuthentication* resource, specify the `auth
 
 ## Default BrokerAuthentication resource
 
-Azure IoT Operations Preview deploys a default *BrokerAuthentication* resource named `authn` linked with the default listener named `listener` in the `azure-iot-operations` namespace. It's configured to only use Kubernetes Service Account Tokens (SATs) for authentication. To inspect it, run:
+Azure IoT Operations Preview deploys a default *BrokerAuthentication* resource named `default` linked with the *default* listener in the `azure-iot-operations` namespace. It's configured to only use Kubernetes Service Account Tokens (SATs) for authentication. To inspect it, run:
 
 ```bash
-kubectl get brokerauthentication authn -n azure-iot-operations -o yaml
+kubectl get brokerauthentication default -n azure-iot-operations -o yaml
 ```
 
 The output shows the default *BrokerAuthentication* resource, with metadata removed for brevity:
@@ -42,14 +42,14 @@ The output shows the default *BrokerAuthentication* resource, with metadata remo
 apiVersion: mqttbroker.iotoperations.azure.com/v1beta1
 kind: BrokerAuthentication
 metadata:
-  name: authn
+  name: default
   namespace: azure-iot-operations
 spec:
   authenticationMethods:
     - method: ServiceAccountToken
       serviceAccountTokenSettings:
         audiences:
-          - "aio-internal"
+          - aio-internal
 ```
 
 > [!IMPORTANT]
@@ -79,7 +79,7 @@ With multiple authentication methods, MQTT broker has a fallback mechanism. For
 apiVersion: mqttbroker.iotoperations.azure.com/v1beta1
 kind: BrokerAuthentication
 metadata: 
-  name: authn
+  name: default
   namespace: azure-iot-operations
 spec:
   authenticationMethods:

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

@@ -7,7 +7,7 @@ ms.topic: how-to
 ms.subservice: azure-mqtt-broker
 ms.custom:
   - ignite-2023
-ms.date: 09/09/2024
+ms.date: 10/18/2024
 
 #CustomerIntent: As an operator, I want to understand the settings for the MQTT broker so that I can configure it for high availability and scale.
 ms.service: azure-iot-operations
@@ -91,10 +91,10 @@ Medium is the default profile.
 
 ## Default broker
 
-By default, Azure IoT Operations Preview deploys a default Broker resource named `broker`. It's deployed in the `azure-iot-operations` namespace with cardinality and memory profile settings as configured during the initial deployment with Azure portal or Azure CLI. To see the settings, run the following command:
+By default, Azure IoT Operations Preview deploys a default Broker resource named `default`. It's deployed in the `azure-iot-operations` namespace with cardinality and memory profile settings as configured during the initial deployment with Azure portal or Azure CLI. To see the settings, run the following command:
 
 ```bash
-kubectl get broker broker -n azure-iot-operations -o yaml
+kubectl get broker default -n azure-iot-operations -o yaml
 ```
 
 ### Modify default broker by redeploying
@@ -104,16 +104,16 @@ Only [cardinality](#configure-scaling-settings) and [memory profile](#configure-
 To delete the default broker, run the following command:
 
 ```bash
-kubectl delete broker broker -n azure-iot-operations
+kubectl delete broker default -n azure-iot-operations
 ```
 
-Then, create a YAML file with desired settings. For example, the following YAML file configures the broker with name `broker` in namespace `azure-iot-operations` with `medium` memory profile and `distributed` mode with two frontend replicas and two backend chains with two partitions and two workers each. Also, the [encryption of internal traffic option](#configure-encryption-of-internal-traffic) is disabled.
+Then, create a YAML file with desired settings. For example, the following YAML file configures the broker with name `default` in namespace `azure-iot-operations` with `medium` memory profile and `distributed` mode with two frontend replicas and two backend chains with two partitions and two workers each. Also, the [encryption of internal traffic option](#configure-encryption-of-internal-traffic) is disabled.
 
 ```yaml
 apiVersion: mqttbroker.iotoperations.azure.com/v1beta1
 kind: Broker
 metadata:
-  name: broker
+  name: default
   namespace: azure-iot-operations
 spec:
   memoryProfile: medium
@@ -136,15 +136,15 @@ kubectl apply -f <path-to-yaml-file>
 
 ## Configure MQTT broker advanced settings
 
-The broker advanced settings include client configurations, encryption of internal traffic, and certificate rotations. For more information on the advanced settings, see the [Broker]() API reference.
+The broker advanced settings include client configurations, encryption of internal traffic, and certificate rotations. For more information on the advanced settings, see the [Broker](/rest/api/iotoperations/broker/create-or-update) API reference.
 
 Here's an example of a *Broker* with advanced settings:
 
 ```yml
 apiVersion: mqttbroker.iotoperations.azure.com/v1beta1
 kind: Broker
 metadata:
-  name: broker
+  name: default
   namespace: azure-iot-operations
 spec:
   advanced:

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

@@ -7,7 +7,7 @@ ms.subservice: azure-mqtt-broker
 ms.topic: how-to
 ms.custom:
   - ignite-2023
-ms.date: 10/08/2024
+ms.date: 10/18/2024
 
 #CustomerIntent: As an operator, I want understand options to secure MQTT communications for my IoT Operations solution.
 ms.service: azure-iot-operations
@@ -26,7 +26,7 @@ Each listener port can have its own authentication and authorization rules that
 
 Listeners have the following characteristics:
 
-- You can have up to three listeners. One listener per service type of `loadBalancer`, `clusterIp`, or `nodePort`. The default *BrokerListener* named *listener* is service type `clusterIp`.
+- You can have up to three listeners. One listener per service type of `loadBalancer`, `clusterIp`, or `nodePort`. The default *BrokerListener* named *default* is service type `clusterIp`.
 - Each listener supports multiple ports
 - BrokerAuthentication and BrokerAuthorization references are per port
 - TLS configuration is per port
@@ -37,7 +37,7 @@ For a list of the available settings, see the [Broker Listener](/rest/api/iotope
 
 ## Default BrokerListener
 
-When you deploy Azure IoT Operations Preview, the deployment also creates a *BrokerListener* resource named `listener` in the `azure-iot-operations` namespace. This listener is linked to the default Broker resource named `broker` that's also created during deployment. The default listener exposes the broker on port 18883 with TLS and SAT authentication enabled. The TLS certificate is [automatically managed](howto-configure-tls-auto.md) by cert-manager. Authorization is disabled by default.
+When you deploy Azure IoT Operations Preview, the deployment also creates a *BrokerListener* resource named `default` in the `azure-iot-operations` namespace. This listener is linked to the default *Broker* resource named `default` that's also created during deployment. The default listener exposes the broker on port 18883 with TLS and SAT authentication enabled. The TLS certificate is [automatically managed](howto-configure-tls-auto.md) by cert-manager. Authorization is disabled by default.
 
 To view or edit the listener:
 
@@ -59,7 +59,7 @@ To view or edit the listener:
 To view the default *BrokerListener* resource, use the following command:
 
 ```bash
-kubectl get brokerlistener listener -n azure-iot-operations -o yaml
+kubectl get brokerlistener default -n azure-iot-operations -o yaml
 ```
 
 The output should look similar to this, with most metadata removed for brevity:
@@ -68,15 +68,15 @@ The output should look similar to this, with most metadata removed for brevity:
 apiVersion: mqttbroker.iotoperations.azure.com/v1beta1
 kind: BrokerListener
 metadata:
-  name: listener
+  name: default
   namespace: azure-iot-operations
 spec:
-  brokerRef: broker
+  brokerRef: default
   serviceName: aio-broker
   serviceType: ClusterIp
   ports:
-  - port: 18883
-    authenticationRef: authn
+  - authenticationRef: default
+    port: 18883
     protocol: Mqtt
     tls:
       certManagerCertificateSpec:
@@ -94,7 +94,7 @@ To learn more about the default BrokerAuthentication resource linked to this lis
 The default *BrokerListener* uses the service type *ClusterIp*. You can have only one listener per service type. If you want to add more ports to service type *ClusterIp*, you can update the default listener to add more ports. For example, you could add a new port 1883 with no TLS and authentication off with the following kubectl patch command:
 
 ```bash
-kubectl patch brokerlistener listener -n azure-iot-operations --type='json' -p='[{"op": "add", "path": "/spec/ports/", "value": {"port": 1883, "protocol": "Mqtt"}}]'
+kubectl patch brokerlistener default -n azure-iot-operations --type='json' -p='[{"op": "add", "path": "/spec/ports/", "value": {"port": 1883, "protocol": "Mqtt"}}]'
 ```
 
 ---
@@ -139,14 +139,14 @@ metadata:
   name: loadbalancer-listener
   namespace: azure-iot-operations
 spec:
-  brokerRef: broker
+  brokerRef: default
   serviceType: LoadBalancer
   serviceName: aio-broker-loadbalancer
   ports:
   - port: 1883
     protocol: Mqtt
   - port: 18883
-    authenticationRef: authn
+    authenticationRef: default
     protocol: Mqtt
     tls:
       mode: Automatic

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

@@ -7,7 +7,7 @@ ms.subservice: azure-mqtt-broker
 ms.topic: how-to
 ms.custom:
   - ignite-2023
-ms.date: 08/22/2024
+ms.date: 10/18/2024
 
 #CustomerIntent: As an operator, I want to configure MQTT broker to use TLS so that I have secure communication between the MQTT broker and client.
 ms.service: azure-iot-operations
@@ -182,7 +182,7 @@ metadata:
   name: my-new-tls-listener
   namespace: azure-iot-operations
 spec:
-  brokerRef: broker
+  brokerRef: default
   serviceType: loadBalancer
   serviceName: my-new-tls-listener # Avoid conflicts with default service name 'aio-broker'
   ports:

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

@@ -85,7 +85,7 @@ metadata:
   name: manual-tls-listener
   namespace: azure-iot-operations
 spec:
-  brokerRef: broker
+  brokerRef: default
   serviceType: loadBalancer # Optional, defaults to clusterIP
   serviceName: mqtts-endpoint # Match the SAN in the server certificate
   ports:

articles/iot-operations/manage-mqtt-broker/howto-test-connection.md

@@ -292,7 +292,7 @@ If you understand the risks and need to use an insecure port in a well-controlle
       name: non-tls-listener
       namespace: azure-iot-operations
     spec:
-      brokerRef: broker
+      brokerRef: default
       serviceType: loadBalancer
       serviceName: my-unique-service-name
       authenticationEnabled: false