emqx_plugins_schema.conf 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. emqx_plugins_schema {
  2. plugins {
  3. desc {
  4. en: """
  5. Manage EMQX plugins.</br>
  6. Plugins can be pre-built as a part of EMQX package,
  7. or installed as a standalone package in a location specified by
  8. <code>install_dir</code> config key</br>
  9. The standalone-installed plugins are referred to as 'external' plugins.
  10. """
  11. zh: """管理EMQX插件。</br>
  12. 插件可以是EMQX安装包中的一部分,也可以是一个独立的安装包。</br>
  13. 独立安装的插件称为“外部插件”。
  14. """
  15. }
  16. label {
  17. en: "Plugins"
  18. zh: "插件"
  19. }
  20. }
  21. state {
  22. desc {
  23. en: "A per-plugin config to describe the desired state of the plugin."
  24. zh: "描述插件的状态"
  25. }
  26. label {
  27. en: "State"
  28. zh: "插件状态"
  29. }
  30. }
  31. name_vsn {
  32. desc {
  33. en: """The {name}-{version} of the plugin.</br>
  34. It should match the plugin application name-version as the for the plugin release package name</br>
  35. For example: my_plugin-0.1.0.
  36. """
  37. zh: """插件的名称{name}-{version}。</br>
  38. 它应该与插件的发布包名称一致,如my_plugin-0.1.0。"""
  39. }
  40. label {
  41. en: "Name-Version"
  42. zh: "名称-版本"
  43. }
  44. }
  45. enable {
  46. desc {
  47. en: "Set to 'true' to enable this plugin"
  48. zh: "设置为“true”以启用此插件"
  49. }
  50. label {
  51. en: "Enable"
  52. zh: "启用"
  53. }
  54. }
  55. states {
  56. desc {
  57. en: """An array of plugins in the desired states.</br>
  58. The plugins are started in the defined order"""
  59. zh: """一组插件的状态。插件将按照定义的顺序启动"""
  60. }
  61. label {
  62. en: "States"
  63. zh: "插件启动顺序及状态"
  64. }
  65. }
  66. install_dir {
  67. desc {
  68. en: """
  69. The installation directory for the external plugins.
  70. The plugin beam files and configuration files should reside in
  71. the subdirectory named as <code>emqx_foo_bar-0.1.0</code>.
  72. </br>
  73. NOTE: For security reasons, this directory should **NOT** be writable
  74. by anyone except <code>emqx</code> (or any user which runs EMQX).
  75. """
  76. zh: "插件安装包的目录, 不要自己创建, 只能由emqx用户创建与修改"
  77. }
  78. label {
  79. en: "Install Directory"
  80. zh: "安装目录"
  81. }
  82. }
  83. check_interval {
  84. desc {
  85. en: """Check interval: check if the status of the plugins in the cluster is consistent, </br>
  86. if the results of 3 consecutive checks are not consistent, then alarm.
  87. """
  88. zh: """检查间隔:检查集群中插件的状态是否一致,</br>
  89. 如果连续3次检查结果不一致,则报警。
  90. """
  91. }
  92. }
  93. }