From 6bd8292f8cb71b8db1452b1638f84cf979527ca3 Mon Sep 17 00:00:00 2001 From: robertojrojas Date: Thu, 10 Aug 2023 12:56:08 -0400 Subject: [PATCH] updates Signed-off-by: robertojrojas --- pubsub/mqtt3/metadata.yaml | 70 ++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 37 deletions(-) diff --git a/pubsub/mqtt3/metadata.yaml b/pubsub/mqtt3/metadata.yaml index 8ae38af60c..0006658658 100644 --- a/pubsub/mqtt3/metadata.yaml +++ b/pubsub/mqtt3/metadata.yaml @@ -8,61 +8,57 @@ title: "MQTT3" urls: - title: Reference url: https://docs.dapr.io/reference/components-reference/supported-pubsub/setup-mqtt3/ +authenticationProfiles: + - title: "Connection string" + description: "The MQTT3 Connection/Authentication." + metadata: + - name: url + type: string + required: true + description: | + Address of the MQTT broker. Can be secretKeyRef to use a secret reference. + Use the tcp:// URI scheme for non-TLS communication. + Use the ssl:// URI scheme for TLS communication. + example: '"tcp://[username][:password]@host.domain[:port]"' metadata: - - name: url - required: true - description: | - "Address of the MQTT broker. Can be secretKeyRef to use a secret reference. - Use the tcp:// URI scheme for non-TLS communication. Use the ssl:// URI scheme for TLS communication." - type: string - example: '"tcp://[username][:password]@host.domain[:port]"' - name: consumerID - description: | - "The client ID used to connect to the MQTT broker. Defaults to the Dapr app ID." type: string + description: | + The client ID used to connect to the MQTT broker. Defaults to the Dapr app ID. example: '"myMqttClientApp"' - name: retain - description: | - "Defines whether the message is saved by the broker as the last known good value for a specified topic. - Defaults to "false"." type: bool + description: | + Defines whether the message is saved by the broker as the last known good value for a specified topic. default: 'false' example: '"true", "false"' - name: cleanSession - description: | - "Sets the clean_session flag in the connection message to the MQTT broker if "true" (more info). - Defaults to "false"." type: bool + description: | + Sets the clean_session flag in the connection message to the MQTT broker if "true" (more info). default: 'false' example: '"true", "false"' - name: qos - description: | - "Indicates the Quality of Service Level (QoS) of the message (more info). Defaults to 1." type: number - default: 1 + description: | + Indicates the Quality of Service Level (QoS) of the message (more info). + default: '1' example: '0, 1, 2' - name: caCert - description: | - "Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates." type: string - example: | - '-----BEGIN CERTIFICATE----- - ... - -----END CERTIFICATE-----' - - name: clientCert description: | - "TLS client certificate in PEM format. Must be used with clientKey." + Certificate authority certificate, required for using TLS. + Can be secretKeyRef to use a secret reference". + example: '"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"' + - name: clientCert type: string - example: | - '-----BEGIN CERTIFICATE----- - ... - -----END CERTIFICATE-----' - - name: clientKey description: | - "TLS client key in PEM format. Must be used with clientCert. Can be secretKeyRef to use a secret reference." + Client certificate, required for authType mtls. + Can be secretKeyRef to use a secret reference. + example: '"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"' + - name: clientKey type: string - example: | - '-----BEGIN RSA PRIVATE KEY----- - ... - -----END RSA PRIVATE KEY-----' - + description: | + Client key, required for authType mtls. + Can be secretKeyRef to use a secret reference. + example: '"-----BEGIN RSA PRIVATE KEY-----\n\n-----END RSA PRIVATE KEY-----"' \ No newline at end of file