The installation procedure described in this section has been tested on Debian and Ubuntu 64-bit distributions.
As mentioned in the Requirements section, you need a running Kafka cluster 0.11 or later.
If you don’t have already a deployment of Apache Kafka cluster, you can deploy Kafka as follows. Get the tarball binary package of Kafka from the Kafka downloads page, unzip the tarball to any folder, change to that folder, and run the following commands:
bin/zookeeper-server-start.sh config/zookeeper.properties bin/kafka-server-start.sh config/server.properties
This will deploy a cluster of one instance of Apache Kafka which will listen for client connections on
As mentioned in the Requirements section, the Java Runtime Environment (JRE) version 8 is required for MigratoryData KE. To install the JRE version 8 of OpenJDK, run as root:
apt-get install openjdk-8-jre-headless
Validate your installation with the following command:
The output should be something like:
openjdk version "1.8.0_212" OpenJDK Runtime Environment (build 1.8.0_212-b04) OpenJDK 64-Bit Server VM (build 25.212-b04, mixed mode)
As mentioned in the Requirements section, the OpenSSL and APR libraries are required to enable the native TLS/SSL communication. To install these libraries, run as root:
apt-get install libapr1 openssl
Download the DEB package of MigratoryData KE and run as
root the following to install it:
dpkg -i migratorydata-ke-Version-Architecture.deb
This will deploy MigratoryData KE as follows:
||Default config file|
||Default system config file|
||Default config for Kafka consumers|
||Default config for Kafka producers|
||Folder where the logs will reside|
||Object code of MigratoryData KE|
||Folder where plugins reside|
||Systemd unit file|
||Folder where docs & license reside|
Please refer to Configuration Guide to learn how to customize the default configuration file, the default system configuration file, as well as the default configuration files for Kafka consumers and producers.
The service will start automatically after the installation. To manually start, stop, restart, or get the
status of the MigratoryData KE service, run as
root one of the following commands:
systemctl start migratorydata-ke systemctl stop migratorydata-ke systemctl restart migratorydata-ke systemctl status migratorydata-ke
To test the installation, start a web browser on the machine where MigratoryData KE has been installed and open the following URL:
This will open the home page of MigratoryData KE which contains docs and demos.
push.example.comand the port
8800is not blocked by the firewall, you can remotely test the installation by opening the following URL from a remote machine:
Build Realtime Apps
The next step is to build realtime apps with your preferred programming languages to communicate with your MigratoryData KE installation. Please refer to the documentation of the client SDKs provided by MigratoryData for your preferred programming languages.
To upgrade MigratoryData KE to a newer version, run as
root the following command:
dpkg -i migratorydata-ke-NewVersion-Architecture.deb
.dpkg-distif it differs from the default configuration of the installed version.
To remove MigratoryData KE from your system, run as
root the following command:
dpkg --purge migratorydata-ke