Install a module

Note

This document has been machine translated.

Since the method of installing modules varies from module to module, please refer to the documentation of each module for details. The following is a description of the general deployment method.

Deploy the module

Deploy the module on the SSH host you have built.

If WORKER_ROOT_DIR of the module execution mechanism is set to /home/ubuntu/work/xdata-algomodules, modules are deployed in the following directory structure.

xdata-algo-modules/
├── {module name1}/
│ └── docker-compose.yml and other files
├── {module name2}/
│ └── Various files such as docker-compose.yml
└── ...

At first, deploy the sample algorithm module and check its operation.

Cautions when installing or updating modules

When installing a new Docker module or updating the source code, it is necessary to perform the build process.
If you do not perform the build operation, the module may not work properly.
The build operation can be executed with the following command.

docker compose build [service name].

The service name you specify will be the service name defined in docker-compose.yml.

The service to get module definition information (get-definition) must also be built in the same way.
You can execute the build with the following command.
``shell docker compose build get-definition ```