mirror of https://github.com/dapr/docs.git
				
				
				
			Rename mqtt components to mqtt3 (#3059)
See https://github.com/dapr/components-contrib/issues/2359 The old component names are still available as aliases Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com> Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>
This commit is contained in:
		
							parent
							
								
									b445c0314b
								
							
						
					
					
						commit
						e93d700a83
					
				| 
						 | 
					@ -44,7 +44,7 @@ spec:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Special metadata values
 | 
					### Special metadata values
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Metadata values can contain a `{uuid}` tag that is replaced with a randomly generate UUID when the Dapr sidecar starts up. A new UUID is generated on every start up. It can be used, for example, to have a pod on Kubernetes with multiple application instances consuming a [shared MQTT subscription]({{< ref "setup-mqtt.md" >}}). Below is an example of using the `{uuid}` tag.
 | 
					Metadata values can contain a `{uuid}` tag that is replaced with a randomly generate UUID when the Dapr sidecar starts up. A new UUID is generated on every start up. It can be used, for example, to have a pod on Kubernetes with multiple application instances consuming a [shared MQTT subscription]({{< ref "setup-mqtt3.md" >}}). Below is an example of using the `{uuid}` tag.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```yaml
 | 
					```yaml
 | 
				
			||||||
apiVersion: dapr.io/v1alpha1
 | 
					apiVersion: dapr.io/v1alpha1
 | 
				
			||||||
| 
						 | 
					@ -52,7 +52,7 @@ kind: Component
 | 
				
			||||||
metadata:
 | 
					metadata:
 | 
				
			||||||
  name: messagebus
 | 
					  name: messagebus
 | 
				
			||||||
spec:
 | 
					spec:
 | 
				
			||||||
  type: pubsub.mqtt
 | 
					  type: pubsub.mqtt3
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  metadata:
 | 
					  metadata:
 | 
				
			||||||
    - name: consumerID
 | 
					    - name: consumerID
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,15 +1,16 @@
 | 
				
			||||||
---
 | 
					---
 | 
				
			||||||
type: docs
 | 
					type: docs
 | 
				
			||||||
title: "MQTT binding spec"
 | 
					title: "MQTT3 binding spec"
 | 
				
			||||||
linkTitle: "MQTT"
 | 
					linkTitle: "MQTT3"
 | 
				
			||||||
description: "Detailed documentation on the MQTT binding component"
 | 
					description: "Detailed documentation on the MQTT3 binding component"
 | 
				
			||||||
aliases:
 | 
					aliases:
 | 
				
			||||||
 | 
					  - "/operations/components/setup-bindings/supported-bindings/mqtt3/"
 | 
				
			||||||
  - "/operations/components/setup-bindings/supported-bindings/mqtt/"
 | 
					  - "/operations/components/setup-bindings/supported-bindings/mqtt/"
 | 
				
			||||||
---
 | 
					---
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Component format
 | 
					## Component format
 | 
				
			||||||
 | 
					
 | 
				
			||||||
To setup MQTT binding create a component of type `bindings.mqtt`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
 | 
					To setup a MQTT3 binding create a component of type `bindings.mqtt3`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```yaml
 | 
					```yaml
 | 
				
			||||||
apiVersion: dapr.io/v1alpha1
 | 
					apiVersion: dapr.io/v1alpha1
 | 
				
			||||||
| 
						 | 
					@ -17,7 +18,7 @@ kind: Component
 | 
				
			||||||
metadata:
 | 
					metadata:
 | 
				
			||||||
  name: <NAME>
 | 
					  name: <NAME>
 | 
				
			||||||
spec:
 | 
					spec:
 | 
				
			||||||
  type: bindings.mqtt
 | 
					  type: bindings.mqtt3
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  metadata:
 | 
					  metadata:
 | 
				
			||||||
  - name: url
 | 
					  - name: url
 | 
				
			||||||
| 
						 | 
					@ -63,7 +64,7 @@ kind: Component
 | 
				
			||||||
metadata:
 | 
					metadata:
 | 
				
			||||||
  name: mqtt-binding
 | 
					  name: mqtt-binding
 | 
				
			||||||
spec:
 | 
					spec:
 | 
				
			||||||
  type: bindings.mqtt
 | 
					  type: bindings.mqtt3
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  metadata:
 | 
					  metadata:
 | 
				
			||||||
  - name: url
 | 
					  - name: url
 | 
				
			||||||
| 
						 | 
					@ -103,7 +104,7 @@ metadata:
 | 
				
			||||||
  name: mqtt-binding
 | 
					  name: mqtt-binding
 | 
				
			||||||
  namespace: default
 | 
					  namespace: default
 | 
				
			||||||
spec:
 | 
					spec:
 | 
				
			||||||
  type: bindings.mqtt
 | 
					  type: bindings.mqtt3
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  metadata:
 | 
					  metadata:
 | 
				
			||||||
  - name: consumerID
 | 
					  - name: consumerID
 | 
				
			||||||
| 
						 | 
					@ -1,15 +1,16 @@
 | 
				
			||||||
---
 | 
					---
 | 
				
			||||||
type: docs
 | 
					type: docs
 | 
				
			||||||
title: "MQTT"
 | 
					title: "MQTT3"
 | 
				
			||||||
linkTitle: "MQTT"
 | 
					linkTitle: "MQTT3"
 | 
				
			||||||
description: "Detailed documentation on the MQTT pubsub component"
 | 
					description: "Detailed documentation on the MQTT3 pubsub component"
 | 
				
			||||||
aliases:
 | 
					aliases:
 | 
				
			||||||
 | 
					  - "/operations/components/setup-pubsub/supported-pubsub/setup-mqtt3/"
 | 
				
			||||||
  - "/operations/components/setup-pubsub/supported-pubsub/setup-mqtt/"
 | 
					  - "/operations/components/setup-pubsub/supported-pubsub/setup-mqtt/"
 | 
				
			||||||
---
 | 
					---
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Component format
 | 
					## Component format
 | 
				
			||||||
 | 
					
 | 
				
			||||||
To setup MQTT pubsub create a component of type `pubsub.mqtt`. See [this guide]({{< ref "howto-publish-subscribe.md#step-1-setup-the-pubsub-component" >}}) on how to create and apply a pubsub configuration
 | 
					To setup a MQTT3 pubsub create a component of type `pubsub.mqtt3`. See [this guide]({{< ref "howto-publish-subscribe.md#step-1-setup-the-pubsub-component" >}}) on how to create and apply a pubsub configuration
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```yaml
 | 
					```yaml
 | 
				
			||||||
apiVersion: dapr.io/v1alpha1
 | 
					apiVersion: dapr.io/v1alpha1
 | 
				
			||||||
| 
						 | 
					@ -17,7 +18,7 @@ kind: Component
 | 
				
			||||||
metadata:
 | 
					metadata:
 | 
				
			||||||
  name: mqtt-pubsub
 | 
					  name: mqtt-pubsub
 | 
				
			||||||
spec:
 | 
					spec:
 | 
				
			||||||
  type: pubsub.mqtt
 | 
					  type: pubsub.mqtt3
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  metadata:
 | 
					  metadata:
 | 
				
			||||||
  - name: url
 | 
					  - name: url
 | 
				
			||||||
| 
						 | 
					@ -59,7 +60,7 @@ kind: Component
 | 
				
			||||||
metadata:
 | 
					metadata:
 | 
				
			||||||
  name: mqtt-pubsub
 | 
					  name: mqtt-pubsub
 | 
				
			||||||
spec:
 | 
					spec:
 | 
				
			||||||
  type: pubsub.mqtt
 | 
					  type: pubsub.mqtt3
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  metadata:
 | 
					  metadata:
 | 
				
			||||||
  - name: url
 | 
					  - name: url
 | 
				
			||||||
| 
						 | 
					@ -96,7 +97,7 @@ kind: Component
 | 
				
			||||||
metadata:
 | 
					metadata:
 | 
				
			||||||
  name: mqtt-pubsub
 | 
					  name: mqtt-pubsub
 | 
				
			||||||
spec:
 | 
					spec:
 | 
				
			||||||
  type: pubsub.mqtt
 | 
					  type: pubsub.mqtt3
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  metadata:
 | 
					  metadata:
 | 
				
			||||||
    - name: consumerID
 | 
					    - name: consumerID
 | 
				
			||||||
| 
						 | 
					@ -119,7 +120,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Note that in the case, the value of the consumer ID is random every time Dapr restarts, so we are setting `cleanSession` to true as well.
 | 
					Note that in the case, the value of the consumer ID is random every time Dapr restarts, so we are setting `cleanSession` to true as well.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Create a MQTT broker
 | 
					## Create a MQTT3 broker
 | 
				
			||||||
 | 
					
 | 
				
			||||||
{{< tabs "Self-Hosted" "Kubernetes">}}
 | 
					{{< tabs "Self-Hosted" "Kubernetes">}}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -134,7 +135,7 @@ You can then interact with the server using the client port: `mqtt://localhost:1
 | 
				
			||||||
{{% /codetab %}}
 | 
					{{% /codetab %}}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
{{% codetab %}}
 | 
					{{% codetab %}}
 | 
				
			||||||
You can run a MQTT broker in kubernetes using following yaml:
 | 
					You can run a MQTT3 broker in kubernetes using following yaml:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```yaml
 | 
					```yaml
 | 
				
			||||||
apiVersion: apps/v1
 | 
					apiVersion: apps/v1
 | 
				
			||||||
| 
						 | 
					@ -54,8 +54,8 @@
 | 
				
			||||||
  features:
 | 
					  features:
 | 
				
			||||||
    input: false
 | 
					    input: false
 | 
				
			||||||
    output: true
 | 
					    output: true
 | 
				
			||||||
- component: MQTT
 | 
					- component: MQTT3
 | 
				
			||||||
  link: mqtt
 | 
					  link: mqtt3
 | 
				
			||||||
  state: Beta
 | 
					  state: Beta
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  since: "1.7"
 | 
					  since: "1.7"
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -28,8 +28,8 @@
 | 
				
			||||||
  state: Beta
 | 
					  state: Beta
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  since: "1.7"
 | 
					  since: "1.7"
 | 
				
			||||||
- component: MQTT
 | 
					- component: MQTT3
 | 
				
			||||||
  link: setup-mqtt
 | 
					  link: setup-mqtt3
 | 
				
			||||||
  state: Stable
 | 
					  state: Stable
 | 
				
			||||||
  version: v1
 | 
					  version: v1
 | 
				
			||||||
  since: "1.7"
 | 
					  since: "1.7"
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue