Installing Aerospike Connect -- Aerospike to JMS
Installer
- Version 4.0.0 and later
- Version 3.1.0 and earlier
Starting with version 4.0.0
, a single installer handles both XDR connector 5.0 wire protocol and HTTP.
Go to the Aerospike Enterprise downloads
site to download and install the connector package for your platform.
Remember to set the protocol
based on the change notification source. See
protocol for details.
The communication protocol between Aerospike Database and the outbound connectors, including JMS, has changed for Aerospike 5.0 and later. Both versions have separate JMS outbound installers and container images.
- aerospike-jms-outbound-[version].[package] for Aerospike 5.0 and later.
- aerospike-jms-outbound-http-[version].[package] for Aerospike prior to 5.0.
- aerospike/aerospike-jms-outbound:[version]
- aerospike/aerospike-jms-outbound-http:[version]
Prerequisites
Aerospike Server change notification configuration
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.
- Version 4.0.0 and later
- Version 3.1.0 and earlier
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
# With Aerospike server versions 5.0.0.0 and later
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:3.1.0
# With Aerospike server versions before 5.0.0.0
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-http:3.1.0
Installing on Linux
Prerequisites
Supported operating systems
The connector is supported on the following operating systems:
- RHEL (8 and 9) / CentOS 7+
- Ubuntu 20.04+
- Ubuntu 22.04+
- Debian 10 (only on x86_64 hardware)
- 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.
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
- Version 4.0.0 and later
- Version 3.1.0 and earlier
Install Java 11 or later, if it is not already installed.
RHEL or CentOS
sudo yum install java-11-openjdk
Debian or Ubuntu
sudo apt-get install openjdk-11-jre
Install Java 8 or later, if it is not already installed.
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 (8 and 9), CentOS, etc.
- Version 4.0.0 and later
- Version 3.1.0 and earlier
sudo rpm -i aerospike-jms-outbound-4.0.0-1.noarch.rpm
# With Aerospike server versions 5.0.0.0 and later
sudo rpm -i aerospike-jms-outbound-3.1.0-1.noarch.rpm
# With Aerospike server versions before 5.0.0.0
sudo rpm -i aerospike-jms-outbound-http-3.1.0-1.noarch.rpm
Debian, Ubuntu, etc.
- Version 4.0.0 and later
- Version 3.1.0 and earlier
sudo rpm -i aerospike-jms-outbound-4.0.0.all.deb
# With Aerospike server versions 5.0.0.0 and later
$ sudo dpkg -i aerospike-jms-outbound-3.1.0.all.deb
# With Aerospike server versions before 5.0.0.0
$ sudo dpkg -i aerospike-jms-outbound-http-3.1.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.
- Version 4.0.0 and later
- Version 3.1.0 and earlier
$ sudo systemctl enable aerospike-jms-outbound
# With Aerospike server versions 5.0.0.0 and later
$ sudo systemctl enable aerospike-jms-outbound
# With Aerospike server versions before 5.0.0.0
$ sudo systemctl enable aerospike-jms-outbound-http
To start the connector service run.
- Version 4.0.0 and later
- Version 3.1.0 and earlier
$ sudo systemctl start aerospike-jms-outbound
# With Aerospike server versions 5.0.0.0 and later
$ sudo systemctl start aerospike-jms-outbound
# With Aerospike server versions before 5.0.0.0
$ sudo systemctl start aerospike-jms-outbound-http