Module Installation

Note

This document has been machine translated.

The installation procedure varies by module; refer to each module’s documentation for details. The following provides a general overview.

Module Deployment

Deploy the modules on the built SSH host.

If the WORKER_ROOT_DIR setting of the module execution engine is /home/ubuntu/work/xdata-algo-modules, arrange the modules with a directory structure such as:

xdata-algo-modules/
├── {module_name1}/
│    └── docker-compose.yml and related files
├── {module_name2}/
│    └── docker-compose.yml and related files
└── ...

Initially place the sample algorithm module to verify operation.

Precautions During Module Installation or Update

When introducing a new Docker module or updating source code, a build step is required. Skipping the build may cause modules to malfunction.

Build the module with a command like:

docker compose build [service_name]

The [service_name] corresponds to the service defined in docker-compose.yml.

Similarly, the service that retrieves module definition information (get-definition) must also be built. Execute:

docker compose build get-definition