Install the XDR Proxy

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 XDR Proxy on Docker Hub.

sudo docker run \
 -v <path to local aerospike-xdr-proxy.yml>:/etc/aerospike-xdr-proxy/aerospike-xdr-proxy.yml \
 container.aerospike.com/aerospike/aerospike-xdr-proxy:3.2.11

<path to local aerospike-xdr-proxy.yml>: The path (including the name) of the configuration file in your local filesystem.

Installing on Linux

Prerequisites

Supported operating systems

The connector is supported on the following operating systems:

• RHEL/CentOS (8 and 9)
• Ubuntu (20.04, 22.04 and 24.04 LTS)
• Debian (11, 12 and 13)
• Amazon Linux 2023

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 with XDR Proxy versions 1.2.0 and higher.

Installation

The following installation steps apply to both the Debian (*.deb) and RHEL (*.rpm) packages. We point out any significant differences between the supported platforms.

Install Java 11 or later version

The XDR Proxy 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, CentOS, etc.

$ sudo yum install java-11-openjdk

Debian, Ubuntu, etc.

$ sudo apt-get install openjdk-11-jre

Amazon Linux etc.

sudo dnf install java-11-openjdk

Install connector package

RHEL, CentOS, etc.

sudo rpm -i aerospike-xdr-proxy-3.2.11-1.noarch.rpm

Debian, Ubuntu, etc.

sudo dpkg -i aerospike-xdr-proxy-3.2.11.all.deb

Amazon Linux, etc.

sudo rpm -i aerospike-xdr-proxy-3.2.11-1.noarch.rpm

Verify connector configuration

The configuration file for the connector is in /etc/aerospike-xdr-proxy/. Update it if necessary. For details on how to configure the connector, see the Configuration Guide.

Start the connector

The connector package includes a systemd service definition. The installation procedure creates an aerospike-xdr-proxy service.

Enable the connector to start on system startup or reboot:

$ sudo systemctl enable aerospike-xdr-proxy

To start the connector service run:

$ sudo systemctl start aerospike-xdr-proxy

Configure Connector