semarchy/xdi-runtime repository overview

⁠Quick reference

• Maintained by: Semarchy⁠
• Where to get help: Semarchy Community⁠ and Semarchy Support Library⁠.

⁠Version

For the versions available, see the tags on this repository⁠.

See also Global Support Policy⁠ for more information about the available versions, their support and maintenance plan.

⁠Semarchy xDI Runtime

Semarchy, a leader in the data integration and master data management markets, enables organizations to rapidly generate business value from their data. Its unified platform enables organizations of any size, to quickly discover, govern, manage, integrate, and report critical information scattered across applications.

Semarchy xDI is a high-performance, agile, and extensible data integration platform supporting any integration style and use case. Semarchy xDI Runtime is the engine used to run the data flows designed in Semarchy xDI Designer. It connects to the systems and applications containing the data to integrate.

For more information, visit www.semarchy.com⁠.

⁠Base image

The Semarchy xDI Runtime images are using an OpenJDK base image⁠ composed of:

• Debian image
• OpenJDK version supported by Semarchy xDI Runtime⁠

For example: eclipse-temurin:11-jdk-jammy

⁠Docker Compose Sample

Use the Docker Compose Sample⁠ as a template to create your own Docker Compose file.

⁠Usage

To run the server you need to:

1. Download and uncompress the Tutorial Resources⁠.
   The quick-install/docker/<version>/xdi-runtime/docker-compose/ folder contains the docker-compose.yml file as well as a shared-resources folder with sample configuration files.

2. Add your Semarchy xDI Runtime Modules in a volume mounted to shared-resources/modules folder. the /opt/semarchy/xdi-runtime/modules.
   NOTE: This folder is mounted to the /opt/semarchy/xdi-runtime/modules location in the container by the sample Docker Compose.
   IMPORTANT: With the sample configuration, it is required to have a module named BACKEND-DATABASE, with the necessary JDBC driver to access the Runtime's scheduler and session log backend database. If you are using the sample, as this is PostgreSQL, add the PostgreSQL JDBC Driver inside.

3. Edit the Docker Compose file to customize the port and define the environment variables according to your requirements.

4. Configure the Runtime using the configuration files in the shared-resources/properties
   NOTE: these files are already mounted on the image by the sample Docker Compose.
   See Configure the Runtime⁠ for more information about the Runtime configuration.

5. Run the following command from the Docker Compose file location

   $ docker compose -f <your_docker_compose>.yml up

Connect to the Semarchy xDI Runtime from a client (CLI, Semarchy xDI Designer, or Semarchy xDI Analytics) using the HTTP port specified in the Docker Compose and the user/password defined in the configuration file.

⁠Documentation

This Docker Compose creates and starts a complete instance of Semarchy xDI Runtime.

See Semarchy xDI Runtime Documentation⁠ for detailed usage.

⁠Configuration

• Use environment variables for the basic Semarchy xDI Runtime configuration (see the Docker Compose sample file).

• Optionally edit the Semarchy xDI Runtime configuration files in the shared-resources/properties folder to fully customize the configuration.
  NOTE: These files are mounted with the Docker Compose Sample.

  • engineParameters.xml: Configure the Runtime⁠.
  • engineScheduler.properties: Configure the Scheduler⁠.

⁠Logs

Semarchy xDI Runtime logs are redirected to the container logs⁠.

⁠Image Tags

The xdi-runtime images are available with different options, each designed for a specific use case.

⁠xdi-runtime:latest

This image contains the latest version of Semarchy xDI Runtime. See details about Semarchy xDI Architecture⁠.

Important: this is not recommended to use the latest tag in production, as it will automatically upgrade to the latest version that Semarchy is publishing.

⁠xdi-runtime:<minor_version>

This image contains the latest version for a specific minor version of Semarchy xDI Runtime.

For example: semarchy/xdi-runtime:2023.3

Important: this is not recommended to use the minor_version tag in production, as it will automatically upgrade to the latest patch version that Semarchy is publishing.

⁠xdi-runtime:<full_version>

This image contains a specific full version of Semarchy xDI Runtime.

For example: semarchy/xdi-runtime:2023.1.4

⁠License

View license information⁠ for the software contained in this image.