Skip to main content

Installing Aerospike Connect -- Aerospike to JMS

Installer

Starting with version 4.0.0, there is a single installer that handles both XDR connector 5.0 wire protocol and HTTP. Go to the Aerospike Enterprise downloads site to download the connector package for your platform and install it.

Remember to set the protocol based on the change notification source. See protocol for details.

Prerequisites

We have tested and verified the connector with:

  • Apache Kafka version 2.0.x or later
  • Confluent Platform 5.0

The connector has not been tested with Apache Kafka 3.0.x or Confluent Platform Platform 7.0.

Aerospike Server change notification configuration

note

Streaming from Aerospike requires you to configure your Aerospike database to send change notifications. For the steps, see Configuring Change Notification for Use with Connectors.

Deploying on Docker

Aerospike provides Docker images for the Aerospike connect for JMS on Docker Hub. Choose the version compatible with your Aerospike database.

sudo docker run -p 8080:8080 -v /home/aerospike/Downloads/aerospike-jms-outbound.yml:/etc/aerospike-jms-outbound/aerospike-jms-outbound.yml aerospike/aerospike-jms-outbound:4.0.0

Installing on Linux

Prerequisites

Supported operating systems

The connector is supported on the following operating systems:

  • RHEL / CentOS 7+
  • Ubuntu 18.04+
  • Ubuntu 20.04+
  • Ubuntu 22.04+
  • Debian 9
  • Debian 10
  • Debian 11

Java Runtime Environment

This connector is a Java web-application that requires Java 8 or later. If you plan to use TLS v1.3, then you must use Java 11 or later. Both Oracle and OpenJDK Java Runtime Environments are supported.

note

Support for Java 8 will be dropped in future releases.

Java 17 is supported since JMS outbound version 3.1.0 and later.

Compatibility with versions of Aerospike Database Enterprise Edition

  • If you are using Aerospike Database Enterprise Edition version 5.6 or later, ensure that you use version 3.0.0 or later of the JMS outbound connector.

  • If you are using Aerospike Database Enterprise Edition version 5.5 or earlier, you may use any version of the JMS outbound connector.

Installation

The installation steps below apply to both the Debian (*.deb) and RHEL (*.rpm) packages. Where there are significant differences between the supported platforms, this will be pointed out.

Install Java 8 or later version

The Aerospike Connect for JMS package does not include a Java runtime environment. Most supported platforms provide official JDK 8 packages. For platforms that do not, Oracle's JDK 8 builds can be obtained from jdk.java.net/8/.

RHEL, CentOS, etc.

sudo yum install java-1.8.0-openjdk

Debian, Ubuntu, etc.

sudo apt-get install openjdk-8-jre

Install connector package

Go to the Aerospike Enterprise downloads site to download the connector package for your platform and install it.

RHEL, CentOS, etc.

sudo rpm -i aerospike-jms-outbound-4.0.0-1.noarch.rpm

Debian, Ubuntu, etc.

sudo rpm -i aerospike-jms-outbound-4.0.0.all.deb

Verify/update connector configuration

The connector's configuration can be found in the /etc/aerospike-jms-outbound/ directory. For details on how to configure the JMS provider, enable TLS, etc., please refer to the configuration guide.

Start the connector

The connector package includes a Systemd service definition. The installation procedure creates an aerospike-jms-outbound service.

Enable the connector to start on system startup or reboot.

$ sudo systemctl enable aerospike-jms-outbound

To start the connector service run.

$ sudo systemctl start aerospike-jms-outbound
Configure Connector