Skip to main content
GIFRÖST / Compare / Connections / Agent

Install and connect a Compare agent.

Download Gifrost Database Compare Agent, install it close to the source database, and add it to Agent Store. The guided process finishes by checking that the agent is connected and ready to accept work from Compare 2.0.

PlatformsDocker, Linux, Windows, and macOS.
AuthorizationA time-limited token links the agent with Compare.
Simple setupThe installer prepares the agent environment automatically.
CompletionA health check confirms that the agent is ready.

Before you begin​

Install the agent on a computer or server located close to the source database. For Docker, use a server that can access both the database and Kafka.

One guided process, two installation paths

Linux, Windows, and macOS Download the selected installer and complete the installation form before adding the agent to Agent Store.

Docker Download the package and use the command provided in the additional Run step.

Download the agent​

1. Select the system​

Choose Docker, Linux, Windows, or macOS.

Operating-system selection in the Install agent dialog

Select the operating system on which the agent will run.

2. Generate the token​

Select how long the token should remain valid: 7, 30, 90, or 365 days. Generate the token and copy it.

Compare automatically uses this token when the agent is added to Agent Store.

Agent token generation step in the Install agent dialog

Choose the token validity period and generate the agent token.

3. Select and download the version​

When the Download step opens, Compare lists the versions available for the selected system. Each option shows the version, release date, and file name.

Select the required version and click Download.

Agent version selection and Download action

Select an available agent version and download its installation package.

4. Start the agent​

Docker displays an additional Run step. Copy the command provided by Compare and run it on the server that has access to the database and Kafka.

Docker Run step with the generated agent command

Copy and run the command prepared for the downloaded Docker package.

5. Enter the agent details​

Continue to the Agent Store step and complete:

  • Agent name;
  • Related credential name;
  • Host;
  • Port.

Click Add agent.

Form for adding the deployed agent to Agent Store

Enter the agent name, related credential, host, and port.

6. Confirm that the agent is ready​

Compare automatically checks whether it can connect to the agent.

ConnectedThe agent is ready

A green check confirms that the agent is connected and ready to accept work.

Connection failedReview the message and retry

A red X and the full error message explain that the check failed. Select Retry health check to run the same check again.

Successful agent health check

A successful health check confirms that the agent is connected and ready to use.

Run the installer​

The installer steps below apply to Linux, Windows, and macOS. Docker users do not need to complete this section.

1. Open Gifrost Database Compare Agent​

Launch the downloaded installer.

Gifrost Database Compare Agent installer welcome screen

Open the Gifrost Database Compare Agent installer.

2. Choose the installation location​

Select the directory where the agent, its configuration, and its logs will be stored.

If an agent already exists in that directory, the installer automatically switches to update mode. It recognizes the previous version and loads the existing values, so the product does not need to be configured again.

Agent installation directory selection

Select the directory in which the agent will be installed.

3. Confirm the operating settings​

Provide the three values used during normal agent operation:

  • Port — 6667 by default. This is the point through which Compare 2.0 contacts the agent.
  • File results directory — the location used when a task returns its result as files.
  • Streaming results directory — a temporary location for results prepared for collection by Compare 2.0.

During an update, the form is filled with the existing values.

Agent configuration with communication port and result directories

Confirm the communication port and the file and streaming result directories.

4. Start the installation or update​

Select Install for a new agent or Update when an existing installation was detected. The installer completes the process automatically and displays its progress.

The installer prepares the agent's complete working environment and saves its operating settings. During an update, it also preserves the remaining settings that it does not manage directly.

Gifrost Database Compare Agent installation progress

Wait while the installer prepares the agent and its working environment.

Sensitive access details are not stored during installation

The installer does not ask for database sign-in details, Kafka configuration, private keys, or permanent access tokens. Compare 2.0 provides the information required for a specific task only when that task is assigned to the agent.

5. Review the installation result​

The final screen shows:

  • whether the process succeeded or failed;
  • the port in use;
  • the address used to check the agent's status;
  • an action for running the readiness test again.
Successful agent installation result with health-check action

Review the installation result and the available health-check action.