Install Aerospike Elasticsearch connector

Download the installer

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 the protocols for more details.

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.

Installation prerequisites on Linux

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 in Elasticsearch outbound version 1.0.1 and later.

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

Install Java 11 or later, if it is not already installed.

RHEL or CentOS

sudo yum install java-11-openjdk

Debian or Ubuntu

sudo apt-get install openjdk-11-jre

Amazon Linux

sudo dnf install java-11-openjdk

Install connector package

Go to the Aerospike Enterprise downloads site to download the connector package for your platform and install it.

RHEL and CentOS

sudo rpm -i aerospike-elasticsearch-outbound-2.2.15-1.noarch.rpm

Debian/Ubuntu

sudo dpkg -i aerospike-elasticsearch-outbound-2.2.15.all.deb

Amazon Linux

sudo rpm -i aerospike-elasticsearch-outbound-2.2.15-1.noarch.rpm

Verify connector configuration

Verify the connector’s configuration in the /etc/aerospike-elasticsearch-outbound/ directory, and update if necessary. For configuration details, refer to the configuration guide.

Start the connector

The connector package includes a systemd service definition. The installation procedure creates an aerospike-jms-outbound service.

Enable the connector to start on system startup or reboot:

$ sudo systemctl enable aerospike-elasticsearch-outbound

To start the connector service run:

$ sudo systemctl start aerospike-elasticsearch-outbound

Install Elasticsearch outbound connector on Kubernetes with helm-charts

If your deployment situation allows the use of Helm charts, you can install the Elasticsearch outbound connector 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 Elasticsearch outbound connector configuration. The following example includes a basic Elasticsearch outbound connector configuration as part of the Helm installation.

replicaCount: 3

image:
  repository: aerospike/aerospike-elasticsearch-outbound
  tag: "latest"

connectorConfig:
  service:
    address: 0.0.0.0
    port: 8901
    manage:
      address: 0.0.0.0
      port: 8902

  # Aerospike record routing to an Elasticsearch index.
  routing:
    mode: static
    destination: aerospike

  # Document ID configuration.
  doc-id:
    source: digest

  # Elasticsearch client configuration.
  es-client:
    cluster-config:
      type: on-prem
      nodes:
        - host:
            hostname: elasticsearch-node-1
            port: 9200

  # The logging properties.
  logging:
    file: /var/log/aerospike-elasticsearch-outbound/aerospike-elasticsearch-outbound.log
    enable-console-logging: true

connectorSecrets: []

serviceAccount:
  create: true
  name: aerospike-elasticsearch-outbound

Install the Elasticsearch outbound connector by running the following Helm command.

helm install aerospike-elasticsearch-outbound aerospike/aerospike-elasticsearch-outbound --values values.yaml --atomic --wait --debug --create-namespace --namespace aerospike

Deploy on Docker

Aerospike provides Docker images for the Elasticsearch connector on Docker Hub.

sudo docker run \
 -v <path to local aerospike-elasticsearch-outbound.yml>:/etc/aerospike-elasticsearch-outbound/aerospike-elasticsearch-outbound.yml \
 container.aerospike.com/aerospike/aerospike-elasticsearch-outbound:latest

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

Elasticsearch is a trademark of Elasticsearch BV, registered in the U.S. and in other countries.