CLI插件

警告

实验性功能！

编写和配置

您可以通过和cli同级的plugins目录编写CLI插件。

每个插件占据一个目录，目录名为插件的ID。例如plugins/plugin1，则此插件id为plugin1。

当您编写好插件后，您可以通过install.yml的plugins.enabledPlugins选项，指定启用的插件。

例如，如果要使用plugin1插件，则编写

install.yml

plugins: 
  enabledPlugins: ["plugin1"]

插件功能

覆盖docker-compose.yml

您可以通过此功能更改部署的Docker Compose配置，例如在OpenSCOW网络中部署其他的容器，或者给已有的服务增加新的环境变量、端口等。

在插件目录下，您可以编写docker-compose.yml文件，此文件将会与CLI生成的Docker Compose配置文件合并。CLI在调用docker compose时，使用docker compose -f {openscow-cli生成的compose文件} ...-f {所有插件的compose文件}的方法执行。

plugins/plugin1/docker-compose.yml

version: "3"

services: 
  extraService:
    image: <您的容器镜像>
    # ...

拓展与集成

如果您仅需要增加部分服务端功能，只需要增加一个插件服务即可。

如果您需要增加页面功能，并与OpenSCOW的http服务绑定在同一个端口上，需要在增加插件服务的同时增加gateway的配置，具体参考网关配置