Managing Dataedo components with Docker Compose

This guide provides an overview of the docker-compose.yml file used for Dataedo deployments in Docker and explains how to manage individual components and start selected components separately.

Prerequisites

Before starting, ensure that you have:

• Docker and Docker Compose installed and ready to use.
• Git installed.
• Access to a terminal or command prompt.

Clone Docker Compose files

Let's start by cloning the necessary deployment files. In this example, we will clone a environment that includes Dataedo Portal, Dataedo Agent and SQL Server.

git clone --single-branch --branch with-agent-and-sql https://gitlab.com/dataedo/docker-compose.git dataedo

useful tip

Other deployments options are described here.

The repository includes the following files:

• docker-compose.yml — the main configuration file for all Dataedo components
• .env — a file containing environment variables

Move into the newly created folder:

cd dataedo

Docker Compose overview

The following section provides an overview of the docker-compose.yml file, which defines all required Dataedo components and their configurations.

To preview the contents of the docker-compose.yml file, use the cat command:

cat docker-compose.yml

The command outputs content similar to the following:

docker-compose.yml

    services:
      frontend: # Dataedo Portal frontend container
        image: dataedo/web_ui:25.3.3
        restart: always
        # ... other configuration
      
      backend: # Dataedo Portal backend container
        image: dataedo/web_api:25.3.3
        platform: linux/amd64
        # ... other configuration

      agent: # Dataedo Agent container
        image: dataedo/web_agent:25.3.3
        restart: always
        # ... other configuration

      sql_server: # SQL Server container
        container_name: sql-server
        image: mcr.microsoft.com/mssql/server:2022-latest
        # ... other configuration
                
    networks:
      overlay:
    
    volumes:
      sql_data: # Docker volume for the SQL Server container

As we can se above this deployment contains a four components and one persistent volume:

• frontend - Dataedo Portal frontend container
• backend- Dataedo Portal backend container
• agent - Dataedo Agent container
• sql_server - SQL Server container plus corresponding data volume (sql_data)

Running a Specific Dataedo Component (Dataedo Agent Example)

In this section, we describe how to run a specific component - the Dataedo Agent - by editing the docker-compose.yml and .env files.

useful tip

This approach is particularly useful when a user or team wants to deploy a specific component, such as the Dataedo Agent, on a separate server.

Open the docker-compose.yml file with your preferred text editor, such as Nano:

nano docker-compose.yml

Comment out services you don't need by adding # at the beginning of each line, or remove them entirely. If a service such as SQL Server has a corresponding volume, make sure to comment out the volume as well.

The example below shows a version of the docker-compose.yml that includes only the Dataedo Agent:

docker-compose.yml

    services:      
      agent: # Dataedo Agent container
        image: dataedo/web_agent:25.3.3
        restart: always
        platform: linux/amd64
        networks:
          - overlay
        env_file:
          - ./.env

    networks:
      overlay:

Save the changes. In Nano, you can do this by pressing Ctrl + X, then Y, and Enter.

Next, configure the .env file with your repository details before starting Dataedo Agent, then save your changes.

useful tip

For more information about the Docker variables in the .env file, please click here.

Start the environment:

docker compose up -d

Verify if the container is running correctly:

docker compose ps

Need help?

If you run into any problems or have questions, reach out to Dataedo support.