Skip to main content
Aerospike Vector is now live with LangChain integrationTell me more
Loading

Installing Aerospike Connect - ESP Outbound

Connector version 2.0.0 or later​

Starting with connector version 2.0.0, there is a single installer that handles both XDR connector 5.0 wire protocol and HTTP.

  • aerospike-esp-outbound-[version].[package] for Database 5.0 and later
  • aerospike/aerospike-esp-outbound:[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.

Procedures​

You can deploy the ESP outbound connector in three environments:

To deploy in Docker​

  1. Download and install Docker from here.

  2. Pull the image for the ESP outbound connector from Docker Hub.

docker pull aerospike/aerospike-esp-outbound:2.4.0
  1. Create the configuration file aerospike-esp-outbound.yml. You can create this file anywhere in your system. When you run a Docker container in the next step, it mounts the file into the container's file system.

For descriptions of the configuration properties and a sample configuration file, see "Configuring the ESP outbound connector".

  1. Mount the configuration file in the container.
docker run  \
   -v <path to local aerospike-esp-outbound.yml>:/etc/aerospike-esp-outbound/aerospike-esp-outbound.yml \
   aerospike/aerospike-esp-outbound:2.4.0

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

Deploy in Kubernetes​

Configure the ESP outbound connector and apply the configuration with a Kubernetes ConfigMap. In this step you create a folder, create and add files to the folder, and point to this folder when you create a ConfigMap.

  1. Create a folder. The path and name of the directory do not matter.

Example​

mkdir aerospike-esp-outbound
  1. Copy any TLS truststore and keystore files into this directory.

If you plan to use TLS to connect to the destinations of the messages sent by the ESP outbound connector (load balancers or connector instances), copy truststore and keystore files for those connections into this folder, so that the Kubernetes container has access to them.

  1. Create the configuration file aerospike-esp-outbound.yml. You can create this file anywhere in your system. When you run a Docker container in the next step, it mounts the file into the container's file system.

  2. Create the ConfigMap.

kubectl -n <k8s namespace> create configmap aerospike-esp-outbound-config \
   --from-file=<path-and-name-of-directory> --dry-run=client -o yaml | kubectl apply -f -
  • <k8s namespace>: Name of the Kubernetes namespace in which to create the ConfigMap.
  • <path-and-name-of-directory>: Path and name of the directory that contains the configuration file.

If the command runs successfully, it displays a message that it created the ConfigMap:

W0512 09:21:00.039900   12016 helpers.go:557] --dry-run is deprecated and can be replaced with --dry-run=client.
configmap/aerospike-esp-outbound-config created
  1. Deploy the ESP outbound connector in a container.

These steps explain how to run the ESP outbound connector in its own pod. However, you can run the ESP outbound connector as a sidecar to the main container of an Aerospike database being run by the Aerospike Kubernetes Operator.

  1. Create a Kubernetes deployment file.

Here is a sample Kubernetes deployment file named aerospike-esp-outbound-deployment.yml. It deploys of two instances of ESP outbound connector as separate pods. You can run more than one instance of the ESP outbound connector in case one fails, the other continues receiving CN messages from your Aerospike cluster.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: aerospike-esp-outbound
  namespace: aerospike

spec:
  replicas: 2

  selector:
    matchLabels:
      app: aerospike-esp-outbound

  template:
    metadata:
      labels:
        app: aerospike-esp-outbound

    spec:
      volumes:
        - name: aerospike-esp-outbound-config
          configMap:
            name: aerospike-esp-outbound-config

      containers:
        - name: aerospike-esp-outbound
          image: aerospike/aerospike-esp-outbound:2.4.0
          volumeMounts:
            - mountPath: /etc/aerospike-esp-outbound
              name: aerospike-esp-outbound-config
  1. Use the following command to deploy the ESP outbound connector:
kubectl apply -f aerospike-esp-outbound-deployment.yml

Sample output:

deployment.apps/aerospike-esp-outbound created

Installing on Linux​

Prerequisites​

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 ESP version 1.1.0 and later.

The following steps apply to installing both the Debian (*.deb) and RHEL (*.rpm) packages. Significant differences in the steps are noted.

Install Java 11 or later version​

The Aerospike Connect for ESP Outbound 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​

Starting with connector 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. 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-esp-outbound-2.4.0-1.noarch.rpm

Debian, Ubuntu, etc.

$ sudo dpkg -i aerospike-esp-outbound-2.4.0.all.deb

Verify/update connector configuration​

The configuration file for the connector is in /etc/aerospike-esp-outbound/. For details on how to configure the ESP outbound connector and enable TLS, etc., see the Configuration Guide.

Start the connector​

The connector package includes a Systemd service definition. The installation procedure creates an aerospike-esp-outbound service.

Enable the connector to start on system startup or reboot:

$ sudo systemctl enable aerospike-esp-outbound

To start the connector service run:

$ sudo systemctl start aerospike-esp-outbound
Last updated on