OneConnect - Docker Deployment Guide

OneConnect - Docker Deployment Guide

OneConnect – Docker Deployment Guide

This article explains how to deploy OneConnect using Docker on a Linux virtual machine.

1) Prerequisites

Before starting the deployment, make sure you meet the following requirements:

  • Download the compressed files from the oneconnectdocker link
  • A virtual machine with:
    • Linux (e.g., Ubuntu Server or Amazon EC2)
    • Docker
    • Docker Compose
    • dos2unix
  • A Docker Hub account with credentials provided by Onibex:
    • DOCKERHUB_TOKEN
Why these components? They are required to run the environment and project scripts correctly.

2) Project Structure

Inside the dockerdeploy/ folder, you will find:

dockerdeploy/
├── run.sh
├── variables.env
├── docker-compose.yaml
└── otel-collector-config.yaml

3) Initial Setup

  1. Unzip the downloaded package on your VM: 
    unzip oneconnectdocker.zip
  2. Go to the project folder: 
    cd dockerdeploy
  3. Edit the variables.env file to customize your values (you can use nano): 
    nano variables.env

    Save with Ctrl + O, press Enter, then exit with Ctrl + X.

4) Important Parameters

DOCKERHUB_USER
Your Docker Hub username.

DOCKERHUB_TOKEN
The token or password used for authentication.

MYSQL_ROOT_PASSWORD
Password for the database root user.

HOST_MACHINE_IP
Public or private IP address of the server.

PRODUCER_SCALE / CONSUMER_SCALE
Number of instances to scale for the corresponding services.

5) Run the Deployment

Convert line endings with dos2unix

Run the following commands to ensure scripts and env files have Unix line endings:

dos2unix variables.env
dos2unix setup.sh   # if present
dos2unix run.sh     # if present
Make the script executable
chmod +x run.sh
Execute the deployment script
./run.sh

The script will:

  • Load variables from the .env file.
  • Authenticate with Docker Hub.
  • Start all containers defined in docker-compose.yaml.
  • Scale the producer and consumer services as configured.
Docker will pull images and start services. This may take a few minutes depending on network speed and image sizes.

6) Verify the Deployment

After completion, check that all containers are running:

docker ps

You should see the following services:

  • mysql
  • auth
  • apigateway
  • producer
  • consumer
  • frontend
  • emai
  • otel-collector
  • builder
  • cwcback
  • metrics
  • logs
  • loadbalancer
  • eureka

If they appear with status Up, the system is running correctly.

Troubleshooting (Quick Tips)

  • Auth failed on Docker Hub: Re-check DOCKERHUB_USER and DOCKERHUB_TOKEN values in variables.env.
  • Permission denied on scripts: Ensure chmod +x run.sh was applied and that you are executing from the correct directory.
  • Line ending issues: Re-run dos2unix on variables.env and scripts.
  • Port conflicts: Verify no other services are occupying ports defined in docker-compose.yaml.

    • Related Articles

    • Azure - OneConnect Deployment and Configuration

      One Connect Platform: Kubernetes Azure Deployment Manual for Private Network This manual outlines the steps required to deploy the One Connect system on a Kubernetes cluster within a Private Network (meaning the OneConnect Platform will not be ...

    • One Connect Cloud Deployment

      Prerequisites Download the required .zip folders attached at the end of the document: sql.zip one-connect.zip kafka-compose.zip Requirements for the Virtual Machine System: Linux Architecture: 64-bit processors (x86_64) support Instance ...

    • AWS - EKS EC2 One Connect Deployment Manual with Terraform

      This manual provides step-by-step instructions for deploying an Amazon EKS (Elastic Kubernetes Service) cluster using Terraform. It includes the configuration of essential components such as AWS credentials, infrastructure provisioning, EBS CSI ...

    • OneConnect - General Architecture

      The diagram below illustrates the high-level architecture of the OneConnect solution. It depicts SAP ECC or S/4HANA as the data producer, with multiple downstream systems—such as ClickHouse, Snowflake, and Databricks—acting as subscribers. Other ...

    • Azure - One Connect Deployment Prerequisites

      Before you Begin: The following deployment manuals assumes a basic understanding of Kubernetes concepts. For more information, refer to Kubernetes core concepts for Azure Kubernetes Service (AKS). Before you begin: If you don't have an Azure account, ...