Install the Aerospike XDR Proxy
Download the installerโ
- Version 2.0.0 and later
- Version 1.2.0 and earlier
Starting with version 2.0.0
, a single installer 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. 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.
The communication protocol between Aerospike Database and the outbound connectors, including XDR Proxy, has changed for Aerospike 5.0 and later. Each version has it's own XDR Proxy installers and container images.
- aerospike-xdr-proxy-[version].[package] for Aerospike 5.0 and later.
- aerospike-xdr-proxy-http-[version].[package] for Aerospike prior to 5.0.
- aerospike/aerospike-xdr-proxy:[version]
- aerospike/aerospike-xdr-proxy-http:[version]
Prerequisitesโ
Aerospike Database 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 XDR Proxy on Docker Hub. Choose the version compatible with your Aerospike database.
- Version 2.0.0 and later
- Version 1.2.0 and earlier
sudo docker run -p 8901:8901 -v /home/aerospike/Downloads/aerospike-xdr-proxy.yml:/etc/aerospike-xdr-proxy/aerospike-xdr-proxy.yml aerospike/aerospike-xdr-proxy:3.2.0
# With Database 5.0.0.0 and later
sudo docker run -p 8901:8901 -v /home/aerospike/Downloads/aerospike-xdr-proxy.yml:/etc/aerospike-xdr-proxy/aerospike-xdr-proxy.yml aerospike/aerospike-xdr-proxy:1.2.0
# Prior to Database 5.0.0.0
sudo docker run -p 8901:8901 -v /home/aerospike/Downloads/aerospike-xdr-proxy.yml:/etc/aerospike-xdr-proxy/aerospike-xdr-proxy.yml aerospike/aerospike-xdr-proxy-http:1.2.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
- 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 Runtime Environmentโ
Java 17 is supported with XDR Proxy versions 1.2.0 and higher.
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 1.1.0 or later of the XDR Proxy connector.
If you are using Aerospike Database Enterprise Edition version 5.5 or earlier, you may use any version of the XDR Proxy connector.
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
Install connector packageโ
- Version 2.0.0 and later
- Version 1.2.0 and earlier
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.
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
RHEL, CentOS, etc.
$ sudo rpm -i aerospike-xdr-proxy-3.2.0-1.noarch.rpm
Debian, Ubuntu, etc.
$ sudo dpkg -i aerospike-xdr-proxy-3.2.0.all.deb
Go to the Aerospike Enterprise downloads site to download the connector package for your platform.
RHEL, CentOS, etc.
# 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.
# 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 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:
- Version 2.0.0 and later
- Version 1.2.0 and earlier
Version 2.0.0 or laterโ
$ sudo systemctl enable aerospike-xdr-proxy
# 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 and later
- Version 1.2.0 and earlier
$ sudo systemctl start aerospike-xdr-proxy
# 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