---
title: "Install Aerospike Elasticsearch connector"
description: "Guide to installing the Aerospike Elasticsearch connector via Docker, Linux packages (.deb/.rpm), or Helm charts."
---

# Install Aerospike Elasticsearch connector

> For the complete documentation index see: [llms.txt](https://aerospike.com/docs/llms.txt)
> 
> All documentation pages available in markdown.

## Download the installer

Go to the [Aerospike Enterprise downloads](https://aerospike.com/download/connector/elastic/) 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](https://aerospike.com/docs/connectors/elasticsearch/configure/service/#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](https://aerospike.com/docs/connectors/streaming/common/change-notification).

## 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 17 or later. Both Oracle and OpenJDK Java Runtime Environments are supported.

This connector requires Java 17 or later starting with version 3.0.1.

## 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 17 or later, if it is not already installed.

RHEL or CentOS

Terminal window

```shell
sudo yum install java-17-openjdk
```

Debian or Ubuntu

Terminal window

```shell
sudo apt-get install openjdk-17-jre
```

Amazon Linux

Terminal window

```shell
sudo dnf install java-17-openjdk
```

### Install connector package

Go to the [Aerospike Enterprise downloads](https://aerospike.com/download/connector/elastic/) site to download the connector package for your platform and install it.

#### **RHEL and CentOS**

Terminal window

```shell
sudo rpm -i aerospike-elasticsearch-outbound-3.0.1-1.noarch.rpm
```

#### Debian/Ubuntu

Terminal window

```shell
sudo dpkg -i aerospike-elasticsearch-outbound-3.0.1.all.deb
```

#### Amazon Linux

Terminal window

```shell
sudo rpm -i aerospike-elasticsearch-outbound-3.0.1-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](https://aerospike.com/docs/connectors/elasticsearch/configure).

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

Terminal window

```shell
$ sudo systemctl enable aerospike-elasticsearch-outbound
```

To start the connector service run:

Terminal window

```shell
$ 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.

1.  Add the Aerospike Helm repository.
    
    Terminal window
    
    ```bash
    helm repo add aerospike https://aerospike.github.io/helm-charts --force-update
    
    helm repo update
    ```
    
2.  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.
    
    values.yaml
    
    ```yaml
    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
    ```
    
3.  Install the Elasticsearch outbound connector by running the following Helm command.
    
    Terminal window
    
    ```bash
    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.

Terminal window

```shell
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._