Deploying a remote harvesting server using a docker-compose file - Cloud

Talend Cloud Data Catalog Administration Guide

English (United States)
Talend Cloud
Talend Data Catalog
Administration and Monitoring
Data Governance
Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your harvesting server and run a single command to create and start it.

Before you begin


  1. Create a YAML file, as follows:
    version: '3' 
            container_name: "<CONTAINER_NAME>"
            image: "<DOCKER_IMAGE:TAG>"
            CLOUD_URL: "<TENANT>.datacatalog.<REGION>"
                AGENT_STRING: "<SHARED_SECRET>"
            restart: "unless-stopped"
    You can define the following key parameters:
    Parameter Action
    CONTAINER_NAME Enter the name of your remote harvesting server.
    DOCKER_IMAGE:TAG Enter talend/datacatalog-remote-harvesting-agent as the Docker image.

    Enter the version name of Talend Cloud Data Catalog build as the tag, such as 8-20200615.

    For example, you can type in talend/datacatalog-remote-harvesting-agent:8-20200615.

    You can find the Talend Cloud Data Catalog versions on

    Enter the URL of Talend Cloud Data Catalog corresponding to your region:
    • AWS Asia Pacific: https://{tenant}
    • AWS Europe: https://{tenant}
    • AWS United States: https://{tenant}

    Where tenant is your company name.

    AGENT_STRING Type in a shared secret set to anything as long it is:
    • unique within this tenant,
    • reasonably descriptive so it can usefully be identified in the UI,
    • hard to guess since it also works as a shared secret string.
  2. Save as a YAML file on your machine.
  3. Open a command prompt or a terminal window and execute docker-compose to verify that Docker Compose is installed.
    For Windows, use PowerShell.
  4. Execute the following command to start Compose and run the container:
    docker-compose -f <filename> up -d
  5. Execute docker ps or go to Docker Desktop and check that the Docker container is running.
    In case of error, check the Compose file.


You are ready to add the remote harvesting server in Talend Cloud Data Catalog.