Install with an Existing Kafka Cluster

On this page

Before you Begin

Steps
Next Steps
Learn More

You can install Relational Migrator on an existing Kafka cluster including Kafka Connect. This installation method is ideal if you are already running Kafka or you have your own approach to installing and configuring Kafka.

Before you Begin

You must have Kafka and network connectivity to the Kafka Connect cluster from the computer running Relational Migrator.

Steps

Install Debezium Source Connect Plugin

Download the source connector archive for your source database:
Unzip the archive.
Copy the debezium-connector.jar file to the debezium-connector directory.
From the downloaded archive, copy the debezium-connector.jar file to the debezium-connector-xxx directory at Kafka Connect’s plugin.path on your Kafka Connect cluster. For example: /kafka/connect/debezium-connector-sqlserver.
Restart your Kafka Connect cluster.
When the plugin is successfully registered, the following log statement appears in the kafka-connect start up logs:
```
INFO || Added plugin 'io.debezium.connector.sqlserver.SqlServerConnector'
```

Install the Relational Migrator Sink Connect Plugin

Download the latest version of the kafka-connect-migrator.jar file.
To download the latest kafka-connect-migrator.jar file, see the Migrator Installer Repository.
Copy the .jar file to the kafka-connect-migrator directory.
The new kafka-connect-migrator directory is found at Kafka Connect’s plugin.path. For example: /kafka/connect/kafka-connect-migrator.
Restart your Kafka Connect cluster.
When the plugin is successfully registered, the following log statement appears in the kafka-connect start up logs:
```
INFO || Added plugin 'com.mongodb.migrator.kafka.connect.MigratorSinkConnector'
```

Install Relational Migrator

From the download center, select the latest version of the Relational Migrator installer.

Run Relational Migrator in kafka-integrated mode

To run in kafka-integrated mode, update the following configurations in your user.properties file.

Your user.properties file is located in an OS specific location. For more information, see Relational Migrator File Locations.

Property Name	Default	Description
`spring.profiles.active`	local	Relational Migrator can be run in the following profile: `kafka`: Remote server using embedded server deployment. `confluent`: Remote server using Confluent Cloud for managed Kafka Set the profile value to `kafka`.
`server.port`	8278	The port the Relation Migrator application runs on.
`migrator.kafka.bootstrap.servers`	No default	This is a list of `host:port` pairs of your pre-existing kafka cluster. For more information, see Worker Configuration Properties.
`migrator.kafka.connect.url`	No default	The Kafka Connect host url using the `{host}:{port}` format.
`migrator.kafka.connect.metrics.jmx.service.url`	No default	The Kafka Connect Java Management Extensions (JMX) url. For example: `service:jmx:rmi:///jndi/rmi://localhost:9876/jmxrmi`

Confirm successful installation

Start Relational Migrator and check the logs. Confirm that the Kafka profile is active and that there are no errors.

Your log file is located in an OS specific location. For more information, see Relational Migrator File Locations.

Next Steps

Learn More

Back

Integrate with Kafka

Use Containerized Cluster with Docker