feat: rename emqx ctl cluster_sync 'tnxid' to 'inspect'

This commit is contained in:
Zaiming (Stone) Shi 2024-02-05 15:49:48 +01:00
parent ce50055138
commit d7b0456bb0
2 changed files with 14 additions and 6 deletions

View File

@ -89,6 +89,10 @@ admins(["skip", Node0]) ->
emqx_cluster_rpc:skip_failed_commit(Node),
status();
admins(["tnxid", TnxId0]) ->
%% changed to 'inspect' in 5.6
%% TODO: delete this clause in 5.7
admins(["inspect", TnxId0]);
admins(["inspect", TnxId0]) ->
TnxId = list_to_integer(TnxId0),
print(emqx_cluster_rpc:query(TnxId));
admins(["fast_forward"]) ->
@ -145,12 +149,14 @@ usage_conf() ->
usage_sync() ->
[
{"conf cluster_sync status", "Show cluster config sync status summary"},
{"conf cluster_sync skip [node]", "Increase one commit on specific node"},
{"conf cluster_sync tnxid <TnxId>",
"Display detailed information of the config change transaction at TnxId"},
{"conf cluster_sync fast_forward [node] [tnx_id]",
"Fast-forward config change transaction to tnx_id on the given node."
{"conf cluster_sync status", "Show cluster config sync status summary for all nodes."},
{"conf cluster_sync inspect <ID>",
"Inspect detailed information of the config change transaction at the given commit ID"},
{"conf cluster_sync skip [node]",
"Increment the (currently failing) commit on the given node.\n"
"WARNING: This results in inconsistent configs among the clustered nodes."},
{"conf cluster_sync fast_forward [node] <ID>",
"Fast-forward config change to the given commit ID on the given node.\n"
"WARNING: This results in inconsistent configs among the clustered nodes."}
].

View File

@ -0,0 +1,2 @@
Renamed `emqx ctl conf cluster_sync tnxid ID` to `emqx ctl conf cluster_sync inspect ID`.
For backward compatibility, `tnxid` is kept, but considered deprecated and will be removed in 5.7.