Install the XDR Proxy

This page explains how to install and start the Aerospike XDR Proxy using Docker or native Linux packages. It covers prerequisites, supported platforms, and the steps required to deploy the proxy and prepare it for configuration.

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 and CentOS

$ sudo yum install java-11-openjdk

Debian and Ubuntu

$ sudo apt-get install openjdk-11-jre

Amazon Linux

sudo dnf install java-11-openjdk

Install connector package

RHEL and CentOS

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

Debian and Ubuntu

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

Amazon Linux

sudo rpm -i aerospike-xdr-proxy-3.2.14-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

Install XDR Proxy on Kubernetes with helm-charts

If your deployment situation allows the use of Helm charts, you can install the XDR Proxy on a Kubernetes deployment using Helm.

Add the Aerospike Helm repository.

helm repo add aerospike https://aerospike.github.io/helm-charts --force-update
helm repo update

Create the file values.yaml with your XDR Proxy configuration. The following example includes a basic XDR Proxy configuration as part of the Helm installation.

replicaCount: 3

image:
  repository: aerospike/aerospike-xdr-proxy
  tag: "latest"

proxyConfig:
  service:
    port: 8901
    socket-receive-buffer-bytes: 131072
    protocol: HTTP_2
    manage:
      address: 0.0.0.0
      port: 8902

  aerospike:
    seeds:
      - aerocluster.aerospike:
          port: 3000
    performance:
      max-connections-per-node: 100
      event-loop-size: 15

  logging:
    enable-console-logging: true
    file: /var/log/aerospike-xdr-proxy/aerospike-xdr-proxy.log
    ticker-interval: 1

proxySecrets: []

serviceAccount:
  create: true
  name: aerospike-xdr-proxy

Install the XDR Proxy by running the following Helm command.

helm install aerospike-xdr-proxy aerospike/aerospike-xdr-proxy --values values.yaml --atomic --wait --debug --create-namespace --namespace aerospike

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:latest

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

Configure Connector