Skip to main content

Install the Aerospike XDR Proxy

Prerequisites

Java Runtime Environment

The XDR-Proxy is a Java web application requiring Java 8 or later versions. Java 11 or later version is required if TLSv1.3 is desired. Both Oracle and OpenJDK Java Runtime Environments are supported.

Java 17 is supported with XDR-Proxy versions 1.2.0 and higher.

note

Support for Java 8 will be dropped in future releases.

Supported Platforms

The connector has been tested on and supports the following platforms:

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

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 XDR-Proxy 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

Version 2.0.0 or higher

Starting with version 2.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

Version less than 2.0.0

Go to the Aerospike Enterprise downloads site to download the connector package for your platform and install it. Use the xdr-proxy-http for the Aerospike enterprise server version < 5.0 and the xdr-proxy otherwise.

RHEL, CentOS, etc.

Version 2.0.0 or higher

$ sudo rpm -i aerospike-xdr-proxy-2.1.0-1.noarch.rpm

Version less than 2.0.0

# With Aerospike 5.0 and later
$ sudo rpm -i aerospike-xdr-proxy-1.2.0-1.noarch.rpm
# With Aerospike prior to 5.0
$ sudo rpm -i aerospike-xdr-proxy-http-1.2.0-1.noarch.rpm

Debian, Ubuntu, etc.

Version 2.0.0 or higher

$ sudo dpkg -i aerospike-xdr-proxy-2.1.0.all.deb

Version less than 2.0.0

# With Aerospike 5.0 and later
$ sudo dpkg -i aerospike-xdr-proxy-1.2.0.all.deb
# With Aerospike prior to 5.0
$ sudo dpkg -i aerospike-xdr-proxy-http-1.2.0.all.deb

Verify/update connector configuration

The configuration file for the connector is in /etc/aerospike-xdr-proxy/. 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.

Version 2.0.0 or higher

$ sudo systemctl enable aerospike-xdr-proxy

Version less than 2.0.0

# With Aerospike 5.0 and later
$ sudo systemctl enable aerospike-xdr-proxy
# With Aerospike prior to 5.0
$ sudo systemctl enable aerospike-xdr-proxy-http

To start the connector service run.

Version 2.0.0 or higher

$ sudo systemctl start aerospike-xdr-proxy

Version less than 2.0.0

# With Aerospike 5.0 and later
$ sudo systemctl start aerospike-xdr-proxy
# With Aerospike prior to 5.0
$ sudo systemctl start aerospike-xdr-proxy-http
Configure Connector