Merge pull request #282101 from ryanwinterms/release-aio-july-updates

Dapr component updates

Author: ttorble

articles/iot-operations/create-edge-apps/howto-deploy-dapr.md

@@ -15,12 +15,12 @@ ms.date: 07/02/2024
 
 The Distributed Application Runtime (Dapr) is a portable, serverless, event-driven runtime that simplifies the process of building distributed applications. Dapr lets you build stateful or stateless apps without worrying about how the building blocks function. Dapr provides several [building blocks](https://docs.dapr.io/developing-applications/building-blocks/): pub/sub, state management, service invocation, actors, and more.  
 
-MQTT broker supports two of these building blocks, powered by [MQTT broker](../manage-mqtt-broker/overview-iot-mq.md):
+Azure IoT Operations supports two of these building blocks, powered by [MQTT broker](../manage-mqtt-broker/overview-iot-mq.md):
 
 - Publish and subscribe
 - State management
 
-To use the MQTT broker Dapr pluggable components, define the component spec for each of the APIs and then [register this to the cluster](https://docs.dapr.io/operations/components/pluggable-components-registration/). The Dapr components listen to a Unix domain socket placed on the shared volume. The Dapr runtime connects with each socket and discovers all services from a given building block API that the component implements.
+To use the Dapr pluggable components, define the component spec for each of the APIs and then [register this to the cluster](https://docs.dapr.io/operations/components/pluggable-components-registration/). The Dapr components listen to a Unix domain socket placed on the shared volume. The Dapr runtime connects with each socket and discovers all services from a given building block API that the component implements.
 
 ## Install Dapr runtime
 
@@ -37,94 +37,75 @@ helm upgrade --install dapr dapr/dapr --version=1.13 --namespace dapr-system --c
 
 ## Register MQTT broker pluggable components
 
-To register MQTT broker's pluggable pub/sub and state management components, create the component manifest yaml, and apply it to your cluster. 
+To register the pub/sub and state management pluggable components, create the component manifest yaml, and apply it to your cluster. 
 
 To create the yaml file, use the following component definitions:
 
 > [!div class="mx-tdBreakAll"]
 > | Component | Description |
 > |-|-|
 > | `metadata.name` | The component name is important and is how a Dapr application references the component. |
-> | `metadata.annotations` | Component annotations used by the Dapr sidecar injector
-> | `spec.type` | [The type of the component](https://docs.dapr.io/operations/components/pluggable-components-registration/#define-the-component), which must be declared exactly as shown. It tells Dapr what kind of component (`pubsub` or `state`) it is and which Unix socket to use. |
-> | `spec.metadata.url` | The URL tells the component where the local MQTT broker endpoint is. Defaults to `8883` is MQTT broker's default MQTT port with TLS enabled. |
-> | `spec.metadata.satTokenPath` | The Service Account Token is used to authenticate the Dapr components with the MQTT broker |
-> | `spec.metadata.tlsEnabled` |  Define if TLS is used by the MQTT broker. Defaults to `true` |
-> | `spec.metadata.caCertPath` | The certificate chain path for validating the broker, required if `tlsEnabled` is `true` |
-> | `spec.metadata.logLevel` | The logging level of the component. 'Debug', 'Info', 'Warn' and 'Error' |
+> | `metadata.annotations` | Component annotations used by Dapr sidecar injector, defining the image location and required volume mounts
+> | `spec.type` | [The type of the component](https://docs.dapr.io/operations/components/pluggable-components-registration/#define-the-component), which needs to be declared exactly as shown |
+> | `spec.metadata.keyPrefix` | Defines the key prefix used when communicating to the statestore backend. See the [Dapr documentation](https://docs.dapr.io/developing-applications/building-blocks/state-management/howto-share-state) for more information |
+> | `spec.metadata.hostname` | The MQTT broker hostname. Defaults to `aio-mq-dmqtt-frontend` |
+> | `spec.metadata.tcpPort` | The MQTT broker port number. Default is `8883` |
+> | `spec.metadata.useTls` |  Define if TLS is used by the MQTT broker. Defaults to `true` |
+> | `spec.metadata.caFile` | The certificate chain path for validating the MQTT broker. Required if `useTls` is `true`. This file must be mounted in the pod with the specified volume name |
+> | `spec.metadata.satAuthFile ` | The Service Account Token (SAT) file is used to authenticate the Dapr components with the MQTT broker.  This file must be mounted in the pod with the specified volume name |
 
-1. Save the following yaml, which contains the component definitions, to a file named `components.yaml`:
+1. Save the following yaml, which contains the Azure IoT Operations component definitions, to a file named `components.yaml`:
 
     ```yml
-    # Pub/sub component
     apiVersion: dapr.io/v1alpha1
     kind: Component
     metadata:
-      name: aio-mq-pubsub
+      name: iotoperations-pubsub
       namespace: azure-iot-operations
       annotations:
         dapr.io/component-container: >
           {
-            "name": "aio-mq-components",
-            "image": "ghcr.io/azure/iot-mq-dapr-components:latest",
+            "name": "iot-operations-dapr-components",
+            "image": "ghcr.io/azure/iot-operations-dapr-components:latest",
             "volumeMounts": [
-              {
-                "name": "mqtt-client-token",
-                "mountPath": "/var/run/secrets/tokens"
-              },
-              {
-                "name": "aio-ca-trust-bundle",
-                "mountPath": "/var/run/certs/aio-mq-ca-cert"
-              }
+              { "name": "mqtt-client-token", "mountPath": "/var/run/secrets/tokens" },
+              { "name": "aio-ca-trust-bundle", "mountPath": "/var/run/certs/aio-mq-ca-cert" }
             ]
           }
     spec:
-      type: pubsub.aio-mq-pubsub-pluggable # DO NOT CHANGE
+      type: pubsub.azure.iotoperations
       version: v1
       metadata:
-      - name: url
-        value: "aio-mq-dmqtt-frontend:8883"
-      - name: satTokenPath
-        value: "/var/run/secrets/tokens/mqtt-client-token"
-      - name: tlsEnabled
+      - name: hostname
+        value: aio-mq-dmqtt-frontend
+      - name: tcpPort
+        value: 8883
+      - name: useTls
         value: true
-      - name: caCertPath
-        value: "/var/run/certs/aio-mq-ca-cert/ca.crt"
+      - name: caFile
+        value: /var/run/certs/aio-mq-ca-cert/ca.crt
+      - name: satAuthFile
+        value: /var/run/secrets/tokens/mqtt-client-token
     ---
-    # State Management component
     apiVersion: dapr.io/v1alpha1
     kind: Component
     metadata:
-      name: aio-mq-statestore
+      name: iotoperations-statestore
       namespace: azure-iot-operations
-      annotations:
-        dapr.io/component-container: >
-          {
-            "name": "aio-mq-components",
-            "image": "ghcr.io/azure/iot-mq-dapr-components:latest",
-            "volumeMounts": [
-              {
-                "name": "mqtt-client-token",
-                "mountPath": "/var/run/secrets/tokens"
-              },
-              {
-                "name": "aio-ca-trust-bundle",
-                "mountPath": "/var/run/certs/aio-mq-ca-cert"
-              }
-            ]
-          }
     spec:
-      type: state.aio-mq-statestore-pluggable # DO NOT CHANGE
+      type: state.azure.iotoperations
       version: v1
       metadata:
-      - name: url
-        value: "aio-mq-dmqtt-frontend:8883"
-      - name: satTokenPath
-        value: "/var/run/secrets/tokens/mqtt-client-token"
-      - name: tlsEnabled
+      - name: hostname
+        value: aio-mq-dmqtt-frontend
+      - name: tcpPort
+        value: 8883
+      - name: useTls
         value: true
-      - name: caCertPath
-        value: "/var/run/certs/aio-mq-ca-cert/ca.crt"
+      - name: caFile
+        value: /var/run/certs/aio-mq-ca-cert/ca.crt
+      - name: satAuthFile
+        value: /var/run/secrets/tokens/mqtt-client-token    
     ```
 
 1. Apply the component yaml to your cluster by running the following command:
@@ -136,8 +117,8 @@ To create the yaml file, use the following component definitions:
     Verify the following output:
 
     ```output
-    component.dapr.io/aio-mq-pubsub created
-    component.dapr.io/aio-mq-statestore created
+    component.dapr.io/iotoperations-pubsub created
+    component.dapr.io/iotoperations-statestore created
     ```
 
 ## Create authorization policy for MQTT broker

articles/iot-operations/create-edge-apps/howto-develop-dapr-apps.md

@@ -97,7 +97,7 @@ To create the yaml file, use the following definitions:
           serviceAccountName: dapr-client
 
           volumes:
-          # SAT token used to authenticate between Dapr and the MQTT broker
+          # SAT used to authenticate between Dapr and the MQTT broker
           - name: mqtt-client-token
             projected:
               sources:

articles/iot-operations/create-edge-apps/tutorial-event-driven-with-dapr.md

@@ -61,7 +61,6 @@ To start, create a yaml file that uses the following definitions:
       name: mq-event-driven-dapr
       namespace: azure-iot-operations
     spec:
-      replicas: 1
       selector:
         matchLabels:
           app: mq-event-driven-dapr
@@ -118,11 +117,16 @@ To start, create a yaml file that uses the following definitions:
     mq-event-driven-dapr          3/3     Running             0          30s
     ```
 
-
 ## Deploy the simulator
 
 Simulate test data by deploying a Kubernetes workload. It simulates a sensor by sending sample temperature, vibration, and pressure readings periodically to the MQTT broker using an MQTT client on the `sensor/data` topic.
 
+1. Patch BrokerListener to allow unauthenticated connection, to simplify injection of simulated data:
+
+    ```bash
+    kubectl patch BrokerListener listener -n azure-iot-operations --type=json -p='[{ "op": "add", "path": "/spec/ports/1", "value": {"port":1883} }]'
+    ```
+
 1. Deploy the simulator from the Explore IoT Operations repository:
 
     ```bash
@@ -159,6 +163,12 @@ To verify the MQTT bridge is working, deploy an MQTT client to the cluster.
 
     ```yaml
     apiVersion: v1
+    kind: ServiceAccount
+    metadata:
+      name: mqtt-client
+      namespace: azure-iot-operations
+    ---
+    apiVersion: v1
     kind: Pod
     metadata:
       name: mqtt-client
@@ -188,7 +198,7 @@ To verify the MQTT bridge is working, deploy an MQTT client to the cluster.
           name: aio-ca-trust-bundle-test-only
     ```
 
-1. Apply the deployment file with kubectl.
+1. Apply the deployment file with kubectl:
 
     ```bash
     kubectl apply -f client.yaml
@@ -211,7 +221,7 @@ To verify the MQTT bridge is working, deploy an MQTT client to the cluster.
 1. Subscribe to the `sensor/window_data` topic to observe the published output from the Dapr application:
 
     ```bash
-    mosquitto_sub -L mqtts://aio-mq-dmqtt-frontend/sensor/window_data -u 'K8S-SAT' -P $(cat /var/run/secrets/tokens/mqtt-client-token) --cafile /var/run/certs/aio-mq-ca-cert/ca.crt 
+    mosquitto_sub -L mqtt://aio-mq-dmqtt-frontend/sensor/window_data
     ```
 
 1. Verify the application is outputting a sliding windows calculation for the various sensors every 10 seconds: