Install Aerospike Connect outbound connector

Installer

Version 3.0.0 and later

Starting with version 3.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. The connector is supported on both amd64 and arm64 architectures.

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

Version 2.2.0 and earlier

The communication protocol between Aerospike Database and the outbound connectors, including Pulsar, has changed for Aerospike 5.0 and later. There are separate Pulsar outbound installers and container images for both these versions.

• aerospike-pulsar-outbound-[version].[package] for Aerospike 5.0 and later
• aerospike-pulsar-outbound-http-[version].[package] for Aerospike prior to 5.0
• aerospike/aerospike-pulsar-outbound:[version]
• aerospike/aerospike-pulsar-outbound-http:[version]

Prerequisites

Aerospike Database 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 Pulsar on Docker Hub. Choose the version compatible with your Aerospike database.

Version 3.0.0 and later

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

Version 2.2.0 and earlier

# With Database 5.0 and later
sudo docker run -p 8080:8080 -v /home/aerospike/Downloads/aerospike-pulsar-outbound.yml:/etc/aerospike-pulsar-outbound/aerospike-pulsar-outbound.yml aerospike/aerospike-pulsar-outbound:2.2.0

# Prior to Database 5.0
sudo docker run -p 8080:8080 -v /home/aerospike/Downloads/aerospike-pulsar-outbound.yml:/etc/aerospike-pulsar-outbound/aerospike-pulsar-outbound.yml aerospike/aerospike-pulsar-outbound-http:2.2.0

Installation prerequisites on Linux

Supported operating systems

The connector is supported on the following operating systems:

• RHEL (8 and 9)
• Ubuntu 20.04
• Ubuntu 22.04
• Ubuntu 24.04 LTS
• Debian 11
• Debian 12

Java Runtime Environment

This connector is a Java web-application that requires Java 11 or later. Both Oracle and OpenJDK Java Runtime Environments are supported.

Java 17 is supported since Pulsar outbound version 2.2.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 2.0.0 or later of the Pulsar outbound connector.

• If you are using Aerospike Database Enterprise Edition version 5.5 or earlier, you may use any version of the Pulsar 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. Multiple instances of the connector are required based on your throughput and latency requirements.

Install Java 11 or later version

The Aerospike Connect for Pulsar package does not include a Java runtime environment. Most supported platforms provide official JDK 11 packages. For platforms that do not, you can get Oracle’s JDK 11 builds from jdk.java.net/11/.

RHEL (8 and 9), CentOS, etc.

sudo yum install java-11-openjdk

Debian, Ubuntu, etc.

sudo apt-get install openjdk-11-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 3.0.0 and later

sudo rpm -i aerospike-pulsar-outbound-3.3.0-1.noarch.rpm

Version 2.2.0 and earlier

# With Database 5.0 and later
sudo rpm -i aerospike-pulsar-outbound-2.2.0-1.noarch.rpm

# Prior to Database 5.0
sudo rpm -i aerospike-pulsar-outbound-http-2.2.0-1.noarch.rpm

Debian, Ubuntu, etc.

Version 3.0.0 and later

sudo rpm -i aerospike-pulsar-outbound-3.3.0.all.deb

Version 2.2.0 and earlier

# With Database 5.0 and later
$ sudo dpkg -i aerospike-pulsar-outbound-2.2.0.all.deb

# Prior to Database 5.0
$ sudo dpkg -i aerospike-pulsar-outbound-http-2.2.0.all.deb

Verify/update connector configuration

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

Start the connector

The connector package includes a systemd service definition. The installation procedure creates an aerospike-pulsar-outbound service.

Enable the connector to start on system startup or reboot:

Version 3.0.0 and later

$ sudo systemctl enable aerospike-pulsar-outbound

Version 2.2.0 and earlier

# With Database 5.0 and later
$ sudo systemctl enable aerospike-pulsar-outbound

# Prior to Database 5.0
$ sudo systemctl enable aerospike-pulsar-outbound-http

To start the connector service run:

Version 3.0.0 and later

$ sudo systemctl start aerospike-pulsar-outbound

Version 2.2.0 and earlier

# With Database 5.0 and later
$ sudo systemctl start aerospike-pulsar-outbound

# Prior to Database 5.0
$ sudo systemctl start aerospike-pulsar-outbound-http