Azure / azure-iot-operations

The official repo for Azure IoT Operations.
MIT License
20 stars 16 forks source link

[Docs] Missing parameter in YAML example - howto-configure-data-lake#add-the-managed-identity-to-the-azure-data-explorer-cluster #52

Open frodehetland opened 1 month ago

frodehetland commented 1 month ago

The yaml provided are missing some parameters and the formatting is incorrect.

https://learn.microsoft.com/en-us/azure/iot-operations/connect-to-cloud/howto-configure-data-lake#add-the-managed-identity-to-the-azure-data-explorer-cluster

Example of file that has the missing parameters (Kind, metadata, datalakeconnectorref etc).


apiVersion: mq.iotoperations.azure.com/v1beta1
kind: DataLakeConnector
metadata:
  name: my-adx-connector
  namespace: azure-iot-operations
spec:
  protocol: v5
  image:
    repository: mcr.microsoft.com/azureiotoperations/datalake
    tag: 0.4.0-preview
    pullPolicy: IfNotPresent
  instances: 1
  logLevel: info
  databaseFormat: delta
  target:
    adx:
     # TODO: insert the ADX cluster endpoint
     endpoint: https:///<CLUSTER>.<REGION>.kusto.windows.net
     authentication:
      systemAssignedManagedIdentity:
        audience: https://api.kusto.windows.net
  localBrokerConnection:
   endpoint: aio-mq-dmqtt-frontend:8883
   tls:
     tlsEnabled: true
     trustedCaCertificateConfigMap: aio-ca-trust-bundle-test-only
   authentication:
     kubernetes: {}
---
apiVersion: mq.iotoperations.azure.com/v1beta1
kind: DataLakeConnectorTopicMap
metadata:
  name: adx-topicmap
  namespace: azure-iot-operations
spec:
  dataLakeConnectorRef: "my-adx-connector"
  mapping:
    allowedLatencySecs: 1
    messagePayloadType: json
    maxMessagesPerBatch: 10
    clientId: id
    mqttSourceTopic: azure-iot-operations/data/#
    qos: 1
    table:
      # TODO: add DB and table name
      tablePath: <DATABASE_NAME>
      tableName: <TABLE_NAME>
      schema:
      - name: externalAssetId
        format: utf8
        optional: false
        mapping: $property.externalAssetId
      - name: assetName
        format: utf8
        optional: false
        mapping: DataSetWriterName
      - name: CurrentTemperature
        format: float32
        optional: false
        mapping: Payload.temperature.Value
      - name: Pressure
        format: float32
        optional: true
        mapping: "Payload.Tag 10.Value"
      - name: MqttTopic
        format: utf8
        optional: false
        mapping: $topic
      - name: Timestamp
        format: timestamp
        optional: false
        mapping: $received_time
        mapping: .payload.SequenceNumber
      - name: MessageType
        format: utf8
        optional: false
        mapping: .payload.MessageType