---
title: "Install the Aerospike Pulsar Outbound Connector"
description: "Guide to installing the Aerospike Pulsar Outbound Connector on Linux, Kubernetes via Helm, and using Docker."
---

# Install the Aerospike Pulsar Outbound Connector

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

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

Java 17 is supported since Pulsar outbound version 2.2.0 and later.

## Installation

The installation steps below apply to both the Debian (\*.deb) and RHEL (\*.rpm) packages. Where there are significant differences between the supported platforms, this will be pointed out. **Multiple instances of the connector are required based on your throughput and latency requirements.**

### Install Java 11 or later version

The Aerospike Connect for Pulsar 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/](https://jdk.java.net/11/).

**RHEL and CentOS**

Terminal window

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

**Debian and Ubuntu**

Terminal window

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

**Amazon Linux**

Terminal window

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

#### Install connector package

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

**RHEL and CentOS**

Terminal window

```shell
sudo rpm -i aerospike-pulsar-outbound-3.3.19-1.noarch.rpm
```

**Debian and Ubuntu**

Terminal window

```shell
sudo dpkg -i aerospike-pulsar-outbound-3.3.19.all.deb
```

**Amazon Linux**

Terminal window

```shell
sudo rpm -i aerospike-pulsar-outbound-3.3.19-1.noarch.rpm
```

### Verify/update connector configuration

The connector’s configuration can be found in the `/etc/aerospike-pulsar-outbound/` directory. For details on how to configure the Pulsar provider, enable TLS, etc., refer to the [configuration guide](https://aerospike.com/docs/connectors/streaming/pulsar/outbound/configure/).

### Start the connector

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

Enable the connector to start on system startup or reboot:

Terminal window

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

To start the connector service run:

Terminal window

```shell
$ sudo systemctl start aerospike-pulsar-outbound
```

## Install Pulsar outbound connector on Kubernetes with helm-charts

If your deployment situation allows the use of Helm charts, you can install the Pulsar 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 Pulsar outbound connector configuration. The following example includes a basic Pulsar outbound connector configuration as part of the Helm installation.
    
    values.yaml
    
    ```yaml
    replicaCount: 3
    
    image:
    
      repository: aerospike/aerospike-pulsar-outbound
    
      tag: "latest"
    
    connectorConfig:
    
      service:
    
        port: 8080
    
        manage:
    
          port: 8081
    
      # Pulsar connector client configuration.
    
      client-configuration:
    
        serviceUrl: pulsar://localhost:6650
    
      # Format of the Pulsar destination message.
    
      format:
    
        mode: flat-json
    
        metadata-key: metadata
    
      # Aerospike record routing to a Pulsar destination.
    
      routing:
    
        mode: static
    
        destination: aerospike
    
      # The logging properties.
    
      logging:
    
        enable-console-logging: true
    
    connectorSecrets: []
    
    serviceAccount:
    
      create: true
    
      name: aerospike-pulsar-outbound
    ```
    
3.  Install the Pulsar outbound connector by running the following Helm command.
    
    Terminal window
    
    ```bash
    helm install aerospike-pulsar-outbound aerospike/aerospike-pulsar-outbound --values values.yaml --atomic --wait --debug --create-namespace --namespace aerospike
    ```
    

## Deploying on Docker

Aerospike provides Docker images for the Aerospike Pulsar outbound connector on Docker Hub.

Before running the Docker container, create a local `aerospike-pulsar-outbound.yml` configuration file. You can use the default configuration file included in the `.deb` or `.rpm` package (installed to `/etc/aerospike-pulsar-outbound/aerospike-pulsar-outbound.yml`) as a starting point, or refer to the [configuration guide](https://aerospike.com/docs/connectors/streaming/pulsar/outbound/configure/) to create one from scratch.

Terminal window

```shell
sudo docker run \

 -v <path to local aerospike-pulsar-outbound.yml>:/etc/aerospike-pulsar-outbound/aerospike-pulsar-outbound.yml \

 container.aerospike.com/aerospike/aerospike-pulsar-outbound:latest
```

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