emqx_plugins_schema {
plugins {
desc {
en: """
Manage EMQX plugins.
Plugins can be pre-built as a part of EMQX package,
or installed as a standalone package in a location specified by
install_dir
config key
The standalone-installed plugins are referred to as 'external' plugins.
"""
zh: """管理EMQX插件。
插件可以是EMQX安装包中的一部分,也可以是一个独立的安装包。
独立安装的插件称为“外部插件”。
"""
}
label {
en: "Plugins"
zh: "插件"
}
}
state {
desc {
en: "A per-plugin config to describe the desired state of the plugin."
zh: "描述插件的状态"
}
label {
en: "State"
zh: "插件状态"
}
}
name_vsn {
desc {
en: """The {name}-{version} of the plugin.
It should match the plugin application name-version as the for the plugin release package name
For example: my_plugin-0.1.0.
"""
zh: """插件的名称{name}-{version}。
它应该与插件的发布包名称一致,如my_plugin-0.1.0。"""
}
label {
en: "Name-Version"
zh: "名称-版本"
}
}
enable {
desc {
en: "Set to 'true' to enable this plugin"
zh: "设置为“true”以启用此插件"
}
label {
en: "Enable"
zh: "启用"
}
}
states {
desc {
en: """An array of plugins in the desired states.
The plugins are started in the defined order"""
zh: """一组插件的状态。插件将按照定义的顺序启动"""
}
label {
en: "States"
zh: "插件启动顺序及状态"
}
}
install_dir {
desc {
en: """
The installation directory for the external plugins.
The plugin beam files and configuration files should reside in
the subdirectory named as emqx_foo_bar-0.1.0
.
NOTE: For security reasons, this directory should **NOT** be writable
by anyone except emqx
(or any user which runs EMQX).
"""
zh: "插件安装包的目录,出于安全考虑,该目录应该值允许 emqx
,或用于运行 EMQX 服务的用户拥有写入权限。"
}
label {
en: "Install Directory"
zh: "安装目录"
}
}
check_interval {
desc {
en: """Check interval: check if the status of the plugins in the cluster is consistent,
if the results of 3 consecutive checks are not consistent, then alarm.
"""
zh: """检查间隔:检查集群中插件的状态是否一致,
如果连续3次检查结果不一致,则报警。
"""
}
}
}