Deploying a remote harvesting server using a docker-compose file

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

You have been assigned a global role with the Application Administration capability.
You have installed and launched Docker Desktop on your machine. For more information, see https://www.docker.com/products/docker-desktop.
If necessary, you have configured Docker to use a proxy server. For more information, see https://docs.docker.com/network/proxy.

Procedure

Create a YAML file, as follows:

version: '3'

services:
	harvesting_agent:
		container_name: "<CONTAINER_NAME>"
		image: "<DOCKER_IMAGE:TAG>"
		environment:
		CLOUD_URL: "http://<server>:<port>/MM"
			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 Data Catalog build as the tag, such as `8-20211215`. For example, you can type in `talend/datacatalog-remote-harvesting-agent:8-20211215`. You can find the Talend Data Catalog versions on https://hub.docker.com/r/talend/datacatalog-remote-harvesting-agent/tags.
CLOUD_URL	Enter the URL of the Talend Data Catalog application server.
AGENT_STRING	Type in a shared secret set to anything as long it is: unique, reasonably descriptive so it can usefully be identified in the UI, hard to guess since it also works as a shared secret string.

Save as a YAML file on your machine.
Open a command prompt or a terminal window and execute docker-compose to verify that Docker Compose is installed.
For Windows, use PowerShell.
Execute the following command to start Compose and run the container:
```
docker-compose -f <filename> up -d
```
Execute docker ps or go to Docker Desktop and check that the Docker container is running.
In case of error, check the Compose file.

Results

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

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here