From dfb591cac709c8ebbf9ab7877a14ede3126ac409 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Sat, 12 Feb 2022 14:31:10 +0100 Subject: [PATCH 01/31] ci: use exclude instead of include for build matrix include is unconditional, as a result, it brins in emqx profile to enterprise repo --- .github/workflows/build_packages.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build_packages.yaml b/.github/workflows/build_packages.yaml index 87f42f55e..8573d84ac 100644 --- a/.github/workflows/build_packages.yaml +++ b/.github/workflows/build_packages.yaml @@ -346,8 +346,12 @@ jobs: profile: ${{fromJSON(needs.prepare.outputs.profiles)}} registry: - 'docker.io' - include: - - profile: emqx + - 'public.ecr.aws' + exclude: + # we don't have an aws ecr repo for enterprise and edge yet + - profile: emqx-edge + registry: 'public.ecr.aws' + - profile: emqx-ee registry: 'public.ecr.aws' steps: From f6ca64c76dad500015a1cb61f14f8af49c478c48 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Sun, 13 Feb 2022 22:10:58 +0100 Subject: [PATCH 02/31] feat: add pem cache CLI --- CHANGES-4.3.md | 9 ++++++ .../src/emqx_management.app.src | 2 +- apps/emqx_management/src/emqx_mgmt.erl | 21 ++++++++++++-- apps/emqx_management/src/emqx_mgmt_cli.erl | 29 ++++++++++++++++++- .../emqx_dashboard/src/emqx_dashboard.app.src | 2 +- 5 files changed, 57 insertions(+), 6 deletions(-) diff --git a/CHANGES-4.3.md b/CHANGES-4.3.md index 7c421f75e..3e84d406d 100644 --- a/CHANGES-4.3.md +++ b/CHANGES-4.3.md @@ -10,6 +10,15 @@ File format: - One list item per change topic Change log ends with a list of github PRs +## v4.3.13 + +### Enhancements + +* CLI `emqx_ctl pem_cache clean` to force purge x509 certificate cache, + to force an immediate reload of all certificates after the files are updated on disk. + +### Bug fixes + ## v4.3.12 ### Important changes diff --git a/apps/emqx_management/src/emqx_management.app.src b/apps/emqx_management/src/emqx_management.app.src index e8b235be7..bee65781a 100644 --- a/apps/emqx_management/src/emqx_management.app.src +++ b/apps/emqx_management/src/emqx_management.app.src @@ -1,6 +1,6 @@ {application, emqx_management, [{description, "EMQ X Management API and CLI"}, - {vsn, "4.3.10"}, % strict semver, bump manually! + {vsn, "4.3.11"}, % strict semver, bump manually! {modules, []}, {registered, [emqx_management_sup]}, {applications, [kernel,stdlib,minirest]}, diff --git a/apps/emqx_management/src/emqx_mgmt.erl b/apps/emqx_management/src/emqx_mgmt.erl index e68a6163f..2a9636b6b 100644 --- a/apps/emqx_management/src/emqx_mgmt.erl +++ b/apps/emqx_management/src/emqx_mgmt.erl @@ -51,6 +51,10 @@ , set_quota_policy/2 ]). +-export([ clean_pem_cache/0 + , clean_pem_cache/1 + ]). + %% Internal funcs -export([call_client/3]). @@ -254,15 +258,17 @@ clean_acl_cache(Node, ClientId) -> rpc_call(Node, clean_acl_cache, [Node, ClientId]). clean_acl_cache_all() -> - Results = [{Node, clean_acl_cache_all(Node)} || Node <- ekka_mnesia:running_nodes()], - case lists:filter(fun({_Node, Item}) -> Item =/= ok end, Results) of + for_nodes(fun clean_acl_cache_all/1). + +for_nodes(F) -> + Results = [{Node, F(Node)} || Node <- ekka_mnesia:running_nodes()], + case lists:filter(fun({_Node, Res}) -> Res =/= ok end, Results) of [] -> ok; BadNodes -> {error, BadNodes} end. clean_acl_cache_all(Node) when Node =:= node() -> emqx_acl_cache:drain_cache(); - clean_acl_cache_all(Node) -> rpc_call(Node, clean_acl_cache_all, [Node]). @@ -272,6 +278,15 @@ set_ratelimit_policy(ClientId, Policy) -> set_quota_policy(ClientId, Policy) -> call_client(ClientId, {quota, Policy}). +clean_pem_cache() -> + for_nodes(fun clean_pem_cache/1). + +clean_pem_cache(Node) when Node =:= node() -> + _ = ssl_pem_cache:clear(), + ok; +clean_pem_cache(Node) -> + rpc_call(Node, ?FUNCTION_NAME, [Node]). + %% @private call_client(ClientId, Req) -> Results = [call_client(Node, ClientId, Req) || Node <- ekka_mnesia:running_nodes()], diff --git a/apps/emqx_management/src/emqx_mgmt_cli.erl b/apps/emqx_management/src/emqx_mgmt_cli.erl index 95f5121cd..92dc4c578 100644 --- a/apps/emqx_management/src/emqx_mgmt_cli.erl +++ b/apps/emqx_management/src/emqx_mgmt_cli.erl @@ -40,6 +40,7 @@ , mgmt/1 , data/1 , acl/1 + , pem_cache/1 ]). -define(PROC_INFOKEYS, [status, @@ -576,7 +577,7 @@ data(_) -> %% @doc acl Command acl(["cache-clean", "node", Node]) -> - case emqx_mgmt:clean_acl_cache_all(erlang:list_to_existing_atom(Node)) of + case for_node(fun emqx_mgmt:clean_acl_cache_all/1, Node) of ok -> emqx_ctl:print("ACL cache drain started on node ~s.~n", [Node]); {error, Reason} -> @@ -600,6 +601,15 @@ acl(_) -> {"acl cache-clean ", "Clears acl cache for given client"} ]). +pem_cache(["clean", "all"]) -> + with_log(fun emqx_mgmt:clean_pem_cache/0, "PEM cache clean"); +pem_cache(["clean", "node", Node]) -> + with_log(fun() -> for_node(fun emqx_mgmt:clean_pem_cache/1, Node) end, "PEM cache clean"); +pem_cache(_) -> + emqx_ctl:usage([{"pem_cache clean all", "Clears x509 certificate cache on all nodes"}, + {"pem_cache clean node ", "Clears x509 certificate cache on given node"} + ]). + %%-------------------------------------------------------------------- %% Dump ETS %%-------------------------------------------------------------------- @@ -721,3 +731,20 @@ restart_http_listener(Scheme, AppName) -> http_mod_name(emqx_management) -> emqx_mgmt_http; http_mod_name(Name) -> Name. + +for_node(Fun, Node) -> + try list_to_existing_atom(Node) of + NodeAtom -> + Fun(NodeAtom) + catch + error : badarg -> + {error, unknown_node} + end. + +with_log(Fun, Msg) -> + case Fun() of + ok -> + emqx_ctl:print("~s OK~n", [Msg]); + {error, Reason} -> + emqx_ctl:print("~s FAILED~n~p~n", [Msg, Reason]) + end. diff --git a/lib-ce/emqx_dashboard/src/emqx_dashboard.app.src b/lib-ce/emqx_dashboard/src/emqx_dashboard.app.src index ea5ecdd79..efd362156 100644 --- a/lib-ce/emqx_dashboard/src/emqx_dashboard.app.src +++ b/lib-ce/emqx_dashboard/src/emqx_dashboard.app.src @@ -1,6 +1,6 @@ {application, emqx_dashboard, [{description, "EMQ X Web Dashboard"}, - {vsn, "4.3.8"}, % strict semver, bump manually! + {vsn, "4.3.9"}, % strict semver, bump manually! {modules, []}, {registered, [emqx_dashboard_sup]}, {applications, [kernel,stdlib,mnesia,minirest]}, From 91180595d038a1d9931794f657985688ea0f4706 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Sun, 13 Feb 2022 22:16:27 +0100 Subject: [PATCH 03/31] refactor(cli): simplify ACL cache CLI logging --- apps/emqx_management/src/emqx_mgmt_cli.erl | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/apps/emqx_management/src/emqx_mgmt_cli.erl b/apps/emqx_management/src/emqx_mgmt_cli.erl index 92dc4c578..7ca7a9cf6 100644 --- a/apps/emqx_management/src/emqx_mgmt_cli.erl +++ b/apps/emqx_management/src/emqx_mgmt_cli.erl @@ -577,21 +577,11 @@ data(_) -> %% @doc acl Command acl(["cache-clean", "node", Node]) -> - case for_node(fun emqx_mgmt:clean_acl_cache_all/1, Node) of - ok -> - emqx_ctl:print("ACL cache drain started on node ~s.~n", [Node]); - {error, Reason} -> - emqx_ctl:print("ACL drain failed on node ~s: ~0p.~n", [Node, Reason]) - end; - + with_log(fun() -> for_node(fun emqx_mgmt:clean_acl_cache_all/1, Node) end, + "ACL cache drain start"); acl(["cache-clean", "all"]) -> - case emqx_mgmt:clean_acl_cache_all() of - ok -> - emqx_ctl:print("Started ACL cache drain in all nodes~n"); - {error, Reason} -> - emqx_ctl:print("ACL cache-clean failed: ~p.~n", [Reason]) - end; - + with_log(fun emqx_mgmt:clean_acl_cache_all/1, + "ACL cache drain start"); acl(["cache-clean", ClientId]) -> emqx_mgmt:clean_acl_cache(ClientId); From 8302cac32992df665995608ec5c8e70ce6daaa4b Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Thu, 10 Feb 2022 16:19:19 -0300 Subject: [PATCH 04/31] fix(channel): wrong case clause when alias is inexistent Fixes #6978 . --- src/emqx_channel.erl | 5 ++--- test/emqx_channel_SUITE.erl | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/src/emqx_channel.erl b/src/emqx_channel.erl index 20257911b..dc0c52598 100644 --- a/src/emqx_channel.erl +++ b/src/emqx_channel.erl @@ -1341,7 +1341,7 @@ process_alias(Packet = #mqtt_packet{ {ok, Topic} -> NPublish = Publish#mqtt_packet_publish{topic_name = Topic}, {ok, Packet#mqtt_packet{variable = NPublish}, Channel}; - false -> {error, ?RC_PROTOCOL_ERROR} + error -> {error, ?RC_PROTOCOL_ERROR} end; process_alias(#mqtt_packet{ @@ -1685,7 +1685,7 @@ run_hooks(Name, Args, Acc) -> -compile({inline, [find_alias/3, save_alias/4]}). -find_alias(_, _, undefined) -> false; +find_alias(_, _, undefined) -> error; find_alias(inbound, AliasId, _TopicAliases = #{inbound := Aliases}) -> maps:find(AliasId, Aliases); find_alias(outbound, Topic, _TopicAliases = #{outbound := Aliases}) -> @@ -1739,4 +1739,3 @@ flag(false) -> 0. set_field(Name, Value, Channel) -> Pos = emqx_misc:index_of(Name, record_info(fields, channel)), setelement(Pos+1, Channel, Value). - diff --git a/test/emqx_channel_SUITE.erl b/test/emqx_channel_SUITE.erl index a438fc79a..fd7da9f20 100644 --- a/test/emqx_channel_SUITE.erl +++ b/test/emqx_channel_SUITE.erl @@ -674,6 +674,13 @@ t_process_alias(_) -> {ok, #mqtt_packet{variable = #mqtt_packet_publish{topic_name = <<"t">>}}, _Chan} = emqx_channel:process_alias(#mqtt_packet{variable = Publish}, Channel). +t_process_alias_inexistent_alias(_) -> + Publish = #mqtt_packet_publish{topic_name = <<>>, properties = #{'Topic-Alias' => 1}}, + Channel = channel(), + ?assertEqual( + {error, ?RC_PROTOCOL_ERROR}, + emqx_channel:process_alias(#mqtt_packet{variable = Publish}, Channel)). + t_packing_alias(_) -> Packet1 = #mqtt_packet{variable = #mqtt_packet_publish{ topic_name = <<"x">>, @@ -710,6 +717,20 @@ t_packing_alias(_) -> #mqtt_packet{variable = #mqtt_packet_publish{topic_name = <<"z">>}}, channel())). +t_packing_alias_inexistent_alias(_) -> + Publish = #mqtt_packet_publish{topic_name = <<>>, properties = #{'Topic-Alias' => 1}}, + Channel = channel(), + Packet = #mqtt_packet{variable = Publish}, + ExpectedChannel = emqx_channel:set_field( + topic_aliases, + #{ inbound => #{} + , outbound => #{<<>> => 1} + }, + Channel), + ?assertEqual( + {Packet, ExpectedChannel}, + emqx_channel:packing_alias(Packet, Channel)). + t_check_pub_acl(_) -> ok = meck:expect(emqx_zone, enable_acl, fun(_) -> true end), Publish = ?PUBLISH_PACKET(?QOS_0, <<"t">>, 1, <<"payload">>), From acf3b8cbe90b73c80fe94fe082d232fa8918782a Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 11 Feb 2022 17:18:29 -0300 Subject: [PATCH 05/31] chore(emqx): update appup --- src/emqx.app.src | 2 +- src/emqx.appup.src | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/emqx.app.src b/src/emqx.app.src index 1119deccb..1c6b05de4 100644 --- a/src/emqx.app.src +++ b/src/emqx.app.src @@ -1,7 +1,7 @@ {application, emqx, [{id, "emqx"}, {description, "EMQ X"}, - {vsn, "4.3.13"}, % strict semver, bump manually! + {vsn, "4.3.14"}, % strict semver, bump manually! {modules, []}, {registered, []}, {applications, [kernel,stdlib,gproc,gen_rpc,esockd,cowboy,sasl,os_mon]}, diff --git a/src/emqx.appup.src b/src/emqx.appup.src index df1b7c14e..cd5b02954 100644 --- a/src/emqx.appup.src +++ b/src/emqx.appup.src @@ -1,6 +1,7 @@ %% -*- mode: erlang -*- {VSN, - [{"4.3.12", + [{"4.3.13",[{load_module,emqx_channel,brutal_purge,soft_purge,[]}]}, + {"4.3.12", [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, @@ -335,7 +336,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {<<".*">>,[]}], - [{"4.3.12", + [{"4.3.13",[{load_module,emqx_channel,brutal_purge,soft_purge,[]}]}, + {"4.3.12", [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_channel,brutal_purge,soft_purge,[]}, From b6e9043c497ac87c2014f7eb78a78921def84742 Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 11 Feb 2022 17:22:08 -0300 Subject: [PATCH 06/31] chore(changelog): update changelog --- CHANGES-4.3.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGES-4.3.md b/CHANGES-4.3.md index 3e84d406d..2d7f13b0d 100644 --- a/CHANGES-4.3.md +++ b/CHANGES-4.3.md @@ -19,6 +19,8 @@ File format: ### Bug fixes +* Fix case where publishing to a non-existent topic alias would crash the connection [#6979] + ## v4.3.12 ### Important changes From 3f31df2297f6be6b143f120a7648c5e9123a5a2b Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Mon, 14 Feb 2022 11:06:51 -0300 Subject: [PATCH 07/31] docs: add comment explaining application and release vsn discrepancy --- src/emqx.app.src | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/emqx.app.src b/src/emqx.app.src index 1c6b05de4..66ab590ca 100644 --- a/src/emqx.app.src +++ b/src/emqx.app.src @@ -1,6 +1,11 @@ {application, emqx, [{id, "emqx"}, {description, "EMQ X"}, + %% Note: this version is not the same as the release version! This + %% is simply the emqx `application' version, which is separate from + %% the emqx `release' version, which in turn is comprised of several + %% apps, one of which is this. See `emqx_release.hrl' for more + %% info. {vsn, "4.3.14"}, % strict semver, bump manually! {modules, []}, {registered, []}, From c1f77da3b91caf92c592df727918ae323a32dc7b Mon Sep 17 00:00:00 2001 From: zhanghongtong Date: Tue, 15 Feb 2022 10:11:34 +0800 Subject: [PATCH 08/31] ci(build_packages): add target event --- .github/workflows/build_packages.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/build_packages.yaml b/.github/workflows/build_packages.yaml index 8573d84ac..13a463da9 100644 --- a/.github/workflows/build_packages.yaml +++ b/.github/workflows/build_packages.yaml @@ -1,6 +1,9 @@ name: Cross build packages on: + push: + branches: + - 'main-v4.**' schedule: - cron: '0 */6 * * *' release: From 88769bc23bd10a5f290164524583bec23a750da3 Mon Sep 17 00:00:00 2001 From: zhanghongtong Date: Tue, 15 Feb 2022 10:15:25 +0800 Subject: [PATCH 09/31] ci(build_packages): cancel repeating actions --- .github/workflows/build_packages.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/build_packages.yaml b/.github/workflows/build_packages.yaml index 13a463da9..b3e63d58f 100644 --- a/.github/workflows/build_packages.yaml +++ b/.github/workflows/build_packages.yaml @@ -1,5 +1,9 @@ name: Cross build packages +concurrency: + group: build-${{ github.event_name }}-${{ github.ref }} + cancel-in-progress: true + on: push: branches: From 425546864dfe7268cc5fd818fc27f0bf4933e682 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Tue, 15 Feb 2022 11:23:44 +0800 Subject: [PATCH 10/31] fix(lwm2m): fix querying lwm2m client list on the another node --- apps/emqx_lwm2m/src/emqx_lwm2m_api.erl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apps/emqx_lwm2m/src/emqx_lwm2m_api.erl b/apps/emqx_lwm2m/src/emqx_lwm2m_api.erl index 6018aa7c7..6e616fd1e 100644 --- a/apps/emqx_lwm2m/src/emqx_lwm2m_api.erl +++ b/apps/emqx_lwm2m/src/emqx_lwm2m_api.erl @@ -51,7 +51,7 @@ ]). list(#{node := Node }, Params) -> - case Node = node() of + case Node =:= node() of true -> list(#{}, Params); _ -> rpc_call(Node, list, [#{}, Params]) end; @@ -61,7 +61,7 @@ list(#{}, _Params) -> return({ok, format(Channels)}). lookup_cmd(#{ep := Ep, node := Node}, Params) -> - case Node = node() of + case Node =:= node() of true -> lookup_cmd(#{ep => Ep}, Params); _ -> rpc_call(Node, lookup_cmd, [#{ep => Ep}, Params]) end; From 74aa209207fc39b9cfa10fd47e4a8e0efdd3c304 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Tue, 15 Feb 2022 11:33:18 +0800 Subject: [PATCH 11/31] chore(lwm2m): update app.src & appup.src --- apps/emqx_lwm2m/src/emqx_lwm2m.app.src | 13 +++++++------ apps/emqx_lwm2m/src/emqx_lwm2m.appup.src | 16 ++++++++++------ 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/apps/emqx_lwm2m/src/emqx_lwm2m.app.src b/apps/emqx_lwm2m/src/emqx_lwm2m.app.src index b929ad854..717433c96 100644 --- a/apps/emqx_lwm2m/src/emqx_lwm2m.app.src +++ b/apps/emqx_lwm2m/src/emqx_lwm2m.app.src @@ -1,7 +1,8 @@ {application,emqx_lwm2m, - [{description,"EMQ X LwM2M Gateway"}, - {vsn, "4.3.5"}, % strict semver, bump manually! - {modules,[]}, - {registered,[emqx_lwm2m_sup]}, - {applications,[kernel,stdlib,lwm2m_coap]}, - {mod,{emqx_lwm2m_app,[]}}]}. + [{description,"EMQ X LwM2M Gateway"}, + {vsn, "4.3.6"}, % strict semver, bump manually! + {modules,[]}, + {registered,[emqx_lwm2m_sup]}, + {applications,[kernel,stdlib,lwm2m_coap]}, + {mod,{emqx_lwm2m_app,[]}}] +}. diff --git a/apps/emqx_lwm2m/src/emqx_lwm2m.appup.src b/apps/emqx_lwm2m/src/emqx_lwm2m.appup.src index c2b7e7bc4..e9f270397 100644 --- a/apps/emqx_lwm2m/src/emqx_lwm2m.appup.src +++ b/apps/emqx_lwm2m/src/emqx_lwm2m.appup.src @@ -4,13 +4,17 @@ [{restart_application,emqx_lwm2m}]}, {"4.3.2", [{load_module,emqx_lwm2m_protocol,brutal_purge,soft_purge,[]}, - {load_module,emqx_lwm2m_message,brutal_purge,soft_purge,[]}]}, - {"4.3.3",[{load_module,emqx_lwm2m_protocol,brutal_purge,soft_purge,[]}]}, - {"4.3.4",[{load_module,emqx_lwm2m_protocol,brutal_purge,soft_purge,[]}]}], + {load_module,emqx_lwm2m_message,brutal_purge,soft_purge,[]}, + {load_module,emqx_lwm2m_api,brutal_purge,soft_purge,[]}]}, + {<<"4\\.3\\.[3-5]">>, + [{load_module,emqx_lwm2m_protocol,brutal_purge,soft_purge,[]}, + {load_module,emqx_lwm2m_api,brutal_purge,soft_purge,[]}]}], [{<<"4\\.3\\.[0-1]">>, [{restart_application,emqx_lwm2m}]}, {"4.3.2", [{load_module,emqx_lwm2m_protocol,brutal_purge,soft_purge,[]}, - {load_module,emqx_lwm2m_message,brutal_purge,soft_purge,[]}]}, - {"4.3.3",[{load_module,emqx_lwm2m_protocol,brutal_purge,soft_purge,[]}]}, - {"4.3.4",[{load_module,emqx_lwm2m_protocol,brutal_purge,soft_purge,[]}]}]}. + {load_module,emqx_lwm2m_message,brutal_purge,soft_purge,[]}, + {load_module,emqx_lwm2m_api,brutal_purge,soft_purge,[]}]}, + {<<"4\\.3\\.[3-5]">>, + [{load_module,emqx_lwm2m_protocol,brutal_purge,soft_purge,[]}, + {load_module,emqx_lwm2m_api,brutal_purge,soft_purge,[]}]}]}. From 9fb53cb47d58c2649b52cabbc3f84202c45eaa69 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Tue, 15 Feb 2022 11:36:38 +0800 Subject: [PATCH 12/31] docs: update CHANGES-4.3.md --- CHANGES-4.3.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES-4.3.md b/CHANGES-4.3.md index 2d7f13b0d..983180251 100644 --- a/CHANGES-4.3.md +++ b/CHANGES-4.3.md @@ -20,6 +20,7 @@ File format: ### Bug fixes * Fix case where publishing to a non-existent topic alias would crash the connection [#6979] +* Fix HTTP-API 500 error on querying the lwm2m client list on the another node [#7009] ## v4.3.12 ### Important changes From 091398d863beac5475e4742f8cdcc9adf584bb05 Mon Sep 17 00:00:00 2001 From: zhanghongtong Date: Tue, 15 Feb 2022 11:54:40 +0800 Subject: [PATCH 13/31] build(relup): add new script for download relup base packages --- .github/workflows/build_packages.yaml | 34 ++------------- .github/workflows/run_fvt_tests.yaml | 10 +---- Makefile | 12 +++++- build | 7 ++- deploy/docker/Dockerfile | 2 + scripts/relup-base-packages.sh | 62 +++++++++++++++++++++++++++ scripts/relup-base-vsns.sh | 3 ++ 7 files changed, 87 insertions(+), 43 deletions(-) create mode 100755 scripts/relup-base-packages.sh diff --git a/.github/workflows/build_packages.yaml b/.github/workflows/build_packages.yaml index 8573d84ac..08d92e981 100644 --- a/.github/workflows/build_packages.yaml +++ b/.github/workflows/build_packages.yaml @@ -15,7 +15,6 @@ jobs: outputs: profiles: ${{ steps.set_profile.outputs.profiles}} - old_vsns: ${{ steps.set_profile.outputs.old_vsns}} steps: - uses: actions/checkout@v2 @@ -28,12 +27,8 @@ jobs: run: | cd source if make emqx-ee --dry-run > /dev/null 2>&1; then - old_vsns="$(./scripts/relup-base-vsns.sh enterprise | xargs)" - echo "::set-output name=old_vsns::$old_vsns" echo "::set-output name=profiles::[\"emqx-ee\"]" else - old_vsns="$(./scripts/relup-base-vsns.sh community | xargs)" - echo "::set-output name=old_vsns::$old_vsns" echo "::set-output name=profiles::[\"emqx\", \"emqx-edge\"]" fi - name: get_all_deps @@ -216,6 +211,7 @@ jobs: needs: prepare strategy: + fail-fast: false matrix: profile: ${{fromJSON(needs.prepare.outputs.profiles)}} arch: @@ -269,32 +265,6 @@ jobs: path: . - name: unzip source code run: unzip -q source.zip - - name: downloads old emqx zip packages - env: - PROFILE: ${{ matrix.profile }} - ARCH: ${{ matrix.arch }} - SYSTEM: ${{ matrix.os }} - OLD_VSNS: ${{ needs.prepare.outputs.old_vsns }} - run: | - set -e -x -u - broker=$PROFILE - if [ $PROFILE = "emqx" ];then - broker="emqx-ce" - fi - if [ ! -z "$(echo $SYSTEM | grep -oE 'raspbian')" ]; then - export ARCH="arm" - fi - - mkdir -p source/_upgrade_base - cd source/_upgrade_base - old_vsns=($(echo $OLD_VSNS | tr ' ' ' ')) - for tag in ${old_vsns[@]}; do - if [ ! -z "$(echo $(curl -I -m 10 -o /dev/null -s -w %{http_code} https://s3-us-west-2.amazonaws.com/packages.emqx/$broker/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip) | grep -oE "^[23]+")" ];then - wget --no-verbose https://s3-us-west-2.amazonaws.com/packages.emqx/$broker/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip - wget --no-verbose https://s3-us-west-2.amazonaws.com/packages.emqx/$broker/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256 - echo "$(cat $PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256) $PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" | sha256sum -c || exit 1 - fi - done - name: build emqx packages env: ERL_OTP: erl23.2.7.2-emqx-3 @@ -342,6 +312,7 @@ jobs: needs: prepare strategy: + fail-fast: false matrix: profile: ${{fromJSON(needs.prepare.outputs.profiles)}} registry: @@ -439,6 +410,7 @@ jobs: needs: [prepare, mac, linux, docker] strategy: + fail-fast: false matrix: profile: ${{fromJSON(needs.prepare.outputs.profiles)}} diff --git a/.github/workflows/run_fvt_tests.yaml b/.github/workflows/run_fvt_tests.yaml index 6d4d94461..f8f03aabb 100644 --- a/.github/workflows/run_fvt_tests.yaml +++ b/.github/workflows/run_fvt_tests.yaml @@ -239,6 +239,7 @@ jobs: name: Checkout with: path: emqx + fetch-depth: 0 - name: Prepare credentials run: | if [ "$PROFILE" = "emqx-ee" ]; then @@ -246,15 +247,6 @@ jobs: git config --global credential.helper store echo "${{ secrets.CI_GIT_TOKEN }}" >> emqx/scripts/git-token fi - - name: Download bases - run: | - set -e -x -u - mkdir -p emqx/_upgrade_base - cd emqx/_upgrade_base - old_vsns=($(echo $OLD_VSNS | tr ' ' ' ')) - for old_vsn in ${old_vsns[@]}; do - wget --no-verbose https://s3-us-west-2.amazonaws.com/packages.emqx/$BROKER/$old_vsn/$PROFILE-ubuntu20.04-${old_vsn#[e|v]}-amd64.zip - done - name: Build emqx run: make -C emqx ${PROFILE}-zip - uses: actions/upload-artifact@v2 diff --git a/Makefile b/Makefile index ed7c5b6a3..6b3282272 100644 --- a/Makefile +++ b/Makefile @@ -3,6 +3,7 @@ REBAR_VERSION = 3.14.3-emqx-8 REBAR = $(CURDIR)/rebar3 BUILD = $(CURDIR)/build SCRIPTS = $(CURDIR)/scripts +export EMQX_RELUP ?= true export EMQX_DEFAULT_BUILDER = emqx/build-env:erl23.2.7.2-emqx-3-alpine export EMQX_DEFAULT_RUNNER = alpine:3.12 export PKG_VSN ?= $(shell $(CURDIR)/pkg-vsn.sh) @@ -125,10 +126,19 @@ COMMON_DEPS := $(REBAR) get-dashboard $(CONF_SEGS) $(REL_PROFILES:%=%-rel) $(PKG_PROFILES:%=%-rel): $(COMMON_DEPS) @$(BUILD) $(subst -rel,,$(@)) rel +## download relup base packages +.PHONY: $(REL_PROFILES:%=%-relup-downloads) +define download-relup-packages +$1-relup-downloads: + @if [ "$${EMQX_RELUP}" = "true" ]; then $(CURDIR)/scripts/relup-base-packages.sh $1; fi +endef +ALL_ZIPS = $(REL_PROFILES) +$(foreach zt,$(ALL_ZIPS),$(eval $(call download-relup-packages,$(zt)))) + ## relup target is to create relup instructions .PHONY: $(REL_PROFILES:%=%-relup) define gen-relup-target -$1-relup: $(COMMON_DEPS) +$1-relup: $1-relup-downloads $(COMMON_DEPS) @$(BUILD) $1 relup endef ALL_ZIPS = $(REL_PROFILES) diff --git a/build b/build index 684057bf1..96fc9db10 100755 --- a/build +++ b/build @@ -4,6 +4,9 @@ # arg1: profile, e.g. emqx | emqx-edge | emqx-pkg | emqx-edge-pkg # arg2: artifact, e.g. rel | relup | zip | pkg +if [[ -n "$DEBUG" ]]; then + set -x +fi set -euo pipefail PROFILE="$1" @@ -71,8 +74,8 @@ make_relup() { tmp_dir="$(mktemp -d -t emqx.XXXXXXX)" unzip -q "$zip" "emqx/releases/*" -d "$tmp_dir" unzip -q "$zip" "emqx/lib/*" -d "$tmp_dir" - cp -r -n "$tmp_dir/emqx/releases"/* "$releases_dir" - cp -r -n "$tmp_dir/emqx/lib"/* "$lib_dir" + cp -r -n "$tmp_dir/emqx/releases"/* "$releases_dir" || true + cp -r -n "$tmp_dir/emqx/lib"/* "$lib_dir" || true rm -rf "$tmp_dir" fi releases+=( "$base_vsn" ) diff --git a/deploy/docker/Dockerfile b/deploy/docker/Dockerfile index c79508ec1..b11ad1ee8 100644 --- a/deploy/docker/Dockerfile +++ b/deploy/docker/Dockerfile @@ -23,6 +23,8 @@ COPY . /emqx ARG PKG_VSN ARG EMQX_NAME=emqx +ENV EMQX_RELUP=false + RUN cd /emqx \ && rm -rf _build/$EMQX_NAME/lib \ && make $EMQX_NAME diff --git a/scripts/relup-base-packages.sh b/scripts/relup-base-packages.sh new file mode 100755 index 000000000..90aefe04f --- /dev/null +++ b/scripts/relup-base-packages.sh @@ -0,0 +1,62 @@ +#!/usr/bin/env bash +if [[ -n "$DEBUG" ]]; then + set -x +fi +set -euo pipefail + +PROFILE="${1}" +if [ "$PROFILE" = "" ]; then + $PROFILE="emqx" +fi + +case $PROFILE in + "emqx") + BROKER="broker" + ;; + "emqx-ee") + BROKER="enterprise" + ;; + "emqx-edge") + BROKER="edge" + ;; +esac + +SYSTEM="$(./scripts/get-distro.sh)" + +ARCH="$(uname -m)" +case "$ARCH" in + x86_64) + ARCH='amd64' + ;; + aarch64) + ARCH='arm64' + ;; + arm*) + ARCH=arm + ;; +esac + +SHASUM="sha256sum" +if [ "$SYSTEM" = "macos" ]; then + SHASUM="shasum -a 256" +fi + +# ensure dir +cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")/.." + +mkdir -p _upgrade_base +pushd _upgrade_base + +for tag in $(../scripts/relup-base-vsns.sh community | xargs echo -n); do + if [ ! -f "$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" ] \ + && [ ! -z "$(echo $(curl -I -m 10 -o /dev/null -s -w %{http_code} https://www.emqx.com/downloads/$BROKER/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip) | grep -oE "^[23]+")" ];then + wget --no-verbose https://www.emqx.com/downloads/$BROKER/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip + if [ "$SYSTEM" != "centos6" ]; then + wget --no-verbose https://www.emqx.com/downloads/$BROKER/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256 + ## https://askubuntu.com/questions/1202208/checking-sha256-checksum + echo "$(cat $PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256) $PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" | $SHASUM -c || exit 1 + fi + fi +done + +popd diff --git a/scripts/relup-base-vsns.sh b/scripts/relup-base-vsns.sh index 65d755994..96e43bb65 100755 --- a/scripts/relup-base-vsns.sh +++ b/scripts/relup-base-vsns.sh @@ -1,6 +1,9 @@ #!/usr/bin/env bash set -euo pipefail +# ensure dir +cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")/.." + ## This script prints the relup upgrade base versions ## for the given EMQ X edition (specified as first arg) ## From e09e5673eb9d4793a2fc940826730cf6b039375a Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 15 Feb 2022 16:09:42 +0100 Subject: [PATCH 14/31] docs(README): EMQ X -> EMQX --- README-CN.md | 26 ++++++------ README-JP.md | 26 ++++++------ README-RU.md | 18 ++++----- README.md | 22 +++++----- apps/emqx_auth_http/README.md | 4 +- apps/emqx_auth_jwt/README.md | 4 +- apps/emqx_auth_ldap/README.md | 4 +- apps/emqx_auth_mongo/README.md | 4 +- apps/emqx_auth_mysql/README.md | 2 +- apps/emqx_auth_pgsql/README.md | 2 +- apps/emqx_auth_redis/README.md | 4 +- apps/emqx_bridge_mqtt/README.md | 26 ++++++------ apps/emqx_bridge_mqtt/docs/guide.rst | 26 ++++++------ apps/emqx_coap/README.md | 4 +- apps/emqx_exhook/README.md | 4 +- apps/emqx_exproto/README.md | 4 +- apps/emqx_lua_hook/README.md | 2 +- apps/emqx_lwm2m/README.md | 4 +- apps/emqx_management/README.md | 2 +- apps/emqx_prometheus/README.md | 6 +-- apps/emqx_recon/README.md | 4 +- apps/emqx_retainer/README.md | 4 +- apps/emqx_rule_engine/README.md | 2 +- apps/emqx_sn/README.md | 4 +- apps/emqx_stomp/README.md | 4 +- apps/emqx_web_hook/README.md | 4 +- deploy/charts/emqx/README.md | 60 ++++++++++++++-------------- deploy/docker/README.md | 20 +++++----- lib-ce/emqx_dashboard/README.md | 2 +- lib-extra/README.md | 4 +- 30 files changed, 151 insertions(+), 151 deletions(-) diff --git a/README-CN.md b/README-CN.md index 7d2888327..ae03a7280 100644 --- a/README-CN.md +++ b/README-CN.md @@ -1,4 +1,4 @@ -# EMQ X Broker +# EMQX Broker [![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen)](https://github.com/emqx/emqx/releases) [![Build Status](https://travis-ci.org/emqx/emqx.svg)](https://travis-ci.org/emqx/emqx) @@ -13,20 +13,20 @@ [English](./README.md) | 简体中文 | [日本語](./README-JP.md) | [русский](./README-RU.md) -*EMQ X* 是一款完全开源，高度可伸缩，高可用的分布式 MQTT 消息服务器，适用于 IoT、M2M 和移动应用程序，可处理千万级别的并发客户端。 +*EMQX* 是一款完全开源，高度可伸缩，高可用的分布式 MQTT 消息服务器，适用于 IoT、M2M 和移动应用程序，可处理千万级别的并发客户端。 -从 3.0 版本开始，*EMQ X* 完整支持 MQTT V5.0 协议规范，向下兼容 MQTT V3.1 和 V3.1.1，并支持 MQTT-SN、CoAP、LwM2M、WebSocket 和 STOMP 等通信协议。EMQ X 3.0 单集群可支持千万级别的 MQTT 并发连接。 +从 3.0 版本开始，*EMQX* 完整支持 MQTT V5.0 协议规范，向下兼容 MQTT V3.1 和 V3.1.1，并支持 MQTT-SN、CoAP、LwM2M、WebSocket 和 STOMP 等通信协议。EMQX 3.0 单集群可支持千万级别的 MQTT 并发连接。 -- 新功能的完整列表，请参阅 [EMQ X Release Notes](https://github.com/emqx/emqx/releases)。 -- 获取更多信息，请访问 [EMQ X 官网](https://www.emqx.cn/)。 +- 新功能的完整列表，请参阅 [EMQX Release Notes](https://github.com/emqx/emqx/releases)。 +- 获取更多信息，请访问 [EMQX 官网](https://www.emqx.cn/)。 ## 安装 -*EMQ X* 是跨平台的，支持 Linux、Unix、macOS 以及 Windows。这意味着 *EMQ X* 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。 +*EMQX* 是跨平台的，支持 Linux、Unix、macOS 以及 Windows。这意味着 *EMQX* 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。 -Windows 上编译和运行 *EMQ X* 的详情参考：[Windows.md](./Windows.md) +Windows 上编译和运行 *EMQX* 的详情参考：[Windows.md](./Windows.md) -#### EMQ X Docker 镜像安装 +#### EMQX Docker 镜像安装 ``` docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx @@ -34,14 +34,14 @@ docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p #### 二进制软件包安装 -需从 [EMQ X 下载](https://www.emqx.cn/downloads) 页面获取相应操作系统的二进制软件包。 +需从 [EMQX 下载](https://www.emqx.cn/downloads) 页面获取相应操作系统的二进制软件包。 - [单节点安装文档](https://docs.emqx.cn/broker/latest/getting-started/install.html) - [集群配置文档](https://docs.emqx.cn/broker/latest/advanced/cluster.html) ## 从源码构建 -3.0 版本开始，构建 *EMQ X* 需要 Erlang/OTP R21+。 +3.0 版本开始，构建 *EMQX* 需要 Erlang/OTP R21+。 4.3 及以后的版本： @@ -77,7 +77,7 @@ _build/emqx/rel/emqx/bin/emqx console ./bin/emqx stop ``` -*EMQ X* 启动，可以使用浏览器访问 http://localhost:18083 来查看 Dashboard。 +*EMQX* 启动，可以使用浏览器访问 http://localhost:18083 来查看 Dashboard。 ## 测试 @@ -108,7 +108,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_auth_jwt,emqx_auth_ldap make dialyzer ### FAQ -访问 [EMQ X FAQ](https://docs.emqx.cn/broker/latest/faq/faq.html) 以获取常见问题的帮助。 +访问 [EMQX FAQ](https://docs.emqx.cn/broker/latest/faq/faq.html) 以获取常见问题的帮助。 ### 问答 @@ -117,7 +117,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_auth_jwt,emqx_auth_ldap make dialyzer ### 参与设计 -如果对 EMQ X 有改进建议，可以向[EIP](https://github.com/emqx/eip) 提交 PR 和 ISSUE +如果对 EMQX 有改进建议，可以向[EIP](https://github.com/emqx/eip) 提交 PR 和 ISSUE ### 插件开发 diff --git a/README-JP.md b/README-JP.md index b7afe8195..4a8ac5d6d 100644 --- a/README-JP.md +++ b/README-JP.md @@ -1,4 +1,4 @@ -# EMQ X Broker +# EMQX Broker [![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen)](https://github.com/emqx/emqx/releases) [![Build Status](https://travis-ci.org/emqx/emqx.svg)](https://travis-ci.org/emqx/emqx) @@ -12,22 +12,22 @@ [English](./README.md) | [简体中文](./README-CN.md) | 日本語 | [русский](./README-RU.md) -*EMQ X* は、高い拡張性と可用性をもつ、分散型のMQTTブローカーです。数千万のクライアントを同時に処理するIoT、M2M、モバイルアプリケーション向けです。 +*EMQX* は、高い拡張性と可用性をもつ、分散型のMQTTブローカーです。数千万のクライアントを同時に処理するIoT、M2M、モバイルアプリケーション向けです。 -version 3.0 以降、*EMQ X* は MQTT V5.0 の仕様を完全にサポートしており、MQTT V3.1およびV3.1.1とも下位互換性があります。 +version 3.0 以降、*EMQX* は MQTT V5.0 の仕様を完全にサポートしており、MQTT V3.1およびV3.1.1とも下位互換性があります。 MQTT-SN、CoAP、LwM2M、WebSocket、STOMPなどの通信プロトコルをサポートしています。 MQTTの同時接続数は1つのクラスター上で1,000万以上にまでスケールできます。 -- 新機能の一覧については、[EMQ Xリリースノート](https://github.com/emqx/emqx/releases)を参照してください。 -- 詳細はこちら[EMQ X公式ウェブサイト](https://www.emqx.io/)をご覧ください。 +- 新機能の一覧については、[EMQXリリースノート](https://github.com/emqx/emqx/releases)を参照してください。 +- 詳細はこちら[EMQX公式ウェブサイト](https://www.emqx.io/)をご覧ください。 ## インストール -*EMQ X* はクロスプラットフォームで、Linux、Unix、macOS、Windowsをサポートしています。 -そのため、x86_64アーキテクチャサーバー、またはRaspberryPiなどのARMデバイスに *EMQ X* をデプロイすることもできます。 +*EMQX* はクロスプラットフォームで、Linux、Unix、macOS、Windowsをサポートしています。 +そのため、x86_64アーキテクチャサーバー、またはRaspberryPiなどのARMデバイスに *EMQX* をデプロイすることもできます。 -Windows上における *EMQ X* のビルドと実行については、[Windows.md](./Windows.md)をご参照ください。 +Windows上における *EMQX* のビルドと実行については、[Windows.md](./Windows.md)をご参照ください。 -#### Docker イメージによる EMQ X のインストール +#### Docker イメージによる EMQX のインストール ``` docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx @@ -35,14 +35,14 @@ docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p #### バイナリパッケージによるインストール -それぞれのOSに対応したバイナリソフトウェアパッケージは、[EMQ Xのダウンロード](https://www.emqx.io/downloads)ページから取得できます。 +それぞれのOSに対応したバイナリソフトウェアパッケージは、[EMQXのダウンロード](https://www.emqx.io/downloads)ページから取得できます。 - [シングルノードインストール](https://docs.emqx.io/broker/latest/en/getting-started/installation.html) - [マルチノードインストール](https://docs.emqx.io/broker/latest/en/advanced/cluster.html) ## ソースからビルド -version 3.0 以降の *EMQ X* をビルドするには Erlang/OTP R21+ が必要です。 +version 3.0 以降の *EMQX* をビルドするには Erlang/OTP R21+ が必要です。 version 4.3 以降の場合： @@ -71,7 +71,7 @@ emqx をソースコードからビルドした場合は、 ./bin/emqx stop ``` -*EMQ X* の起動後、ブラウザで http://localhost:18083 にアクセスするとダッシュボードが表示されます。 +*EMQX* の起動後、ブラウザで http://localhost:18083 にアクセスするとダッシュボードが表示されます。 ## テスト @@ -102,7 +102,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_auth_jwt,emqx_auth_ldap make dialyzer ### FAQ -よくある質問については、[EMQ X FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html)をご確認ください。 +よくある質問については、[EMQX FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html)をご確認ください。 ### 質問する diff --git a/README-RU.md b/README-RU.md index cddaba4a5..d7bbb263e 100644 --- a/README-RU.md +++ b/README-RU.md @@ -1,4 +1,4 @@ -# Брокер EMQ X +# Брокер EMQX [![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen)](https://github.com/emqx/emqx/releases) [![Build Status](https://travis-ci.org/emqx/emqx.svg)](https://travis-ci.org/emqx/emqx) @@ -13,20 +13,20 @@ [English](./README.md) | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | русский -*EMQ X* — это масштабируемый, высоко доступный, распределённый MQTT брокер с полностью открытым кодом для интернета вещей, межмашинного взаимодействия и мобильных приложений, который поддерживает миллионы одновременных подключений. +*EMQX* — это масштабируемый, высоко доступный, распределённый MQTT брокер с полностью открытым кодом для интернета вещей, межмашинного взаимодействия и мобильных приложений, который поддерживает миллионы одновременных подключений. -Начиная с релиза 3.0, брокер *EMQ X* полностью поддерживает протокол MQTT версии 5.0, и обратно совместим с версиями 3.1 и 3.1.1, а также протоколами MQTT-SN, CoAP, LwM2M, WebSocket и STOMP. Начиная с релиза 3.0, брокер *EMQ X* может масштабироваться до более чем 10 миллионов одновременных MQTT соединений на один кластер. +Начиная с релиза 3.0, брокер *EMQX* полностью поддерживает протокол MQTT версии 5.0, и обратно совместим с версиями 3.1 и 3.1.1, а также протоколами MQTT-SN, CoAP, LwM2M, WebSocket и STOMP. Начиная с релиза 3.0, брокер *EMQX* может масштабироваться до более чем 10 миллионов одновременных MQTT соединений на один кластер. -- Полный список возможностей доступен по ссылке: [EMQ X Release Notes](https://github.com/emqx/emqx/releases). -- Более подробная информация доступна на нашем сайте: [EMQ X homepage](https://www.emqx.io). +- Полный список возможностей доступен по ссылке: [EMQX Release Notes](https://github.com/emqx/emqx/releases). +- Более подробная информация доступна на нашем сайте: [EMQX homepage](https://www.emqx.io). ## Установка -Брокер *EMQ X* кросплатформенный, и поддерживает Linux, Unix, macOS и Windows. Он может работать на серверах с архитектурой x86_64 и устройствах на архитектуре ARM, таких как Raspberry Pi. +Брокер *EMQX* кросплатформенный, и поддерживает Linux, Unix, macOS и Windows. Он может работать на серверах с архитектурой x86_64 и устройствах на архитектуре ARM, таких как Raspberry Pi. Более подробная информация о запуске на Windows по ссылке: [Windows.md](./Windows.md) -#### Установка EMQ X с помощью Docker-образа +#### Установка EMQX с помощью Docker-образа ``` docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx @@ -34,7 +34,7 @@ docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p #### Установка бинарного пакета -Сборки для различных операционных систем: [Загрузить EMQ X](https://www.emqx.io/downloads). +Сборки для различных операционных систем: [Загрузить EMQX](https://www.emqx.io/downloads). - [Установка на одном сервере](https://docs.emqx.io/en/broker/latest/getting-started/install.html) - [Установка на кластере](https://docs.emqx.io/en/broker/latest/advanced/cluster.html) @@ -111,7 +111,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_auth_jwt,emqx_auth_ldap make dialyzer ### FAQ -Наиболее частые проблемы разобраны в [EMQ X FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html). +Наиболее частые проблемы разобраны в [EMQX FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html). ### Вопросы diff --git a/README.md b/README.md index 8d8ed8731..32d505b34 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# EMQ X Broker +# EMQX Broker [![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen)](https://github.com/emqx/emqx/releases) [![Build Status](https://travis-ci.org/emqx/emqx.svg)](https://travis-ci.org/emqx/emqx) @@ -12,20 +12,20 @@ English | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | [русский](./README-RU.md) -*EMQ X* broker is a fully open source, highly scalable, highly available distributed MQTT messaging broker for IoT, M2M and Mobile applications that can handle tens of millions of concurrent clients. +*EMQX* broker is a fully open source, highly scalable, highly available distributed MQTT messaging broker for IoT, M2M and Mobile applications that can handle tens of millions of concurrent clients. -Starting from 3.0 release, *EMQ X* broker fully supports MQTT V5.0 protocol specifications and backward compatible with MQTT V3.1 and V3.1.1, as well as other communication protocols such as MQTT-SN, CoAP, LwM2M, WebSocket and STOMP. The 3.0 release of the *EMQ X* broker can scaled to 10+ million concurrent MQTT connections on one cluster. +Starting from 3.0 release, *EMQX* broker fully supports MQTT V5.0 protocol specifications and backward compatible with MQTT V3.1 and V3.1.1, as well as other communication protocols such as MQTT-SN, CoAP, LwM2M, WebSocket and STOMP. The 3.0 release of the *EMQX* broker can scaled to 10+ million concurrent MQTT connections on one cluster. -- For full list of new features, please read [EMQ X Release Notes](https://github.com/emqx/emqx/releases). -- For more information, please visit [EMQ X homepage](https://www.emqx.io). +- For full list of new features, please read [EMQX Release Notes](https://github.com/emqx/emqx/releases). +- For more information, please visit [EMQX homepage](https://www.emqx.io). ## Installation -The *EMQ X* broker is cross-platform, which supports Linux, Unix, macOS and Windows. It means *EMQ X* can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi. +The *EMQX* broker is cross-platform, which supports Linux, Unix, macOS and Windows. It means *EMQX* can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi. -See more details for building and running *EMQ X* on Windows in [Windows.md](./Windows.md) +See more details for building and running *EMQX* on Windows in [Windows.md](./Windows.md) -#### Installing via EMQ X Docker Image +#### Installing via EMQX Docker Image ``` docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx @@ -33,7 +33,7 @@ docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p #### Installing via Binary Package -Get the binary package of the corresponding OS from [EMQ X Download](https://www.emqx.io/downloads) page. +Get the binary package of the corresponding OS from [EMQX Download](https://www.emqx.io/downloads) page. - [Single Node Install](https://docs.emqx.io/en/broker/latest/getting-started/install.html) - [Multi Node Install](https://docs.emqx.io/en/broker/latest/advanced/cluster.html) @@ -41,7 +41,7 @@ Get the binary package of the corresponding OS from [EMQ X Download](https://www ## Build From Source -The *EMQ X* broker requires Erlang/OTP R21+ to build since 3.0 release. +The *EMQX* broker requires Erlang/OTP R21+ to build since 3.0 release. For 4.3 and later versions. @@ -110,7 +110,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_auth_jwt,emqx_auth_ldap make dialyzer ### FAQ -Visiting [EMQ X FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html) to get help of common problems. +Visiting [EMQX FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html) to get help of common problems. ### Questions diff --git a/apps/emqx_auth_http/README.md b/apps/emqx_auth_http/README.md index ed743334a..8d6819a46 100644 --- a/apps/emqx_auth_http/README.md +++ b/apps/emqx_auth_http/README.md @@ -1,7 +1,7 @@ emqx_auth_http ============== -EMQ X HTTP Auth/ACL Plugin +EMQX HTTP Auth/ACL Plugin Build ----- @@ -96,5 +96,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_auth_jwt/README.md b/apps/emqx_auth_jwt/README.md index 9675ae87c..7af41f490 100644 --- a/apps/emqx_auth_jwt/README.md +++ b/apps/emqx_auth_jwt/README.md @@ -1,7 +1,7 @@ # emqx-auth-jwt -EMQ X JWT Authentication Plugin +EMQX JWT Authentication Plugin Build ----- @@ -87,4 +87,4 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_auth_ldap/README.md b/apps/emqx_auth_ldap/README.md index c4d56c839..39b23b72a 100644 --- a/apps/emqx_auth_ldap/README.md +++ b/apps/emqx_auth_ldap/README.md @@ -1,7 +1,7 @@ emqx_auth_ldap ============== -EMQ X LDAP Authentication Plugin +EMQX LDAP Authentication Plugin Build ----- @@ -92,5 +92,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_auth_mongo/README.md b/apps/emqx_auth_mongo/README.md index 3bacfca5b..68db9c4e6 100644 --- a/apps/emqx_auth_mongo/README.md +++ b/apps/emqx_auth_mongo/README.md @@ -1,7 +1,7 @@ emqx_auth_mongo =============== -EMQ X Authentication/ACL with MongoDB +EMQX Authentication/ACL with MongoDB Build the Plugin ---------------- @@ -188,5 +188,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_auth_mysql/README.md b/apps/emqx_auth_mysql/README.md index e55a2103f..cde1f8639 100644 --- a/apps/emqx_auth_mysql/README.md +++ b/apps/emqx_auth_mysql/README.md @@ -164,4 +164,4 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_auth_pgsql/README.md b/apps/emqx_auth_pgsql/README.md index 2dccd6f53..5ef4345d2 100644 --- a/apps/emqx_auth_pgsql/README.md +++ b/apps/emqx_auth_pgsql/README.md @@ -179,5 +179,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_auth_redis/README.md b/apps/emqx_auth_redis/README.md index 9aa851f88..f83787d14 100644 --- a/apps/emqx_auth_redis/README.md +++ b/apps/emqx_auth_redis/README.md @@ -1,7 +1,7 @@ emqx_auth_redis =============== -EMQ X Redis Authentication/ACL Plugin +EMQX Redis Authentication/ACL Plugin Features --------- @@ -167,5 +167,5 @@ Load Plugin Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_bridge_mqtt/README.md b/apps/emqx_bridge_mqtt/README.md index 456fae584..fea8f46b3 100644 --- a/apps/emqx_bridge_mqtt/README.md +++ b/apps/emqx_bridge_mqtt/README.md @@ -1,13 +1,13 @@ # EMQ Bridge MQTT -The concept of **Bridge** means that EMQ X supports forwarding messages +The concept of **Bridge** means that EMQX supports forwarding messages of one of its own topics to another MQTT Broker in some way. **Bridge** differs from **Cluster** in that the bridge does not replicate the topic trie and routing tables and only forwards MQTT messages based on bridging rules. -At present, the bridging methods supported by EMQ X are as follows: +At present, the bridging methods supported by EMQX are as follows: - RPC bridge: RPC Bridge only supports message forwarding and does not support subscribing to the topic of remote nodes to synchronize @@ -19,7 +19,7 @@ These concepts are shown below: ![bridge](docs/images/bridge.png) -In addition, the EMQ X message broker supports multi-node bridge mode interconnection +In addition, the EMQX message broker supports multi-node bridge mode interconnection ``` --------- --------- --------- @@ -27,7 +27,7 @@ Publisher --> | Node1 | --Bridge Forward--> | Node2 | --Bridge Forward--> | Node --------- --------- --------- ``` -In EMQ X, bridge is configured by modifying `etc/emqx.conf`. EMQ X distinguishes between different bridges based on different names. E.g +In EMQX, bridge is configured by modifying `etc/emqx.conf`. EMQX distinguishes between different bridges based on different names. E.g ``` ## Bridge address: node name for local bridge, host:port for remote. @@ -38,7 +38,7 @@ This configuration declares a bridge named `aws` and specifies that it is bridge In case of creating multiple bridges, it is convenient to replicate all configuration items of the first bridge, and modify the bridge name and other configuration items if necessary (such as bridge.$name.address, where $name refers to the name of bridge) -The next two sections describe how to create a bridge in RPC and MQTT mode respectively and create a forwarding rule that forwards the messages from sensors. Assuming that two EMQ X nodes are running on two hosts: +The next two sections describe how to create a bridge in RPC and MQTT mode respectively and create a forwarding rule that forwards the messages from sensors. Assuming that two EMQX nodes are running on two hosts: | Name | Node | MQTT Port | @@ -47,7 +47,7 @@ The next two sections describe how to create a bridge in RPC and MQTT mode respe | emqx2| emqx2@192.168.1.2 | 1883 | -## EMQ X RPC Bridge Configuration +## EMQX RPC Bridge Configuration The following is the basic configuration of RPC bridging. A simplest RPC bridging only requires the following three items @@ -72,13 +72,13 @@ Limitations of RPC bridging: 1. The RPC bridge of emqx can only forward local messages to the remote node, and cannot synchronize the messages of the remote node to the local node; -2. RPC bridge can only bridge two EMQ X broker together and cannot bridge EMQ X broker to other MQTT brokers. +2. RPC bridge can only bridge two EMQX broker together and cannot bridge EMQX broker to other MQTT brokers. -## EMQ X MQTT Bridge Configuration +## EMQX MQTT Bridge Configuration -EMQ X 3.0 officially introduced MQTT bridge, so that EMQ X can bridge any MQTT broker. Because of the characteristics of the MQTT protocol, EMQ X can subscribe to the remote mqtt broker's topic through MQTT bridge, and then synchronize the remote MQTT broker's message to the local. +EMQX 3.0 officially introduced MQTT bridge, so that EMQX can bridge any MQTT broker. Because of the characteristics of the MQTT protocol, EMQX can subscribe to the remote mqtt broker's topic through MQTT bridge, and then synchronize the remote MQTT broker's message to the local. -EMQ X MQTT bridging principle: Create an MQTT client on the EMQ X broker, and connect this MQTT client to the remote MQTT broker. Therefore, in the MQTT bridge configuration, following fields may be set for the EMQ X to connect to the remote broker as an mqtt client +EMQX MQTT bridging principle: Create an MQTT client on the EMQX broker, and connect this MQTT client to the remote MQTT broker. Therefore, in the MQTT bridge configuration, following fields may be set for the EMQX to connect to the remote broker as an mqtt client ``` ## Bridge Address: Use node name for rpc bridging, use host:port for mqtt connection @@ -159,7 +159,7 @@ bridge.mqtt.emqx2.max_inflight_batches = 32 ## Bridge Cache Configuration -The bridge of EMQ X has a message caching mechanism. The caching mechanism is applicable to both RPC bridging and MQTT bridging. When the bridge is disconnected (such as when the network connection is unstable), the messages with a topic specified in `forwards` can be cached to the local message queue. Until the bridge is restored, these messages are re-forwarded to the remote node. The configuration of the cache queue is as follows +The bridge of EMQX has a message caching mechanism. The caching mechanism is applicable to both RPC bridging and MQTT bridging. When the bridge is disconnected (such as when the network connection is unstable), the messages with a topic specified in `forwards` can be cached to the local message queue. Until the bridge is restored, these messages are re-forwarded to the remote node. The configuration of the cache queue is as follows ``` ## emqx_bridge internal number of messages used for batch @@ -179,9 +179,9 @@ bridge.mqtt.emqx2.queue.replayq_seg_bytes = 10MB `bridge.mqtt.emqx2.queue.replayq_seg_bytes` is used to specify the size of the largest single file of the message queue that is cached on disk. If the message queue size exceeds the specified value, a new file is created to store the message queue. -## CLI for EMQ X Bridge MQTT +## CLI for EMQX Bridge MQTT -CLI for EMQ X Bridge MQTT: +CLI for EMQX Bridge MQTT: ``` bash $ cd emqx1/ && ./bin/emqx_ctl bridges diff --git a/apps/emqx_bridge_mqtt/docs/guide.rst b/apps/emqx_bridge_mqtt/docs/guide.rst index 47235aa7d..bb0808367 100644 --- a/apps/emqx_bridge_mqtt/docs/guide.rst +++ b/apps/emqx_bridge_mqtt/docs/guide.rst @@ -2,14 +2,14 @@ EMQ Bridge MQTT =============== -The concept of **Bridge** means that EMQ X supports forwarding messages +The concept of **Bridge** means that EMQX supports forwarding messages of one of its own topics to another MQTT Broker in some way. **Bridge** differs from **Cluster** in that the bridge does not replicate the topic trie and routing tables and only forwards MQTT messages based on bridging rules. -At present, the bridging methods supported by EMQ X are as follows: +At present, the bridging methods supported by EMQX are as follows: * RPC bridge: RPC Bridge only supports message forwarding and does not @@ -26,7 +26,7 @@ These concepts are shown below: :alt: bridge -In addition, the EMQ X message broker supports multi-node bridge mode interconnection +In addition, the EMQX message broker supports multi-node bridge mode interconnection .. code-block:: @@ -34,7 +34,7 @@ In addition, the EMQ X message broker supports multi-node bridge mode interconne Publisher --> | Node1 | --Bridge Forward--> | Node2 | --Bridge Forward--> | Node3 | --> Subscriber --------- --------- --------- -In EMQ X, bridge is configured by modifying ``etc/emqx.conf``. EMQ X distinguishes between different bridges based on different names. E.g +In EMQX, bridge is configured by modifying ``etc/emqx.conf``. EMQX distinguishes between different bridges based on different names. E.g .. code-block:: @@ -45,7 +45,7 @@ This configuration declares a bridge named ``aws`` and specifies that it is brid In case of creating multiple bridges, it is convenient to replicate all configuration items of the first bridge, and modify the bridge name and other configuration items if necessary (such as bridge.$name.address, where $name refers to the name of bridge) -The next two sections describe how to create a bridge in RPC and MQTT mode respectively and create a forwarding rule that forwards the messages from sensors. Assuming that two EMQ X nodes are running on two hosts: +The next two sections describe how to create a bridge in RPC and MQTT mode respectively and create a forwarding rule that forwards the messages from sensors. Assuming that two EMQX nodes are running on two hosts: .. list-table:: :header-rows: 1 @@ -61,7 +61,7 @@ The next two sections describe how to create a bridge in RPC and MQTT mode respe - 1883 -EMQ X RPC Bridge Configuration +EMQX RPC Bridge Configuration ------------------------------ The following is the basic configuration of RPC bridging. A simplest RPC bridging only requires the following three items @@ -90,14 +90,14 @@ Limitations of RPC bridging: The RPC bridge of emqx can only forward local messages to the remote node, and cannot synchronize the messages of the remote node to the local node; #. - RPC bridge can only bridge two EMQ X broker together and cannot bridge EMQ X broker to other MQTT brokers. + RPC bridge can only bridge two EMQX broker together and cannot bridge EMQX broker to other MQTT brokers. -EMQ X MQTT Bridge Configuration +EMQX MQTT Bridge Configuration ------------------------------- -EMQ X 3.0 officially introduced MQTT bridge, so that EMQ X can bridge any MQTT broker. Because of the characteristics of the MQTT protocol, EMQ X can subscribe to the remote mqtt broker's topic through MQTT bridge, and then synchronize the remote MQTT broker's message to the local. +EMQX 3.0 officially introduced MQTT bridge, so that EMQX can bridge any MQTT broker. Because of the characteristics of the MQTT protocol, EMQX can subscribe to the remote mqtt broker's topic through MQTT bridge, and then synchronize the remote MQTT broker's message to the local. -EMQ X MQTT bridging principle: Create an MQTT client on the EMQ X broker, and connect this MQTT client to the remote MQTT broker. Therefore, in the MQTT bridge configuration, following fields may be set for the EMQ X to connect to the remote broker as an mqtt client +EMQX MQTT bridging principle: Create an MQTT client on the EMQX broker, and connect this MQTT client to the remote MQTT broker. Therefore, in the MQTT bridge configuration, following fields may be set for the EMQX to connect to the remote broker as an mqtt client .. code-block:: @@ -179,7 +179,7 @@ EMQ X MQTT bridging principle: Create an MQTT client on the EMQ X broker, and co Bridge Cache Configuration -------------------------- -The bridge of EMQ X has a message caching mechanism. The caching mechanism is applicable to both RPC bridging and MQTT bridging. When the bridge is disconnected (such as when the network connection is unstable), the messages with a topic specified in ``forwards`` can be cached to the local message queue. Until the bridge is restored, these messages are re-forwarded to the remote node. The configuration of the cache queue is as follows +The bridge of EMQX has a message caching mechanism. The caching mechanism is applicable to both RPC bridging and MQTT bridging. When the bridge is disconnected (such as when the network connection is unstable), the messages with a topic specified in ``forwards`` can be cached to the local message queue. Until the bridge is restored, these messages are re-forwarded to the remote node. The configuration of the cache queue is as follows .. code-block:: @@ -199,10 +199,10 @@ The bridge of EMQ X has a message caching mechanism. The caching mechanism is ap ``bridge.mqtt.emqx2.queue.replayq_seg_bytes`` is used to specify the size of the largest single file of the message queue that is cached on disk. If the message queue size exceeds the specified value, a new file is created to store the message queue. -CLI for EMQ X Bridge MQTT +CLI for EMQX Bridge MQTT ------------------------- -CLI for EMQ X Bridge MQTT: +CLI for EMQX Bridge MQTT: .. code-block:: bash diff --git a/apps/emqx_coap/README.md b/apps/emqx_coap/README.md index 1a9ee802c..3e28c2704 100644 --- a/apps/emqx_coap/README.md +++ b/apps/emqx_coap/README.md @@ -1,7 +1,7 @@ # emqx-coap -emqx-coap is a CoAP Gateway for EMQ X Broker. It translates CoAP messages into MQTT messages and make it possible to communiate between CoAP clients and MQTT clients. +emqx-coap is a CoAP Gateway for EMQX Broker. It translates CoAP messages into MQTT messages and make it possible to communiate between CoAP clients and MQTT clients. ### Client Usage Example libcoap is an excellent coap library which has a simple client tool. It is recommended to use libcoap as a coap client. @@ -252,5 +252,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_exhook/README.md b/apps/emqx_exhook/README.md index 216c39275..f43cbb334 100644 --- a/apps/emqx_exhook/README.md +++ b/apps/emqx_exhook/README.md @@ -1,6 +1,6 @@ # emqx_exhook -The `emqx_exhook` extremly enhance the extensibility for EMQ X. It allow using an others programming language to mount the hooks intead of erlang. +The `emqx_exhook` extremly enhance the extensibility for EMQX. It allow using an others programming language to mount the hooks intead of erlang. ## Feature @@ -10,7 +10,7 @@ The `emqx_exhook` extremly enhance the extensibility for EMQ X. It allow using a ## Architecture ``` -EMQ X Third-party Runtime +EMQX Third-party Runtime +========================+ +========+==========+ | ExHook | | | | | +----------------+ | gRPC | gRPC | User's | diff --git a/apps/emqx_exproto/README.md b/apps/emqx_exproto/README.md index a9375e5d3..792822863 100644 --- a/apps/emqx_exproto/README.md +++ b/apps/emqx_exproto/README.md @@ -1,6 +1,6 @@ # emqx-exproto -The `emqx_exproto` extremly enhance the extensibility for EMQ X. It allow using an others programming language to **replace the protocol handling layer in EMQ X Broker**. +The `emqx_exproto` extremly enhance the extensibility for EMQX. It allow using an others programming language to **replace the protocol handling layer in EMQX Broker**. ## Feature @@ -9,7 +9,7 @@ The `emqx_exproto` extremly enhance the extensibility for EMQ X. It allow using ## Architecture -![EMQ X ExProto Arch](./docs/images/exproto-arch.jpg) +![EMQX ExProto Arch](./docs/images/exproto-arch.jpg) ## Usage diff --git a/apps/emqx_lua_hook/README.md b/apps/emqx_lua_hook/README.md index a3f65a094..dc311410c 100644 --- a/apps/emqx_lua_hook/README.md +++ b/apps/emqx_lua_hook/README.md @@ -334,5 +334,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_lwm2m/README.md b/apps/emqx_lwm2m/README.md index f97feb12c..c2fb63c08 100644 --- a/apps/emqx_lwm2m/README.md +++ b/apps/emqx_lwm2m/README.md @@ -1,5 +1,5 @@ -# LwM2M Gateway for the EMQ X Broker. +# LwM2M Gateway for the EMQX Broker. [The LwM2M Specifications](http://www.openmobilealliance.org/release/LightweightM2M) is a Lightweight Machine to Machine protocol. @@ -354,4 +354,4 @@ Apache License Version 2.0 ## Author -EMQ X-Men Team. +EMQX-Men Team. diff --git a/apps/emqx_management/README.md b/apps/emqx_management/README.md index c71a47628..1c23add00 100644 --- a/apps/emqx_management/README.md +++ b/apps/emqx_management/README.md @@ -1,7 +1,7 @@ # emqx-management -EMQ X Management API +EMQX Management API ## How to Design RESTful API? diff --git a/apps/emqx_prometheus/README.md b/apps/emqx_prometheus/README.md index 04bf32cbd..6c4461118 100644 --- a/apps/emqx_prometheus/README.md +++ b/apps/emqx_prometheus/README.md @@ -1,6 +1,6 @@ # emqx-prometheus -EMQ X Prometheus Agent +EMQX Prometheus Agent ## push emqx stats/metrics to prometheus PushGateway @@ -48,7 +48,7 @@ json data ``` -## Before EMQ X v4.0.0 +## Before EMQX v4.0.0 The prometheus data simple is: @@ -279,5 +279,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_recon/README.md b/apps/emqx_recon/README.md index ca163be45..7ba6b283c 100644 --- a/apps/emqx_recon/README.md +++ b/apps/emqx_recon/README.md @@ -2,7 +2,7 @@ emqx-recon ========== -EMQ X Recon Debug/Optimize Plugin +EMQX Recon Debug/Optimize Plugin emqx_recon.conf ----=---------- @@ -57,5 +57,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_retainer/README.md b/apps/emqx_retainer/README.md index 84d777bbc..4e5256107 100644 --- a/apps/emqx_retainer/README.md +++ b/apps/emqx_retainer/README.md @@ -1,5 +1,5 @@ -EMQ X Retainer +EMQX Retainer ============== The retainer plugin is responsible for storing retained MQTT messages. @@ -55,5 +55,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team +EMQX Team diff --git a/apps/emqx_rule_engine/README.md b/apps/emqx_rule_engine/README.md index 0b1ddd848..d9104ffc8 100644 --- a/apps/emqx_rule_engine/README.md +++ b/apps/emqx_rule_engine/README.md @@ -1,7 +1,7 @@ # emqx-rule-engine -IoT Rule Engine for EMQ X Broker. +IoT Rule Engine for EMQX Broker. ## Concept diff --git a/apps/emqx_sn/README.md b/apps/emqx_sn/README.md index d7251c49c..1285463f4 100644 --- a/apps/emqx_sn/README.md +++ b/apps/emqx_sn/README.md @@ -1,7 +1,7 @@ emqx-sn ======= -EMQ X MQTT-SN Gateway. +EMQX MQTT-SN Gateway. Configure Plugin ---------------- @@ -113,5 +113,5 @@ Apache License Version 2.0 Author ------ -EMQ X-Men Team. +EMQX-Men Team. diff --git a/apps/emqx_stomp/README.md b/apps/emqx_stomp/README.md index ec841b1e6..fcade7336 100644 --- a/apps/emqx_stomp/README.md +++ b/apps/emqx_stomp/README.md @@ -2,7 +2,7 @@ emqx-stomp ========== -The plugin adds STOMP 1.0/1.1/1.2 protocol supports to the EMQ X broker. +The plugin adds STOMP 1.0/1.1/1.2 protocol supports to the EMQX broker. The STOMP clients could PubSub to the MQTT clients. @@ -73,5 +73,5 @@ Apache License Version 2.0 Author ------ -EMQ X Team. +EMQX Team. diff --git a/apps/emqx_web_hook/README.md b/apps/emqx_web_hook/README.md index c76c2936d..45a2f139e 100644 --- a/apps/emqx_web_hook/README.md +++ b/apps/emqx_web_hook/README.md @@ -1,9 +1,9 @@ # emqx-web-hook -EMQ X WebHook plugin. +EMQX WebHook plugin. -Please see: [EMQ X - WebHook](https://docs.emqx.io/broker/latest/en/advanced/webhook.html) +Please see: [EMQX - WebHook](https://docs.emqx.io/broker/latest/en/advanced/webhook.html) ## emqx_web_hook.conf diff --git a/deploy/charts/emqx/README.md b/deploy/charts/emqx/README.md index 4837ffced..54d267415 100644 --- a/deploy/charts/emqx/README.md +++ b/deploy/charts/emqx/README.md @@ -1,5 +1,5 @@ # Introduction -This chart bootstraps an [EMQ X](https://www.emqx.io/) deployment on a [Kubernetes](https://kubernetes.io/) (K8s) cluster using the [Helm](https://helm.sh/) package manager. +This chart bootstraps an [EMQX](https://www.emqx.io/) deployment on a [Kubernetes](https://kubernetes.io/) (K8s) cluster using the [Helm](https://helm.sh/) package manager. # Prerequisites + [Kubernetes](https://kubernetes.io/) 1.6+ @@ -31,21 +31,21 @@ $ helm del my-emqx # Configuration The following sections describe the configurable parameters of the chart and their default values. ## [K8s]((https://kubernetes.io/)) specific settings -The following table lists the configurable K8s parameters of the [EMQ X](https://www.emqx.io/) chart and their default values. +The following table lists the configurable K8s parameters of the [EMQX](https://www.emqx.io/) chart and their default values. Parameter | Description | Default Value --- | --- | --- `replicaCount` | It is recommended to have odd number of nodes in a cluster, otherwise the emqx cluster cannot be automatically healed in case of net-split. | `3` -`image.tag` | EMQ X Image tag (defaults to `.Chart.AppVersion`) | `nil` -`image.repository` | EMQ X Image repository | `emqx/emqx` +`image.tag` | EMQX Image tag (defaults to `.Chart.AppVersion`) | `nil` +`image.repository` | EMQX Image repository | `emqx/emqx` `image.pullPolicy` | The image pull policy | `IfNotPresent` `image.pullSecrets ` | The image pull secrets (does not add image pull secrets to deployed pods) |``[]`` `recreatePods` | Forces the recreation of pods during upgrades, which can be useful to always apply the most recent configuration. | `false` -`persistence.enabled` | Enable EMQ X persistence using PVC | `false` +`persistence.enabled` | Enable EMQX persistence using PVC | `false` `persistence.storageClass` | Storage class of backing PVC (uses alpha storage class annotation) | `nil` -`persistence.existingClaim` | EMQ X data Persistent Volume existing claim name, evaluated as a template | `""` -`persistence.accessMode` | PVC Access Mode for EMQ X volume | `ReadWriteOnce` -`persistence.size` | PVC Storage Request for EMQ X volume | `20Mi` -`initContainers` | Containers that run before the creation of EMQ X containers. They can contain utilities or setup scripts. |`{}` +`persistence.existingClaim` | EMQX data Persistent Volume existing claim name, evaluated as a template | `""` +`persistence.accessMode` | PVC Access Mode for EMQX volume | `ReadWriteOnce` +`persistence.size` | PVC Storage Request for EMQX volume | `20Mi` +`initContainers` | Containers that run before the creation of EMQX containers. They can contain utilities or setup scripts. |`{}` `resources` | CPU/Memory resource requests/limits |`{}` `nodeSelector` | Node labels for pod assignment |`{}` `tolerations` | Toleration labels for pod assignment |``[]`` @@ -67,32 +67,32 @@ Parameter | Description | Default Value `service.loadBalancerSourceRanges` | Address(es) that are allowed when service is LoadBalancer | `[]` `service.externalIPs` | ExternalIPs for the service | `[]` `service.annotations` | Service annotations (evaluated as a template) | `{}` -`ingress.dashboard.enabled` | Enable ingress for EMQ X Dashboard | false -`ingress.dashboard.ingressClassName` | Set the ingress class for EMQ X Dashboard -`ingress.dashboard.path` | Ingress path for EMQ X Dashboard | `/` -`ingress.dashboard.hosts` | Ingress hosts for EMQ X Mgmt API | dashboard.emqx.local -`ingress.dashboard.tls` | Ingress tls for EMQ X Mgmt API | `[]` -`ingress.dashboard.annotations` | Ingress annotations for EMQ X Mgmt API | `{}` -`ingress.mgmt.enabled` | Enable ingress for EMQ X Mgmt API | `false` -`ingress.mqtt.ingressClassName` | Set the ingress class for EMQ X Mgmt API | `nil` -`ingress.mgmt.path` | Ingress path for EMQ X Mgmt API | `/` -`ingress.mgmt.hosts` | Ingress hosts for EMQ X Mgmt API | `api.emqx.local` -`ingress.mgmt.tls` | Ingress tls for EMQ X Mgmt API | `[]` -`ingress.mgmt.annotations` | Ingress annotations for EMQ X Mgmt API | `{}` -`ingress.wss.enabled` | Enable ingress for EMQ X Mgmt API | `false` -`ingress.wss.ingressClassName` | Set the ingress class for EMQ X Mgmt API | `nil` -`ingress.wss.path` | Ingress path for EMQ X WSS | `/` -`ingress.wss.hosts` | Ingress hosts for EMQ X WSS | `wss.emqx.local` -`ingress.wss.tls` | Ingress tls for EMQ X WSS | `[]` -`ingress.wss.annotations` | Ingress annotations for EMQ X WSS | `{}` +`ingress.dashboard.enabled` | Enable ingress for EMQX Dashboard | false +`ingress.dashboard.ingressClassName` | Set the ingress class for EMQX Dashboard +`ingress.dashboard.path` | Ingress path for EMQX Dashboard | `/` +`ingress.dashboard.hosts` | Ingress hosts for EMQX Mgmt API | dashboard.emqx.local +`ingress.dashboard.tls` | Ingress tls for EMQX Mgmt API | `[]` +`ingress.dashboard.annotations` | Ingress annotations for EMQX Mgmt API | `{}` +`ingress.mgmt.enabled` | Enable ingress for EMQX Mgmt API | `false` +`ingress.mqtt.ingressClassName` | Set the ingress class for EMQX Mgmt API | `nil` +`ingress.mgmt.path` | Ingress path for EMQX Mgmt API | `/` +`ingress.mgmt.hosts` | Ingress hosts for EMQX Mgmt API | `api.emqx.local` +`ingress.mgmt.tls` | Ingress tls for EMQX Mgmt API | `[]` +`ingress.mgmt.annotations` | Ingress annotations for EMQX Mgmt API | `{}` +`ingress.wss.enabled` | Enable ingress for EMQX Mgmt API | `false` +`ingress.wss.ingressClassName` | Set the ingress class for EMQX Mgmt API | `nil` +`ingress.wss.path` | Ingress path for EMQX WSS | `/` +`ingress.wss.hosts` | Ingress hosts for EMQX WSS | `wss.emqx.local` +`ingress.wss.tls` | Ingress tls for EMQX WSS | `[]` +`ingress.wss.annotations` | Ingress annotations for EMQX WSS | `{}` `extraEnv` | Aditional container env vars | `[]` `extraEnvFrom` | Aditional container env from vars (eg. [config map](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/), [secrets](https://kubernetes.io/docs/concepts/configuration/secret/) | `[]` `extraArgs` | Additional container executable arguments | `[]` `extraVolumes` | Additional container volumes (eg. for mounting certs from secrets) | `[]` `extraVolumeMounts` | Additional container volume mounts (eg. for mounting certs from secrets) | `[]` -## EMQ X specific settings -The following table lists the configurable [EMQ X](https://www.emqx.io/)-specific parameters of the chart and their default values. +## EMQX specific settings +The following table lists the configurable [EMQX](https://www.emqx.io/)-specific parameters of the chart and their default values. Parameter | Description | Default Value --- | --- | --- `emqxConfig` | Map of [configuration](https://www.emqx.io/docs/en/latest/configuration/configuration.html) items expressed as [environment variables](https://www.emqx.io/docs/en/v4.3/configuration/environment-variable.html) (prefix can be omitted) or using the configuration files [namespaced dotted notation](https://www.emqx.io/docs/en/latest/configuration/configuration.html) | `nil` @@ -104,7 +104,7 @@ Parameter | Description | Default Value # Examples This section provides some examples for the configuration of common scenarios. ## Enable Websockets SSL via [nginx-ingress community controller](https://kubernetes.github.io/ingress-nginx/) -The following settings describe a working scenario for acessing [EMQ X](https://www.emqx.io/) Websockets with SSL termination at the [nginx-ingress community controller](https://kubernetes.github.io/ingress-nginx/). +The following settings describe a working scenario for acessing [EMQX](https://www.emqx.io/) Websockets with SSL termination at the [nginx-ingress community controller](https://kubernetes.github.io/ingress-nginx/). ```yaml ingress: wss: diff --git a/deploy/docker/README.md b/deploy/docker/README.md index 51692bc07..35eb68e82 100644 --- a/deploy/docker/README.md +++ b/deploy/docker/README.md @@ -17,11 +17,11 @@ [the latest release](https://github.com/docker/docker-ce/releases/latest) -# What is EMQ X +# What is EMQX -[EMQ X MQTT broker](https://emqx.io/products/broker) is a fully open source, highly scalable, highly available distributed MQTT messaging broker for IoT, M2M and Mobile applications that can handle tens of millions of concurrent clients. +[EMQX MQTT broker](https://emqx.io/products/broker) is a fully open source, highly scalable, highly available distributed MQTT messaging broker for IoT, M2M and Mobile applications that can handle tens of millions of concurrent clients. -Starting from 3.0 release, *EMQ X* broker fully supports MQTT V5.0 protocol specifications and backward compatible with MQTT V3.1 and V3.1.1, as well as other communication protocols such as MQTT-SN, CoAP, LwM2M, WebSocket and STOMP. The 3.0 release of the *EMQ X* broker can scaled to 10+ million concurrent MQTT connections on one cluster. +Starting from 3.0 release, *EMQX* broker fully supports MQTT V5.0 protocol specifications and backward compatible with MQTT V3.1 and V3.1.1, as well as other communication protocols such as MQTT-SN, CoAP, LwM2M, WebSocket and STOMP. The 3.0 release of the *EMQX* broker can scaled to 10+ million concurrent MQTT connections on one cluster. # How to use this image @@ -39,7 +39,7 @@ The emqx broker runs as linux user `emqx` in the docker container. ### Configuration -Use the environment variable to configure the EMQ X docker container. +Use the environment variable to configure the EMQX docker container. By default, the environment variables with ``EMQX_`` prefix are mapped to key-value pairs in configuration files. @@ -72,9 +72,9 @@ EMQX_HOST These environment variables will ignore for configuration file. -#### EMQ X Configuration +#### EMQX Configuration -> NOTE: All EMQ X Configuration in [etc/emqx.conf](https://github.com/emqx/emqx/blob/main-v4.3/etc/emqx.conf) could config by environment. The following list is just an example, not a complete configuration. +> NOTE: All EMQX Configuration in [etc/emqx.conf](https://github.com/emqx/emqx/blob/main-v4.3/etc/emqx.conf) could config by environment. The following list is just an example, not a complete configuration. | Options | Default | Mapped | Description | | ---------------------------| ------------------ | ------------------------- | ------------------------------------- | @@ -148,7 +148,7 @@ EMQX_LOADED_PLUGINS="emqx_auth_redis emqx_auth_mysql" EMQX_LOADED_PLUGINS="emqx_auth_redis | emqx_auth_mysql" ``` -#### EMQ X Plugins Configuration +#### EMQX Plugins Configuration The environment variables which with ``EMQX_`` prefix are mapped to all emqx plugins' configuration file, ``.`` get replaced by ``__``. @@ -200,7 +200,7 @@ docker run -d --name emqx -p 18083:18083 -p 1883:1883 -p 4369:4369 \ ### Cluster -EMQ X supports a variety of clustering methods, see our [documentation](https://docs.emqx.io/broker/latest/en/advanced/cluster.html#emqx-service-discovery) for details. +EMQX supports a variety of clustering methods, see our [documentation](https://docs.emqx.io/broker/latest/en/advanced/cluster.html#emqx-service-discovery) for details. Let's create a static node list cluster from docker-compose. @@ -256,7 +256,7 @@ Let's create a static node list cluster from docker-compose. ### Persistence -If you want to persist the EMQ X docker container, you need to keep the following directories: +If you want to persist the EMQX docker container, you need to keep the following directories: + `/opt/emqx/data` + `/opt/emqx/etc` @@ -316,7 +316,7 @@ docker run -d --name emqx -p 18083:18083 -p 1883:1883 -p 4369:4369 \ ``` -> REMEMBER: DO NOT RUN EMQ X DOCKER PRIVILEGED OR MOUNT SYSTEM PROC IN CONTAINER TO TUNE LINUX KERNEL, IT IS UNSAFE. +> REMEMBER: DO NOT RUN EMQX DOCKER PRIVILEGED OR MOUNT SYSTEM PROC IN CONTAINER TO TUNE LINUX KERNEL, IT IS UNSAFE. ### Thanks diff --git a/lib-ce/emqx_dashboard/README.md b/lib-ce/emqx_dashboard/README.md index e9e50a7c9..16d279602 100644 --- a/lib-ce/emqx_dashboard/README.md +++ b/lib-ce/emqx_dashboard/README.md @@ -2,7 +2,7 @@ emqx-dashboard ============== -Dashboard for the EMQ X Broker. +Dashboard for the EMQX Broker. REST API -------- diff --git a/lib-extra/README.md b/lib-extra/README.md index 4127b53bc..56a60cffb 100644 --- a/lib-extra/README.md +++ b/lib-extra/README.md @@ -1,4 +1,4 @@ -# EMQ X Extra plugin apps +# EMQX Extra plugin apps This directory keeps a `plugins` file which defines all the approved external plugins from open-source community. @@ -20,7 +20,7 @@ e.g. For an Erlang plugin named `plugin_foo`: ``` Note: The `-emqx_plugin(?MODULE)` attribute should be added to -`_app.erl` file to indicate that this is an EMQ X Broker plugin. +`_app.erl` file to indicate that this is an EMQX Broker plugin. For example: ```erlang From a5f6e944671172aac2843fe4b45e2a9e9178cb97 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 15 Feb 2022 22:12:46 +0100 Subject: [PATCH 15/31] docs: EMQ X -> EMQX --- CHANGES-4.3.md | 10 +++++----- Windows.md | 16 ++++++++-------- apps/emqx_exhook/docs/design-cn.md | 4 ++-- apps/emqx_exproto/docs/design-cn.md | 8 ++++---- apps/emqx_rule_engine/docs/design.md | 6 +++--- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/CHANGES-4.3.md b/CHANGES-4.3.md index 983180251..ed3050058 100644 --- a/CHANGES-4.3.md +++ b/CHANGES-4.3.md @@ -1,6 +1,6 @@ -# EMQ X 4.3 Changes +# EMQX 4.3 Changes -Started tracking changes in CHANGE.md since EMQ X v4.3.11 +Started tracking changes in CHANGE.md since EMQX v4.3.11 NOTE: Keep prepending to the head of the file instead of the tail @@ -53,9 +53,9 @@ Important notes: ### Important changes -* Debian/Ubuntu package (deb) installed EMQ X now runs on systemd [#6389]
+* Debian/Ubuntu package (deb) installed EMQX now runs on systemd [#6389]
This is to take advantage of systemd's supervision functionality to ensure - EMQ X service is restarted after crashes. + EMQX service is restarted after crashes. ### Minor changes @@ -71,7 +71,7 @@ Important notes: * Fix session takeover race condition which may lead to message loss [#6396] -* EMQ X docker images are pushed to aws public ecr in an automated CI job [#6271]
+* EMQX docker images are pushed to aws public ecr in an automated CI job [#6271]
`docker pull public.ecr.aws/emqx/emqx:4.3.10` * Fix webhook URL path to allow rule-engine variable substitution [#6399] diff --git a/Windows.md b/Windows.md index f02b40920..6b6eff60a 100644 --- a/Windows.md +++ b/Windows.md @@ -1,4 +1,4 @@ -# Build and run EMQ X on Windows +# Build and run EMQX on Windows NOTE: The instructions and examples are based on Windows 10. @@ -6,7 +6,7 @@ NOTE: The instructions and examples are based on Windows 10. ### Visual studio for C/C++ compile and link -EMQ X includes Erlang NIF (Native Implmented Function) components, implemented +EMQX includes Erlang NIF (Native Implmented Function) components, implemented in C/C++. To compile and link C/C++ libraries, the easiest way is perhaps to install Visual Studio. @@ -51,7 +51,7 @@ Eshell V11.1.4 (abort with ^G) ### bash -All EMQ X build/run scripts are either in `bash` or `escript`. +All EMQX build/run scripts are either in `bash` or `escript`. `escript` is installed as a part of Erlang. To install a `bash` environment in Windows, there are quite a few options. @@ -68,7 +68,7 @@ Cygwin is what we tested with. ### Other tools -Some of the unix world tools are required to build EMQ X. Including: +Some of the unix world tools are required to build EMQX. Including: * git * curl @@ -84,7 +84,7 @@ When using scoop: scoop install git curl make jq zip unzip ``` -## Build EMQ X source code +## Build EMQX source code * Clone the repo: `git clone https://github.com/emqx/emqx.git` @@ -112,11 +112,11 @@ scoop install git curl make jq zip unzip To fix it, Visual Studio's bin paths should be ordered prior to Cygwin's (or similar installation's) bin paths in `Path` environment variable. -## Run EMQ X +## Run EMQX -To start EMQ X broker. +To start EMQX broker. -Execute `_build\emqx\rel\emqx>.\bin\emqx console` or `_build\emqx\rel\emqx>.\bin\emqx start` to start EMQ X. +Execute `_build\emqx\rel\emqx>.\bin\emqx console` or `_build\emqx\rel\emqx>.\bin\emqx start` to start EMQX. Then execute `_build\emqx\rel\emqx>.\bin\emqx_ctl status` to check status. If everything works fine, it should print out diff --git a/apps/emqx_exhook/docs/design-cn.md b/apps/emqx_exhook/docs/design-cn.md index 6686e96e3..21ee333eb 100644 --- a/apps/emqx_exhook/docs/design-cn.md +++ b/apps/emqx_exhook/docs/design-cn.md @@ -2,7 +2,7 @@ ## 动机 -在 EMQ X Broker v4.1-v4.2 中，我们发布了 2 个插件来扩展 emqx 的编程能力： +在 EMQX Broker v4.1-v4.2 中，我们发布了 2 个插件来扩展 emqx 的编程能力： 1. `emqx-extension-hook` 提供了使用 Java, Python 向 Broker 挂载钩子的功能 2. `emqx-exproto` 提供了使用 Java，Python 编写用户自定义协议接入插件的功能 @@ -26,7 +26,7 @@ 架构如下： ``` - EMQ X + EMQX +========================+ +========+==========+ | ExHook | | | | | +----------------+ | gRPC | gRPC | User's | diff --git a/apps/emqx_exproto/docs/design-cn.md b/apps/emqx_exproto/docs/design-cn.md index 7af7dbdb3..1e1ba9e31 100644 --- a/apps/emqx_exproto/docs/design-cn.md +++ b/apps/emqx_exproto/docs/design-cn.md @@ -2,7 +2,7 @@ `emqx-exproto` 插件用于协议解析的多语言支持。它能够允许其他编程语言（例如：Python，Java 等）直接处理数据流实现协议的解析，并提供 Pub/Sub 接口以实现与系统其它组件的通信。 -该插件给 EMQ X 带来的扩展性十分的强大，它能以你熟悉语言处理任何的私有协议，并享受由 EMQ X 系统带来的高连接，和高并发的优点。 +该插件给 EMQX 带来的扩展性十分的强大，它能以你熟悉语言处理任何的私有协议，并享受由 EMQX 系统带来的高连接，和高并发的优点。 ## 特性 @@ -25,12 +25,12 @@ - 提供 `Send` 接口。供外部模块调用，**用于发送数据包**。 - 提供 `Close` 接口。供外部模块调用，**用于主动关闭连接**。 -2. **协议/会话层：**该部分主要**提供 PUB/SUB 接口**，以实现与 EMQ X Broker 系统的消息互通。包括： +2. **协议/会话层：**该部分主要**提供 PUB/SUB 接口**，以实现与 EMQX Broker 系统的消息互通。包括： - 提供 `Authenticate` 接口。供外部模块调用，用于向集群注册客户端。 - 提供 `StartTimer` 接口。供外部模块调用，用于为该连接进程启动心跳等定时器。 - - 提供 `Publish` 接口。供外部模块调用，用于发布消息 EMQ X Broker 中。 - - 提供 `Subscribe` 接口。供外部模块调用，用于订阅某主题，以实现从 EMQ X Broker 中接收某些下行消息。 + - 提供 `Publish` 接口。供外部模块调用，用于发布消息 EMQX Broker 中。 + - 提供 `Subscribe` 接口。供外部模块调用，用于订阅某主题，以实现从 EMQX Broker 中接收某些下行消息。 - 提供 `Unsubscribe` 接口。供外部模块调用，用于取消订阅某主题。 - 调用 `OnTimerTimeout` 回调。用于处理定时器超时的事件。 - 调用 `OnReceivedMessages` 回调。用于接收下行消息（在订阅主题成功后，如果主题上有消息，便会回调该方法） diff --git a/apps/emqx_rule_engine/docs/design.md b/apps/emqx_rule_engine/docs/design.md index 3e2c60c41..f8cac0127 100644 --- a/apps/emqx_rule_engine/docs/design.md +++ b/apps/emqx_rule_engine/docs/design.md @@ -1,7 +1,7 @@ -# EMQ X Rule Engine +# EMQX Rule Engine -This is the design guide of message routing rule engine for the EMQ X Broker. +This is the design guide of message routing rule engine for the EMQX Broker. ## Concept @@ -149,7 +149,7 @@ The properties and behaviors of resources is defined by resource types. A resour ### Resource Type Provider -Provider of resource type is a EMQ X Plugin. +Provider of resource type is a EMQX Plugin. ### Resource Manager From d2840a8aa1170364a89cbd158f7e5946a3254563 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 15 Feb 2022 22:18:25 +0100 Subject: [PATCH 16/31] docs: change EMQ X to EMQX in more descriptive info --- NOTICE | 2 +- bin/emqx | 2 +- bin/node_dump | 2 +- deploy/charts/emqx/Chart.yaml | 2 +- deploy/charts/emqx/values.yaml | 12 ++++++------ deploy/docker/Dockerfile | 2 +- deploy/docker/docker-entrypoint.sh | 2 +- etc/emqx_cloud/vm.args | 2 +- etc/emqx_edge/vm.args | 2 +- scripts/relup-base-vsns.sh | 2 +- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/NOTICE b/NOTICE index e891b5745..2f70ed114 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -EMQ X, a highly scalable, highly available distributed MQTT messaging broker for IoT. +EMQX, a highly scalable, highly available distributed MQTT messaging broker for IoT. Copyright (c) 2017-2021 EMQ Technologies Co., Ltd. All Rights Reserved. This product contains code developed at EMQ Technologies Co., Ltd. diff --git a/bin/emqx b/bin/emqx index 40cb7701d..a2a488474 100755 --- a/bin/emqx +++ b/bin/emqx @@ -44,7 +44,7 @@ if ! check_eralng_start >/dev/null 2>&1; then echoerr "FATAL: Unable to start Erlang." echoerr "Please make sure openssl-1.1.1 (libcrypto) and libncurses are installed." echoerr "Also ensure it's running on the correct platform," - echoerr "this EMQ X release is built for $BUILT_ON" + echoerr "this EMQX release is built for $BUILT_ON" exit 1 fi echoerr "WARNING: There seem to be missing dynamic libs from the OS. Using libs from ${DYNLIBS_DIR}" diff --git a/bin/node_dump b/bin/node_dump index c8f76841b..83b41332b 100755 --- a/bin/node_dump +++ b/bin/node_dump @@ -24,7 +24,7 @@ collect() { } show_help() { - echo "Collect information about the EMQ X node + echo "Collect information about the EMQX node USAGE: diff --git a/deploy/charts/emqx/Chart.yaml b/deploy/charts/emqx/Chart.yaml index 0bafd6780..3f24cc699 100644 --- a/deploy/charts/emqx/Chart.yaml +++ b/deploy/charts/emqx/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: emqx -description: A Helm chart for EMQ X +description: A Helm chart for EMQX # A chart can be either an 'application' or a 'library' chart. # # Application charts are a collection of templates that can be packaged into versioned archives diff --git a/deploy/charts/emqx/values.yaml b/deploy/charts/emqx/values.yaml index f630f3d25..d78f19a8e 100644 --- a/deploy/charts/emqx/values.yaml +++ b/deploy/charts/emqx/values.yaml @@ -62,13 +62,13 @@ resources: {} # cpu: 500m # memory: 512Mi -# Containers that run before the creation of EMQ X containers. They can contain utilities or setup scripts. +# Containers that run before the creation of EMQX containers. They can contain utilities or setup scripts. initContainers: {} # - name: mysql-probe # image: alpine # command: ["sh", "-c", "for i in $(seq 1 300); do nc -zvw1 mysql 3306 && exit 0 || sleep 3; done; exit 1"] -## EMQ X configuration item, see the documentation (https://hub.docker.com/r/emqx/emqx) +## EMQX configuration item, see the documentation (https://hub.docker.com/r/emqx/emqx) emqxConfig: EMQX_CLUSTER__K8S__APISERVER: "https://kubernetes.default.svc:443" ## The address type is used to extract host from k8s service. @@ -119,7 +119,7 @@ emqxLoadedModules: > {emqx_mod_subscription, false}. {emqx_mod_topic_metrics, false}. -## EMQ X Enterprise Edition requires manual creation of a Secret containing the licensed content. Write the name of Secret to the value of "emqxLicenseSecretName" +## EMQX Enterprise Edition requires manual creation of a Secret containing the licensed content. Write the name of Secret to the value of "emqxLicenseSecretName" ## Example: ## kubectl create secret generic emqx-license-secret-name --from-file=/path/to/emqx.lic emqxLicenseSecretName: @@ -188,7 +188,7 @@ ingress: ## Ingress shared annotations annotations: {} - ## ingress for EMQ X Dashboard + ## ingress for EMQX Dashboard dashboard: enabled: false annotations: {} @@ -199,7 +199,7 @@ ingress: - dashboard.emqx.local tls: [] - ## ingress for EMQ X Mgmt API + ## ingress for EMQX Mgmt API mgmt: enabled: false annotations: {} @@ -210,7 +210,7 @@ ingress: - api.emqx.local tls: [] - ## ingress for EMQ X Mgmt API + ## ingress for EMQX Mgmt API wss: enabled: false # ingressClassName: nginx diff --git a/deploy/docker/Dockerfile b/deploy/docker/Dockerfile index c79508ec1..8e6e7c84a 100644 --- a/deploy/docker/Dockerfile +++ b/deploy/docker/Dockerfile @@ -38,7 +38,7 @@ LABEL org.label-schema.docker.dockerfile="Dockerfile" \ org.label-schema.url="https://emqx.io" \ org.label-schema.vcs-type="Git" \ org.label-schema.vcs-url="https://github.com/emqx/emqx" \ - maintainer="EMQ X Team " + maintainer="EMQX Team " ARG EMQX_NAME=emqx diff --git a/deploy/docker/docker-entrypoint.sh b/deploy/docker/docker-entrypoint.sh index 0776f957b..9c7fab4dc 100755 --- a/deploy/docker/docker-entrypoint.sh +++ b/deploy/docker/docker-entrypoint.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash ## EMQ docker image start script # Huang Rui -# EMQ X Team +# EMQX Team ## Shell setting if [[ -n "$DEBUG" ]]; then diff --git a/etc/emqx_cloud/vm.args b/etc/emqx_cloud/vm.args index 1e6b0b4cb..a199091c7 100644 --- a/etc/emqx_cloud/vm.args +++ b/etc/emqx_cloud/vm.args @@ -1,5 +1,5 @@ ###################################################################### -## Erlang VM Args for EMQ X Broker +## Erlang VM Args ###################################################################### ## NOTE: diff --git a/etc/emqx_edge/vm.args b/etc/emqx_edge/vm.args index ef9749738..2f61faa2d 100644 --- a/etc/emqx_edge/vm.args +++ b/etc/emqx_edge/vm.args @@ -1,5 +1,5 @@ ###################################################################### -## Erlang VM Args for EMQ X Edge +## Erlang VM Args ###################################################################### ## NOTE: diff --git a/scripts/relup-base-vsns.sh b/scripts/relup-base-vsns.sh index 65d755994..0a52a1b61 100755 --- a/scripts/relup-base-vsns.sh +++ b/scripts/relup-base-vsns.sh @@ -2,7 +2,7 @@ set -euo pipefail ## This script prints the relup upgrade base versions -## for the given EMQ X edition (specified as first arg) +## for the given EMQX edition (specified as first arg) ## ## The second argument is the current release version ## if not provided, it's taken from pkg-vsn.sh From 2acdc64b9d1b802a9caf5cd80f216956b0dbfd1a Mon Sep 17 00:00:00 2001 From: zhanghongtong Date: Wed, 16 Feb 2022 14:52:31 +0800 Subject: [PATCH 17/31] style(script): rename variable name --- scripts/relup-base-packages.sh | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/relup-base-packages.sh b/scripts/relup-base-packages.sh index 90aefe04f..2999b8e0d 100755 --- a/scripts/relup-base-packages.sh +++ b/scripts/relup-base-packages.sh @@ -11,13 +11,13 @@ fi case $PROFILE in "emqx") - BROKER="broker" + DIR="broker" ;; "emqx-ee") - BROKER="enterprise" + DIR="enterprise" ;; "emqx-edge") - BROKER="edge" + DIR="edge" ;; esac @@ -49,10 +49,10 @@ pushd _upgrade_base for tag in $(../scripts/relup-base-vsns.sh community | xargs echo -n); do if [ ! -f "$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" ] \ - && [ ! -z "$(echo $(curl -I -m 10 -o /dev/null -s -w %{http_code} https://www.emqx.com/downloads/$BROKER/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip) | grep -oE "^[23]+")" ];then - wget --no-verbose https://www.emqx.com/downloads/$BROKER/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip + && [ ! -z "$(echo $(curl -I -m 10 -o /dev/null -s -w %{http_code} https://www.emqx.com/downloads/$DIR/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip) | grep -oE "^[23]+")" ];then + wget --no-verbose https://www.emqx.com/downloads/$DIR/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip if [ "$SYSTEM" != "centos6" ]; then - wget --no-verbose https://www.emqx.com/downloads/$BROKER/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256 + wget --no-verbose https://www.emqx.com/downloads/$DIR/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256 ## https://askubuntu.com/questions/1202208/checking-sha256-checksum echo "$(cat $PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256) $PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" | $SHASUM -c || exit 1 fi From f7135433be1f53e57ce276c04204c93820c2a378 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Wed, 16 Feb 2022 14:10:43 +0100 Subject: [PATCH 18/31] chore(relup-base-vsns.sh): rename PROFILE to EDITION to avoid confusion with rebar profile --- scripts/relup-base-vsns.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/relup-base-vsns.sh b/scripts/relup-base-vsns.sh index 3a2062387..8f391b01b 100755 --- a/scripts/relup-base-vsns.sh +++ b/scripts/relup-base-vsns.sh @@ -20,8 +20,8 @@ parse_semver() { echo "$1" | tr '.|-' ' ' } -PROFILE="${1:-}" -[ -z "${PROFILE}" ] && usage +EDITION="${1:-}" +[ -z "${EDITION}" ] && usage ## Get the current release version ## e.g. @@ -49,7 +49,7 @@ else IS_RELEASE=false fi -case "${PROFILE}" in +case "${EDITION}" in *enterprise*) GIT_TAG_PREFIX="e" ;; From 538f843f149bd8c6ad26cb1f99f4fe3a6ec4be8d Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Wed, 16 Feb 2022 14:13:57 +0100 Subject: [PATCH 19/31] fix(relup-base-packages.sh): download per release edition --- scripts/relup-base-packages.sh | 34 +++++++++++++++++++++------------- scripts/shellcheck.sh | 6 +++++- 2 files changed, 26 insertions(+), 14 deletions(-) diff --git a/scripts/relup-base-packages.sh b/scripts/relup-base-packages.sh index 2999b8e0d..17f0d6ab4 100755 --- a/scripts/relup-base-packages.sh +++ b/scripts/relup-base-packages.sh @@ -1,4 +1,7 @@ #!/usr/bin/env bash + +## This script helps to download relup base version packages + if [[ -n "$DEBUG" ]]; then set -x fi @@ -6,24 +9,27 @@ set -euo pipefail PROFILE="${1}" if [ "$PROFILE" = "" ]; then - $PROFILE="emqx" + PROFILE="emqx" fi case $PROFILE in "emqx") - DIR="broker" + DIR='broker' + EDITION='community' ;; "emqx-ee") - DIR="enterprise" + DIR='enterprise' + EDITION='enterprise' ;; "emqx-edge") - DIR="edge" + DIR='edge' + EDITION='edge' ;; esac -SYSTEM="$(./scripts/get-distro.sh)" +SYSTEM="${SYSTEM:-$(./scripts/get-distro.sh)}" -ARCH="$(uname -m)" +ARCH="${ARCH:-$(uname -m)}" case "$ARCH" in x86_64) ARCH='amd64' @@ -47,16 +53,18 @@ cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")/.." mkdir -p _upgrade_base pushd _upgrade_base -for tag in $(../scripts/relup-base-vsns.sh community | xargs echo -n); do - if [ ! -f "$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" ] \ - && [ ! -z "$(echo $(curl -I -m 10 -o /dev/null -s -w %{http_code} https://www.emqx.com/downloads/$DIR/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip) | grep -oE "^[23]+")" ];then - wget --no-verbose https://www.emqx.com/downloads/$DIR/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip +for tag in $(../scripts/relup-base-vsns.sh $EDITION | xargs echo -n); do + filename="$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" + url="https://www.emqx.com/downloads/$DIR/$tag/$filename" + echo "downloading ${filename} ..." + if [ ! -f "$filename" ] && curl -I -m 10 -o /dev/null -s -w "%{http_code}" "${url}" | grep -q -oE "^[23]+" ; then + curl -L -o "${filename}" "${url}" if [ "$SYSTEM" != "centos6" ]; then - wget --no-verbose https://www.emqx.com/downloads/$DIR/$tag/$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256 + curl -L -o "${filename}.sha256" "${url}.sha256" ## https://askubuntu.com/questions/1202208/checking-sha256-checksum - echo "$(cat $PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip.sha256) $PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" | $SHASUM -c || exit 1 + echo "$(cat "${filename}.sha256") ${filename}" | $SHASUM -c || exit 1 fi fi -done +done popd diff --git a/scripts/shellcheck.sh b/scripts/shellcheck.sh index 5f8cdfd51..97445829f 100755 --- a/scripts/shellcheck.sh +++ b/scripts/shellcheck.sh @@ -3,7 +3,11 @@ set -euo pipefail target_files=() -while IFS='' read -r line; do target_files+=("$line"); done < <(grep -r -l --exclude-dir=.git --exclude-dir=_build "#!/bin/" .) +while IFS='' read -r line; +do + target_files+=("$line"); +done < <(git grep -r -l '^#!/\(bin/\|usr/bin/env bash\)' .) + return_code=0 for i in "${target_files[@]}"; do echo checking "$i" ... From 62dd815807ecf1772442bed58f7107ffd573ef3b Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Wed, 16 Feb 2022 14:35:23 +0100 Subject: [PATCH 20/31] chore(scripts): make shellcheck happy --- pkg-vsn.sh | 2 +- scripts/find-props.sh | 1 + scripts/find-suites.sh | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/pkg-vsn.sh b/pkg-vsn.sh index f3bdb1884..10780c467 100755 --- a/pkg-vsn.sh +++ b/pkg-vsn.sh @@ -18,7 +18,7 @@ RELEASE="$(grep -E "define.+EMQX_RELEASE.+${EDITION}" include/emqx_release.hrl | git_exact_vsn() { local tag tag="$(git describe --tags --match "[e|v]*" --exact 2>/dev/null)" - echo "$tag" | sed 's/^[v|e]//g' + echo "${tag#[e|v]}" } GIT_EXACT_VSN="$(git_exact_vsn)" diff --git a/scripts/find-props.sh b/scripts/find-props.sh index 582ef26ae..e2d9f7c31 100755 --- a/scripts/find-props.sh +++ b/scripts/find-props.sh @@ -13,4 +13,5 @@ if [ "$1" != "emqx" ]; then BASEDIR="$1" fi +# shellcheck disable=SC2038 find "${BASEDIR}/test/props" -name "prop_*.erl" 2>/dev/null | xargs -I{} basename {} .erl | xargs | tr ' ' ',' diff --git a/scripts/find-suites.sh b/scripts/find-suites.sh index 97939d931..7294a98e6 100755 --- a/scripts/find-suites.sh +++ b/scripts/find-suites.sh @@ -12,4 +12,5 @@ TESTDIR="test" if [ "$1" != "emqx" ]; then TESTDIR="$1/test" fi +# shellcheck disable=SC2038 find "${TESTDIR}" -name "*_SUITE.erl" 2>/dev/null | xargs | tr ' ' ',' From 42c70cd2a50023a75c4c0a9cb8e8494b863d2708 Mon Sep 17 00:00:00 2001 From: DDDHuang <44492639+DDDHuang@users.noreply.github.com> Date: Thu, 17 Feb 2022 14:06:17 +0800 Subject: [PATCH 21/31] fix(doc): code spelling --- apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.app.src | 2 +- apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.appup.src | 12 +++++++++++- apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.erl | 4 ++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.app.src b/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.app.src index e6d1c55c4..339c69eba 100644 --- a/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.app.src +++ b/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.app.src @@ -1,6 +1,6 @@ {application, emqx_bridge_mqtt, [{description, "EMQ X Bridge to MQTT Broker"}, - {vsn, "4.3.3"}, % strict semver, bump manually! + {vsn, "4.3.4"}, % strict semver, bump manually! {modules, []}, {registered, []}, {applications, [kernel,stdlib,replayq,emqtt]}, diff --git a/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.appup.src b/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.appup.src index 3b50949cd..52b4e24fc 100644 --- a/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.appup.src +++ b/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.appup.src @@ -1,21 +1,31 @@ %% -*-: erlang -*- -{"4.3.3", +{"4.3.4", [ + {<<"4.3.3">>, [ + {load_module, emqx_bridge_mqtt, brutal_purge, soft_purge, []} + ]}, {<<"4.3.[1-2]">>, [ + {load_module, emqx_bridge_mqtt, brutal_purge, soft_purge, []}, {load_module, emqx_bridge_mqtt_actions, brutal_purge, soft_purge, []} ]}, {"4.3.0", [ + {load_module, emqx_bridge_mqtt, brutal_purge, soft_purge, []}, {load_module, emqx_bridge_worker, brutal_purge, soft_purge, []}, {load_module, emqx_bridge_mqtt_actions, brutal_purge, soft_purge, []} ]}, {<<".*">>, []} ], [ + {<<"4.3.3">>, [ + {load_module, emqx_bridge_mqtt, brutal_purge, soft_purge, []} + ]}, {<<"4.3.[1-2]">>, [ + {load_module, emqx_bridge_mqtt, brutal_purge, soft_purge, []}, {load_module, emqx_bridge_mqtt_actions, brutal_purge, soft_purge, []} ]}, {"4.3.0", [ + {load_module, emqx_bridge_mqtt, brutal_purge, soft_purge, []}, {load_module, emqx_bridge_worker, brutal_purge, soft_purge, []}, {load_module, emqx_bridge_mqtt_actions, brutal_purge, soft_purge, []} ]}, diff --git a/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.erl b/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.erl index d612af668..3bd12564c 100644 --- a/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.erl +++ b/apps/emqx_bridge_mqtt/src/emqx_bridge_mqtt.erl @@ -144,7 +144,7 @@ send(#{client_pid := ClientPid} = Conn, [Msg | Rest], PktIds) -> {ok, PktId} -> send(Conn, Rest, [PktId | PktIds]); {error, Reason} -> - %% NOTE: There is no partial sucess of a batch and recover from the middle + %% NOTE: There is no partial success of a batch and recover from the middle %% only to retry all messages in one batch {error, Reason} end. @@ -154,7 +154,7 @@ handle_puback(#{packet_id := PktId, reason_code := RC}, Parent) RC =:= ?RC_NO_MATCHING_SUBSCRIBERS -> Parent ! {batch_ack, PktId}, ok; handle_puback(#{packet_id := PktId, reason_code := RC}, _Parent) -> - ?LOG(warning, "Publish ~p to remote node falied, reason_code: ~p", [PktId, RC]). + ?LOG(warning, "Publish ~p to remote node failed, reason_code: ~p", [PktId, RC]). handle_publish(Msg, Mountpoint) -> emqx_broker:publish(emqx_bridge_msg:to_broker_msg(Msg, Mountpoint)). From 3690d1951ee5ccf79445f37f25a47805af24ff65 Mon Sep 17 00:00:00 2001 From: Shawn <506895667@qq.com> Date: Fri, 18 Feb 2022 22:41:03 +0800 Subject: [PATCH 22/31] chore: add more debug info for relup-base-packages.sh --- scripts/relup-base-packages.sh | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/scripts/relup-base-packages.sh b/scripts/relup-base-packages.sh index 17f0d6ab4..bd3e99780 100755 --- a/scripts/relup-base-packages.sh +++ b/scripts/relup-base-packages.sh @@ -56,13 +56,15 @@ pushd _upgrade_base for tag in $(../scripts/relup-base-vsns.sh $EDITION | xargs echo -n); do filename="$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" url="https://www.emqx.com/downloads/$DIR/$tag/$filename" - echo "downloading ${filename} ..." + echo "downloading base package from ${url} ..." if [ ! -f "$filename" ] && curl -I -m 10 -o /dev/null -s -w "%{http_code}" "${url}" | grep -q -oE "^[23]+" ; then curl -L -o "${filename}" "${url}" if [ "$SYSTEM" != "centos6" ]; then curl -L -o "${filename}.sha256" "${url}.sha256" + SUMSTR=$(cat "${filename}.sha256") + echo "got sha265sum: ${SUMSTR}" ## https://askubuntu.com/questions/1202208/checking-sha256-checksum - echo "$(cat "${filename}.sha256") ${filename}" | $SHASUM -c || exit 1 + echo "${SUMSTR} ${filename}" | $SHASUM -c || exit 1 fi fi done From 3bd961ca732a2164b92b5c367c8c0e5183b3c1ed Mon Sep 17 00:00:00 2001 From: Shawn <506895667@qq.com> Date: Fri, 18 Feb 2022 23:05:35 +0800 Subject: [PATCH 23/31] fix(CI): remove e|v from downloading urls of emqx packages --- scripts/relup-base-packages.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/relup-base-packages.sh b/scripts/relup-base-packages.sh index bd3e99780..bedc050c7 100755 --- a/scripts/relup-base-packages.sh +++ b/scripts/relup-base-packages.sh @@ -55,7 +55,7 @@ pushd _upgrade_base for tag in $(../scripts/relup-base-vsns.sh $EDITION | xargs echo -n); do filename="$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" - url="https://www.emqx.com/downloads/$DIR/$tag/$filename" + url="https://www.emqx.com/downloads/$DIR/${tag#[e|v]}/$filename" echo "downloading base package from ${url} ..." if [ ! -f "$filename" ] && curl -I -m 10 -o /dev/null -s -w "%{http_code}" "${url}" | grep -q -oE "^[23]+" ; then curl -L -o "${filename}" "${url}" From 557c52dd8a97dcfd7a083d4cbe440d98ca343a3f Mon Sep 17 00:00:00 2001 From: Ilya Averyanov Date: Fri, 18 Feb 2022 20:35:11 +0300 Subject: [PATCH 24/31] chore(codestyle): remove Elvis --- .github/workflows/code_style_check.yaml | 24 ----- .../src/emqx_management.app.src | 2 +- apps/emqx_management/src/emqx_mgmt.erl | 2 - apps/emqx_stomp/src/emqx_stomp.app.src | 2 +- apps/emqx_stomp/src/emqx_stomp.appup.src | 25 +++-- apps/emqx_stomp/src/emqx_stomp_connection.erl | 2 - apps/emqx_stomp/src/emqx_stomp_protocol.erl | 2 - elvis.config | 47 ---------- scripts/elvis-check.sh | 84 ----------------- src/emqx.appup.src | 92 +++++++++++++------ src/emqx_banned.erl | 2 - src/emqx_connection.erl | 2 - src/emqx_ctl.erl | 2 - src/emqx_logger_jsonfmt.erl | 2 - src/emqx_message.erl | 2 - 15 files changed, 85 insertions(+), 207 deletions(-) delete mode 100644 .github/workflows/code_style_check.yaml delete mode 100644 elvis.config delete mode 100755 scripts/elvis-check.sh diff --git a/.github/workflows/code_style_check.yaml b/.github/workflows/code_style_check.yaml deleted file mode 100644 index 959512c20..000000000 --- a/.github/workflows/code_style_check.yaml +++ /dev/null @@ -1,24 +0,0 @@ -name: Code style check - -on: [pull_request] - -jobs: - build: - runs-on: ubuntu-20.04 - steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 1000 - - name: Set git token - if: endsWith(github.repository, 'enterprise') - run: | - echo "https://ci%40emqx.io:${{ secrets.CI_GIT_TOKEN }}@github.com" > $HOME/.git-credentials - git config --global credential.helper store - - name: Run elvis check - run: | - set -e - if [ -f EMQX_ENTERPRISE ]; then - ./scripts/elvis-check.sh $GITHUB_BASE_REF emqx-enterprise - else - ./scripts/elvis-check.sh $GITHUB_BASE_REF emqx - fi diff --git a/apps/emqx_management/src/emqx_management.app.src b/apps/emqx_management/src/emqx_management.app.src index bee65781a..64f44637a 100644 --- a/apps/emqx_management/src/emqx_management.app.src +++ b/apps/emqx_management/src/emqx_management.app.src @@ -1,6 +1,6 @@ {application, emqx_management, [{description, "EMQ X Management API and CLI"}, - {vsn, "4.3.11"}, % strict semver, bump manually! + {vsn, "4.3.12"}, % strict semver, bump manually! {modules, []}, {registered, [emqx_management_sup]}, {applications, [kernel,stdlib,minirest]}, diff --git a/apps/emqx_management/src/emqx_mgmt.erl b/apps/emqx_management/src/emqx_mgmt.erl index 2a9636b6b..bc271ee20 100644 --- a/apps/emqx_management/src/emqx_mgmt.erl +++ b/apps/emqx_management/src/emqx_mgmt.erl @@ -123,8 +123,6 @@ -define(MAX_ROW_LIMIT, 10000). -define(APP, emqx_management). - --elvis([{elvis_style, god_modules, disable}]). %%-------------------------------------------------------------------- %% Node Info %%-------------------------------------------------------------------- diff --git a/apps/emqx_stomp/src/emqx_stomp.app.src b/apps/emqx_stomp/src/emqx_stomp.app.src index a70826e34..5883cbca5 100644 --- a/apps/emqx_stomp/src/emqx_stomp.app.src +++ b/apps/emqx_stomp/src/emqx_stomp.app.src @@ -1,6 +1,6 @@ {application, emqx_stomp, [{description, "EMQ X Stomp Protocol Plugin"}, - {vsn, "4.3.4"}, % strict semver, bump manually! + {vsn, "4.3.5"}, % strict semver, bump manually! {modules, []}, {registered, [emqx_stomp_sup]}, {applications, [kernel,stdlib]}, diff --git a/apps/emqx_stomp/src/emqx_stomp.appup.src b/apps/emqx_stomp/src/emqx_stomp.appup.src index 8d61073d0..3493ade03 100644 --- a/apps/emqx_stomp/src/emqx_stomp.appup.src +++ b/apps/emqx_stomp/src/emqx_stomp.appup.src @@ -1,8 +1,15 @@ %% -*- mode: erlang -*- {VSN, - [{"4.3.3",[{load_module,emqx_stomp_frame,brutal_purge,soft_purge,[]}]}, - {"4.3.2", + [{"4.3.4", [{load_module,emqx_stomp_protocol,brutal_purge,soft_purge,[]}, + {load_module,emqx_stomp_connection,brutal_purge,soft_purge,[]}]}, + {"4.3.3", + [{load_module,emqx_stomp_protocol,brutal_purge,soft_purge,[]}, + {load_module,emqx_stomp_connection,brutal_purge,soft_purge,[]}, + {load_module,emqx_stomp_frame,brutal_purge,soft_purge,[]}]}, + {"4.3.2", + [{load_module,emqx_stomp_connection,brutal_purge,soft_purge,[]}, + {load_module,emqx_stomp_protocol,brutal_purge,soft_purge,[]}, {load_module,emqx_stomp_frame,brutal_purge,soft_purge,[]}]}, {"4.3.1", [{load_module,emqx_stomp_protocol,brutal_purge,soft_purge,[]}, @@ -12,14 +19,20 @@ [{restart_application,emqx_stomp}, {apply,{emqx_stomp,force_clear_after_app_stoped,[]}}]}, {<<".*">>,[]}], - [{"4.3.3",[{load_module,emqx_stomp_frame,brutal_purge,soft_purge,[]}]}, - {"4.3.2", + [{"4.3.4", [{load_module,emqx_stomp_protocol,brutal_purge,soft_purge,[]}, + {load_module,emqx_stomp_connection,brutal_purge,soft_purge,[]}]}, + {"4.3.3", + [{load_module,emqx_stomp_protocol,brutal_purge,soft_purge,[]}, + {load_module,emqx_stomp_connection,brutal_purge,soft_purge,[]}, + {load_module,emqx_stomp_frame,brutal_purge,soft_purge,[]}]}, + {"4.3.2", + [{load_module,emqx_stomp_connection,brutal_purge,soft_purge,[]}, + {load_module,emqx_stomp_protocol,brutal_purge,soft_purge,[]}, {load_module,emqx_stomp_frame,brutal_purge,soft_purge,[]}]}, {"4.3.1", [{load_module,emqx_stomp_protocol,brutal_purge,soft_purge,[]}, {load_module,emqx_stomp_frame,brutal_purge,soft_purge,[]}, {load_module,emqx_stomp_connection,brutal_purge,soft_purge,[]}]}, - {"4.3.0", - [{restart_application,emqx_stomp}]}, + {"4.3.0",[{restart_application,emqx_stomp}]}, {<<".*">>,[]}]}. diff --git a/apps/emqx_stomp/src/emqx_stomp_connection.erl b/apps/emqx_stomp/src/emqx_stomp_connection.erl index 19ae6bc26..4e5793dad 100644 --- a/apps/emqx_stomp/src/emqx_stomp_connection.erl +++ b/apps/emqx_stomp/src/emqx_stomp_connection.erl @@ -91,8 +91,6 @@ -define(ENABLED(X), (X =/= undefined)). --elvis([{elvis_style, invalid_dynamic_call, #{ignore => [emqx_stomp_connection]}}]). - -dialyzer({nowarn_function, [ ensure_stats_timer/2 ]}). diff --git a/apps/emqx_stomp/src/emqx_stomp_protocol.erl b/apps/emqx_stomp/src/emqx_stomp_protocol.erl index 4e371d9b0..6049b88f3 100644 --- a/apps/emqx_stomp/src/emqx_stomp_protocol.erl +++ b/apps/emqx_stomp/src/emqx_stomp_protocol.erl @@ -108,8 +108,6 @@ , init/2 ]}). --elvis([{elvis_style, dont_repeat_yourself, disable}]). - -type(pstate() :: #pstate{}). %% @doc Init protocol diff --git a/elvis.config b/elvis.config deleted file mode 100644 index ae47fc8f9..000000000 --- a/elvis.config +++ /dev/null @@ -1,47 +0,0 @@ -%% -*-: erlang -*- -[ - { - elvis, - [ - {config, - [ - #{dirs => ["src", "apps/**/src", "lib-ce/**/src", "lib-ee/**/src"], - filter => "*.erl", - ruleset => erl_files, - rules => [ - {elvis_style, state_record_and_type, disable}, - {elvis_style, no_common_caveats_call, #{}}, - {elvis_style, no_debug_call, #{ debug_functions => [ {ct, pal} - , {ct, print} - ]}}, - {elvis_style, operator_spaces, #{rules => [{right, "|"}, - {left, "|"}, - {right, "||"}, - {left, "||"}]}} - ] - }, - #{dirs => ["test", "apps/**/test", "lib-ce/**/src"], - filter => "*.erl", - rules => [ - {elvis_text_style, line_length, #{ limit => 100 - , skip_comments => false }}, - {elvis_style, dont_repeat_yourself, #{ min_complexity => 100 }} - ] - }, - #{dirs => ["."], - filter => "Makefile", - ruleset => makefiles - }, - #{dirs => ["."], - filter => "rebar.config", - ruleset => rebar_config - }, - #{dirs => ["."], - filter => "elvis.config", - ruleset => elvis_config - } - ] - } - ] - } -]. diff --git a/scripts/elvis-check.sh b/scripts/elvis-check.sh deleted file mode 100755 index 264200d6b..000000000 --- a/scripts/elvis-check.sh +++ /dev/null @@ -1,84 +0,0 @@ -#!/usr/bin/env bash - -## This script checks style of changed files. -## Expect argument 1 to be the git compare base. - -set -euo pipefail - -elvis_version='1.0.0-emqx-2' - -base="${1:-}" -repo="${2:-emqx/emqx}" -REPO="${GITHUB_REPOSITORY:-${repo}}" -if [ "${base}" = "" ]; then - echo "Usage $0 " - exit 1 -fi - -echo "elvis -v: $elvis_version" -echo "git diff base: $base" - -if [ ! -f ./elvis ] || [ "$(./elvis -v | grep -oE '[1-9]+\.[0-9]+\.[0-9]+\-emqx-[0-9]+')" != "$elvis_version" ]; then - curl --silent --show-error -fLO "https://github.com/emqx/elvis/releases/download/$elvis_version/elvis" - chmod +x ./elvis -fi - -if [[ "$base" =~ [0-9a-f]{8,40} ]]; then - # base is a commit sha1 - compare_base="$base" -else - remote="$(git remote -v | grep -E "github\.com(:|/)$REPO((\.git)|(\s))" | grep fetch | awk '{print $1}')" - git fetch "$remote" "$base" - compare_base="$remote/$base" -fi - -git_diff() { - git diff --name-only --diff-filter=ACMRTUXB "$compare_base"...HEAD -} - -bad_file_count=0 -for file in $(git_diff); do - if [ ! -f "$file" ]; then - # file is deleted, skip - continue - fi - if [[ $file != *.erl ]]; then - # not .erl file - continue - fi - if ! ./elvis rock "$file" -c elvis.config; then - bad_file_count=$(( bad_file_count + 1)) - fi -done -if [ $bad_file_count -gt 0 ]; then - echo "elvis: $bad_file_count errors" - exit 1 -fi - -### now check new-line at EOF for changed files - -nl_at_eof() { - local file="$1" - if ! [ -f "$file" ]; then - return - fi - case "$file" in - *.png|*rebar3) - return - ;; - esac - local lastbyte - lastbyte="$(tail -c 1 "$file" 2>&1)" - if [ "$lastbyte" != '' ]; then - echo "$file" - return 1 - fi -} - -for file in $(git_diff); do - if ! nl_at_eof "$file"; then - bad_file_count=$(( bad_file_count + 1 )) - fi -done - -exit $bad_file_count diff --git a/src/emqx.appup.src b/src/emqx.appup.src index cd5b02954..a133d37a6 100644 --- a/src/emqx.appup.src +++ b/src/emqx.appup.src @@ -1,8 +1,14 @@ %% -*- mode: erlang -*- {VSN, - [{"4.3.13",[{load_module,emqx_channel,brutal_purge,soft_purge,[]}]}, + [{"4.3.13", + [{load_module,emqx_connection,brutal_purge,soft_purge,[]}, + {load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, + {load_module,emqx_channel,brutal_purge,soft_purge,[]}]}, {"4.3.12", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_connection,brutal_purge,soft_purge,[]}, + {load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, @@ -16,7 +22,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.11", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, @@ -35,7 +42,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.10", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, @@ -54,7 +62,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.9", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, @@ -78,7 +87,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.8", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, @@ -102,7 +112,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.7", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, @@ -128,7 +139,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.6", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, {load_module,emqx_access_control,brutal_purge,soft_purge,[]}, @@ -154,7 +166,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.5", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, {load_module,emqx_access_control,brutal_purge,soft_purge,[]}, @@ -181,7 +194,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.4", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, {load_module,emqx_access_control,brutal_purge,soft_purge,[]}, @@ -209,7 +223,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.3", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, {load_module,emqx_access_control,brutal_purge,soft_purge,[]}, @@ -238,7 +253,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.2", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, {load_module,emqx_access_control,brutal_purge,soft_purge,[]}, @@ -267,7 +283,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.1", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, {load_module,emqx_access_control,brutal_purge,soft_purge,[]}, @@ -300,7 +317,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.0", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, {apply,{emqx_metrics,assign_acl_stats_from_ets_to_counter,[]}}, {apply,{emqx_metrics,upgrade_retained_delayed_counter_type,[]}}, @@ -336,9 +354,15 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {<<".*">>,[]}], - [{"4.3.13",[{load_module,emqx_channel,brutal_purge,soft_purge,[]}]}, + [{"4.3.13", + [{load_module,emqx_connection,brutal_purge,soft_purge,[]}, + {load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, + {load_module,emqx_channel,brutal_purge,soft_purge,[]}]}, {"4.3.12", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_connection,brutal_purge,soft_purge,[]}, + {load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_channel,brutal_purge,soft_purge,[]}, {load_module,emqx_access_control,brutal_purge,soft_purge,[]}, @@ -351,7 +375,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.11", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_connection,brutal_purge,soft_purge,[]}, {load_module,emqx_channel,brutal_purge,soft_purge,[]}, @@ -369,7 +394,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.10", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_channel,brutal_purge,soft_purge,[]}, {load_module,emqx_metrics,brutal_purge,soft_purge,[]}, @@ -387,7 +413,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.9", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, @@ -410,7 +437,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.8", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, @@ -433,7 +461,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.7", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_ctl,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, @@ -458,7 +487,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.6", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_http_lib,brutal_purge,soft_purge,[]}, @@ -483,7 +513,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.5", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_http_lib,brutal_purge,soft_purge,[]}, @@ -509,7 +540,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.4", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_http_lib,brutal_purge,soft_purge,[]}, @@ -536,7 +568,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.3", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_http_lib,brutal_purge,soft_purge,[]}, @@ -564,7 +597,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.2", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_pqueue,brutal_purge,soft_purge,[]}, @@ -592,7 +626,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.1", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_pqueue,brutal_purge,soft_purge,[]}, @@ -624,7 +659,8 @@ {load_module,emqx_message,brutal_purge,soft_purge,[]}, {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]}, {"4.3.0", - [{load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, + [{load_module,emqx_banned,brutal_purge,soft_purge,[]}, + {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_vm,brutal_purge,soft_purge,[]}, {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]}, {load_module,emqx_alarm_handler,brutal_purge,soft_purge,[]}, diff --git a/src/emqx_banned.erl b/src/emqx_banned.erl index 762a2b61b..af4603078 100644 --- a/src/emqx_banned.erl +++ b/src/emqx_banned.erl @@ -47,8 +47,6 @@ , code_change/3 ]). --elvis([{elvis_style, state_record_and_type, disable}]). - -define(BANNED_TAB, ?MODULE). %%-------------------------------------------------------------------- diff --git a/src/emqx_connection.erl b/src/emqx_connection.erl index ef12f6bcf..18816ccd9 100644 --- a/src/emqx_connection.erl +++ b/src/emqx_connection.erl @@ -30,8 +30,6 @@ -compile(nowarn_export_all). -endif. --elvis([{elvis_style, invalid_dynamic_call, #{ignore => [emqx_connection]}}]). - %% API -export([ start_link/3 , stop/1 diff --git a/src/emqx_ctl.erl b/src/emqx_ctl.erl index 7b73c50fe..400821537 100644 --- a/src/emqx_ctl.erl +++ b/src/emqx_ctl.erl @@ -57,8 +57,6 @@ , code_change/3 ]). --elvis([{elvis_style, invalid_dynamic_call, #{ignore => [emqx_ctl]}}]). - -record(state, {seq = 0}). -type(cmd() :: atom()). diff --git a/src/emqx_logger_jsonfmt.erl b/src/emqx_logger_jsonfmt.erl index 31e4c2fda..b2311935d 100644 --- a/src/emqx_logger_jsonfmt.erl +++ b/src/emqx_logger_jsonfmt.erl @@ -37,8 +37,6 @@ -export_type([config/0]). --elvis([{elvis_style, no_nested_try_catch, #{ ignore => [emqx_logger_jsonfmt]}}]). - -type config() :: #{depth => pos_integer() | unlimited, report_cb => logger:report_cb(), single_line => boolean()}. diff --git a/src/emqx_message.erl b/src/emqx_message.erl index a0ee98434..07ae593c1 100644 --- a/src/emqx_message.erl +++ b/src/emqx_message.erl @@ -84,8 +84,6 @@ -export([format/1]). --elvis([{elvis_style, god_modules, disable}]). - -spec(make(emqx_topic:topic(), emqx_types:payload()) -> emqx_types:message()). make(Topic, Payload) -> make(undefined, Topic, Payload). From 2325e8cfb3965e7cb50f97c692ca33fd85b02203 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Sun, 20 Feb 2022 19:57:56 +0100 Subject: [PATCH 25/31] chore: ensure remsh node name prefix for upgrader for remsh prefixed nodes, ekka pick a random port to listen on instead of following the conventional port mapping rule: ekka listens on 4370 for emqx or emqx0 and 4371 for emqx1 and so on --- bin/install_upgrade.escript | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/install_upgrade.escript b/bin/install_upgrade.escript index 97548cba8..f88af106d 100755 --- a/bin/install_upgrade.escript +++ b/bin/install_upgrade.escript @@ -365,7 +365,7 @@ start_distribution(TargetNode, NameTypeArg, Cookie) -> make_script_node(Node) -> [Name, Host] = string:tokens(atom_to_list(Node), "@"), - list_to_atom(lists:concat([Name, "_upgrader_", os:getpid(), "@", Host])). + list_to_atom(lists:concat(["remsh_", Name, "_upgrader_", os:getpid(), "@", Host])). %% get name type from arg get_name_type(NameTypeArg) -> From 107e447de46d77910ec1f067fec339b272c66fef Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Sun, 20 Feb 2022 09:19:56 +0100 Subject: [PATCH 26/31] build: fix find command for windows windows has its own find command --- Makefile | 7 +++++-- build | 11 +++++++++-- scripts/find-apps.sh | 11 +++++++++-- 3 files changed, 23 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index ed7c5b6a3..b57543c52 100644 --- a/Makefile +++ b/Makefile @@ -11,6 +11,9 @@ export EMQX_CE_DASHBOARD_VERSION ?= v4.3.5 export DOCKERFILE := deploy/docker/Dockerfile ifeq ($(OS),Windows_NT) export REBAR_COLOR=none + FIND=/usr/bin/find +else + FIND=find endif PROFILE ?= emqx @@ -90,8 +93,8 @@ $(PROFILES:%=clean-%): @if [ -d _build/$(@:clean-%=%) ]; then \ rm rebar.lock \ rm -rf _build/$(@:clean-%=%)/rel; \ - find _build/$(@:clean-%=%) -name '*.beam' -o -name '*.so' -o -name '*.app' -o -name '*.appup' -o -name '*.o' -o -name '*.d' -type f | xargs rm -f; \ - find _build/$(@:clean-%=%) -type l -delete; \ + $(FIND) _build/$(@:clean-%=%) -name '*.beam' -o -name '*.so' -o -name '*.app' -o -name '*.appup' -o -name '*.o' -o -name '*.d' -type f | xargs rm -f; \ + $(FIND) _build/$(@:clean-%=%) -type l -delete; \ fi .PHONY: clean-all diff --git a/build b/build index 684057bf1..517efc132 100755 --- a/build +++ b/build @@ -45,6 +45,13 @@ if [ "$(uname -s)" = 'Linux' ]; then esac fi +if [ "${SYSTEM}" = 'windows' ]; then + # windows does not like the find + FIND="/usr/bin/find" +else + FIND='find' +fi + log() { local msg="$1" # rebar3 prints ===>, so we print ===< @@ -76,7 +83,7 @@ make_relup() { rm -rf "$tmp_dir" fi releases+=( "$base_vsn" ) - done < <(find _upgrade_base -maxdepth 1 -name "*$PROFILE-$SYSTEM*-$ARCH.zip" -type f) + done < <("$FIND" _upgrade_base -maxdepth 1 -name "*$PROFILE-$SYSTEM*-$ARCH.zip" -type f) fi if [ ${#releases[@]} -eq 0 ]; then log "No upgrade base found, relup ignored" @@ -96,7 +103,7 @@ cp_dyn_libs() { mkdir -p "$target_dir" while read -r so_file; do cp -L "$so_file" "$target_dir/" - done < <(find "$rel_dir" -type f \( -name "*.so*" -o -name "beam.smp" \) -print0 \ + done < <("$FIND" "$rel_dir" -type f \( -name "*.so*" -o -name "beam.smp" \) -print0 \ | xargs -0 ldd \ | grep -E '(libcrypto)|(libtinfo)' \ | awk '{print $3}' \ diff --git a/scripts/find-apps.sh b/scripts/find-apps.sh index fabec239e..c4a0eec62 100755 --- a/scripts/find-apps.sh +++ b/scripts/find-apps.sh @@ -5,9 +5,16 @@ set -euo pipefail # ensure dir cd -P -- "$(dirname -- "$0")/.." +if [ "$(./scripts/get-distro.sh)" = 'windows' ]; then + # Otherwise windows may resolve to find.exe + FIND="/usr/bin/find" +else + FIND='find' +fi + find_app() { local appdir="$1" - find "${appdir}" -mindepth 1 -maxdepth 1 -type d + "$FIND" "${appdir}" -mindepth 1 -maxdepth 1 -type d } # append emqx application first @@ -23,4 +30,4 @@ fi ## find directories in lib-extra find_app 'lib-extra' ## find symlinks in lib-extra -find 'lib-extra' -mindepth 1 -maxdepth 1 -type l -exec test -e {} \; -print +"$FIND" 'lib-extra' -mindepth 1 -maxdepth 1 -type l -exec test -e {} \; -print From 31b006a0d12f7990547015eb506ae967311c72a7 Mon Sep 17 00:00:00 2001 From: JimMoen Date: Mon, 21 Feb 2022 18:40:12 +0800 Subject: [PATCH 27/31] fix(frame): `server_keepalive` only for MQTT v5.0 --- src/emqx_channel.erl | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/emqx_channel.erl b/src/emqx_channel.erl index dc0c52598..32f0062ea 100644 --- a/src/emqx_channel.erl +++ b/src/emqx_channel.erl @@ -1515,11 +1515,13 @@ enrich_connack_caps(AckProps, _Channel) -> AckProps. %%-------------------------------------------------------------------- %% Enrich server keepalive -enrich_server_keepalive(AckProps, #channel{clientinfo = #{zone := Zone}}) -> +enrich_server_keepalive(AckProps, ?IS_MQTT_V5 = #channel{clientinfo = #{zone := Zone}}) -> case emqx_zone:server_keepalive(Zone) of undefined -> AckProps; Keepalive -> AckProps#{'Server-Keep-Alive' => Keepalive} - end. + end; + +enrich_server_keepalive(AckProps, _Channel) -> AckProps. %%-------------------------------------------------------------------- %% Enrich response information @@ -1565,7 +1567,7 @@ init_alias_maximum(#mqtt_packet_connect{proto_ver = ?MQTT_PROTO_V5, init_alias_maximum(_ConnPkt, _ClientInfo) -> undefined. %%-------------------------------------------------------------------- -%% Enrich Keepalive +%% Ensure Keepalive %% MQTT 5 ensure_keepalive(#{'Server-Keep-Alive' := Interval}, Channel = #channel{conninfo = ConnInfo}) -> From 6b720286c6fdbec3abf67ad9c1d84c1884c3cef1 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Tue, 22 Feb 2022 11:55:20 +0800 Subject: [PATCH 28/31] chore: fix bad sytanx for emqx.appup.src --- src/emqx.appup.src | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/emqx.appup.src b/src/emqx.appup.src index e339ad952..c95a1beaf 100644 --- a/src/emqx.appup.src +++ b/src/emqx.appup.src @@ -8,7 +8,7 @@ ]}, {"4.4.0", [ {load_module,emqx_vm_mon,brutal_purge,soft_purge,[]} - {load_module,emqx_banned,brutal_purge,soft_purge,[]}, + , {load_module,emqx_banned,brutal_purge,soft_purge,[]} , {load_module,emqx_ctl,brutal_purge,soft_purge,[]} , {load_module,emqx_channel,brutal_purge,soft_purge,[]} , {load_module,emqx_connection,brutal_purge,soft_purge,[]} From 18feec9030595bbd0bfceaa40706803cf8fe001d Mon Sep 17 00:00:00 2001 From: JianBo He Date: Tue, 22 Feb 2022 13:43:46 +0800 Subject: [PATCH 29/31] chore(ci): fix the download filename --- scripts/relup-base-packages.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/relup-base-packages.sh b/scripts/relup-base-packages.sh index bedc050c7..90e79edbb 100755 --- a/scripts/relup-base-packages.sh +++ b/scripts/relup-base-packages.sh @@ -54,7 +54,7 @@ mkdir -p _upgrade_base pushd _upgrade_base for tag in $(../scripts/relup-base-vsns.sh $EDITION | xargs echo -n); do - filename="$PROFILE-$SYSTEM-${tag#[e|v]}-$ARCH.zip" + filename="$PROFILE-${tag#[e|v]}-otp$OTP_VSN-$SYSTEM-$ARCH.zip" url="https://www.emqx.com/downloads/$DIR/${tag#[e|v]}/$filename" echo "downloading base package from ${url} ..." if [ ! -f "$filename" ] && curl -I -m 10 -o /dev/null -s -w "%{http_code}" "${url}" | grep -q -oE "^[23]+" ; then From fb7944391d25ee7d52b6dd1ebad0b98f11af99b1 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 22 Feb 2022 09:40:32 +0100 Subject: [PATCH 30/31] build: fix shellcheck --- .ci/build_packages/tests.sh | 8 ++++---- scripts/buildx.sh | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.ci/build_packages/tests.sh b/.ci/build_packages/tests.sh index 628a798e9..04d8018ac 100755 --- a/.ci/build_packages/tests.sh +++ b/.ci/build_packages/tests.sh @@ -24,7 +24,7 @@ export RELUP_PACKAGE_PATH="${CODE_PATH}/_upgrade_base" # export EMQX_NODE_NAME="emqx-on-$(uname -m)@127.0.0.1" # export EMQX_NODE_COOKIE=$(date +%s%N) -SYSTEM="$($CODE_PATH/scripts/get-distro.sh)" +SYSTEM="$("$CODE_PATH"/scripts/get-distro.sh)" if [ "$PACKAGE_TYPE" = 'zip' ]; then PKG_SUFFIX="zip" @@ -39,8 +39,8 @@ else esac fi -PACKAGE_NAME="${PROFILE}-$($CODE_PATH/scripts/pkg-full-vsn.sh)" -OLD_PACKAGE_PATTERN="${PROFILE}-$($CODE_PATH/scripts/pkg-full-vsn.sh 'vsn_matcher')" +PACKAGE_NAME="${PROFILE}-$("$CODE_PATH"/scripts/pkg-full-vsn.sh)" +OLD_PACKAGE_PATTERN="${PROFILE}-$("$CODE_PATH"/scripts/pkg-full-vsn.sh 'vsn_matcher')" PACKAGE_FILE_NAME="${PACKAGE_NAME}.${PKG_SUFFIX}" PACKAGE_FILE="${PACKAGE_PATH}/${PACKAGE_FILE_NAME}" @@ -117,7 +117,7 @@ emqx_test(){ ;; "rpm") yum install -y "${PACKAGE_PATH}/${packagename}" - if ! rpm -q ${PROFILE} | grep -q "${PROFILE}"; then + if ! rpm -q "${PROFILE}" | grep -q "${PROFILE}"; then echo "package install error" exit 1 fi diff --git a/scripts/buildx.sh b/scripts/buildx.sh index fd754bad6..94da5fb9b 100755 --- a/scripts/buildx.sh +++ b/scripts/buildx.sh @@ -71,7 +71,7 @@ cd "${SRC_DIR:-.}" set -x docker info -docker run --rm --privileged tonistiigi/binfmt:latest --install ${ARCH} +docker run --rm --privileged tonistiigi/binfmt:latest --install "${ARCH}" docker run -i --rm \ -v "$(pwd)":/emqx \ --workdir /emqx \ From 4473a832bc903bb419a05aa6c872e8ea831fc94c Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 22 Feb 2022 09:43:06 +0100 Subject: [PATCH 31/31] build: fix macos -> macos* so matches macos10 and macos11 --- scripts/relup-base-packages.sh | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/scripts/relup-base-packages.sh b/scripts/relup-base-packages.sh index 90e79edbb..f86185e0a 100755 --- a/scripts/relup-base-packages.sh +++ b/scripts/relup-base-packages.sh @@ -42,10 +42,15 @@ case "$ARCH" in ;; esac -SHASUM="sha256sum" -if [ "$SYSTEM" = "macos" ]; then - SHASUM="shasum -a 256" -fi + +case "$SYSTEM" in + macos*) + SHASUM="shasum -a 256" + ;; + *) + SHASUM="sha256sum" + ;; +esac # ensure dir cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")/.."