forked from iresty / Apache APISIX

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

克隆/下载

mqtt-proxy.md 3.22 KB

- [中文](../zh-cn/plugins/mqtt-proxy.md)

# Summary

- [**Name**](#name)
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
- [**Delete Plugin**](#delete-plugin)

## Name

The plugin `mqtt-proxy` only works in stream model, it help you to dynamic load
balance by `client_id` of MQTT.

And this plugin both support MQTT protocol [3.1.*](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html) and [5.0](https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html).

## Attributes

| Name           | Type    | Requirement | Default | Valid | Description                                                                            |
| -------------- | ------- | ----------- | ------- | ----- | -------------------------------------------------------------------------------------- |
| protocol_name  | string  | required    |         |       | Name of protocol, should be `MQTT` in normal.                                          |
| protocol_level | integer | required    |         |       | Level of protocol, it should be `4` for MQTT `3.1.*`. it should be `5` for MQTT `5.0`. |
| upstream.ip    | string  | required    |         |       | IP address of upstream, will forward current request to.                               |
| upstream.port  | number  | required    |         |       | Port of upstream, will forward current request to.                                     |

## How To Enable

To enable this plugin, we need to enable the stream_proxy configuration in `conf/config.yaml` first.
For example, the following configuration represents listening on the 9100 TCP port.

```yaml
    ...
    router:
        http: 'radixtree_uri'
        ssl: 'radixtree_sni'
    stream_proxy:                 # TCP/UDP proxy
      tcp:                        # TCP proxy port list
        - 9100
    dns_resolver:
    ...
```

Then send the MQTT request to port 9100.

Creates a stream route, and enable plugin `mqtt-proxy`.

```shell
curl http://127.0.0.1:9080/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "remote_addr": "127.0.0.1",
    "plugins": {
        "mqtt-proxy": {
            "protocol_name": "MQTT",
            "protocol_level": 4,
            "upstream": {
                "ip": "127.0.0.1",
                "port": 1980
            }
        }
    }
}'
```

## Delete Plugin

```shell
$ curl http://127.0.0.1:2379/v2/keys/apisix/stream_routes/1 -X DELETE
```

The `mqtt-proxy` plugin has been deleted now.

一键复制编辑原始数据按行查看历史

提交于 2021-01-26 11:32 . docs: fix table of contents links (#3414)

中文

Summary

Name
Attributes
How To Enable
Delete Plugin

Name

The plugin mqtt-proxy only works in stream model, it help you to dynamic load balance by client_id of MQTT.

And this plugin both support MQTT protocol 3.1.* and 5.0.

Attributes

Name	Type	Requirement	Default	Valid	Description
protocol_name	string	required			Name of protocol, should be `MQTT` in normal.
protocol_level	integer	required			Level of protocol, it should be `4` for MQTT `3.1.*`. it should be `5` for MQTT `5.0`.
upstream.ip	string	required			IP address of upstream, will forward current request to.
upstream.port	number	required			Port of upstream, will forward current request to.

How To Enable

To enable this plugin, we need to enable the stream_proxy configuration in conf/config.yaml first. For example, the following configuration represents listening on the 9100 TCP port.

    ...
    router:
        http: 'radixtree_uri'
        ssl: 'radixtree_sni'
    stream_proxy:                 # TCP/UDP proxy
      tcp:                        # TCP proxy port list
        - 9100
    dns_resolver:
    ...

Then send the MQTT request to port 9100.

Creates a stream route, and enable plugin mqtt-proxy.

curl http://127.0.0.1:9080/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "remote_addr": "127.0.0.1",
    "plugins": {
        "mqtt-proxy": {
            "protocol_name": "MQTT",
            "protocol_level": 4,
            "upstream": {
                "ip": "127.0.0.1",
                "port": 1980
            }
        }
    }
}'

Delete Plugin

$ curl http://127.0.0.1:2379/v2/keys/apisix/stream_routes/1 -X DELETE

The mqtt-proxy plugin has been deleted now.

Lua

1

https://gitee.com/limengcanyu/apisix.git

git@gitee.com:limengcanyu/apisix.git

limengcanyu

apisix

Apache APISIX

master