aerospike-jms-outbound

Aerospike JMS Outbound Connector

This Helm chart allows you to configure and run our official Aerospike JMS Outbound Connector docker image on a Kubernetes cluster.

This helm chart sets up a StatefulSet for each connector deployment. We use a StatefulSet instead of a Deployment, to have stable DNS names for the
deployed connector pods.

NOTE: The helm chart appends -aerospike-jms-outbound suffix to all created Kubernetes resources to prevent name clashes with other applications.

Prerequisites

• Kubernetes cluster
• Helm v3
• A JMS cluster with brokers reachable from the pods in the Kubernetes cluster
• An Aerospike cluster that can connect to Pods in the Kubernetes cluster. The Aerospike cluster can be deployed in the same Kubernetes cluster using Aerospike Kubernetes Operator

Adding the helm chart repository

Add the aerospike helm repository if not already done

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

Supported configuration

Configuration

Parameter	Description	Default
replicaCount	Configures the number Aerospike JMS connector pods to run.	'1'
image	Configures Aerospike JMS connector image repository, tag and pull policy.	see values.yaml
connectorConfig	Connector configuration deployed to /etc/aerospike-jms-outbound/aerospike-jms-outbound.yml.	see values.yaml
connectorSecrets	List of secrets mounted to /etc/aerospike-jms-outbound/secrets for each connector pod.	[]
initContainers	List of initContainers added to each connector pods for custom code plugin jars.	[]
serviceAccount	Service Account details like name and annotations.	see values.yaml
podAnnotations	Additional pod annotations. Should be specified as a map of annotation names to annotation values.	{}
podSecurityContext	Pod security context	{}
securityContext	Container security context	{}
resources	Resource requests and limits for the connector pods.	{}
autoscaling	Enable the horizontal pod auto-scaler.	see values.yaml
affinity	Affinity rules if any for the pods.	{}
nodeSelector	Node selector for the pods.	{}
tolerations	Tolerations for the pods.	{}

Deploy the connectors

We recommend creating a new .yaml for providing configuration values to the helm chart for deployment. See the examples folder for examples.

A sample values yaml file is shown below:

replicaCount: 3

image:
  tag: "4.2.5"

connectorConfig:
  service:
    # TLS setup for communication between Aerospike server (XDR) and the
    # connector.
    # Use the TLS certificates and keys specific to your setup.
    # See: https://docs.aerospike.com/connect/jms/from-asdb/configuring/service#configuring-tls
    port: 8080

    manage:
      port: 8081

  # See: https://docs.aerospike.com/connect/jms/from-asdb/configuring/jms
  # The connection properties for the JMS message broker.
  jms:
    #  # RabbitMQ example.
    factory: com.rabbitmq.jms.admin.RMQConnectionFactory
    config:
      host: rabbitmq.rabbitmq-system
      port: 5672
      username: guest
      password: guest

  #  # ActiveMQ example.
  #  factory: org.apache.activemq.artemis.jndi.ActiveMQInitialContextFactory
  #  jndi-cf-name: ConnectionFactory
  #  config:
  #    java.naming.provider.url: tcp://127.0.0.1:61616
  #    java.naming.security.principal: admin
  #    java.naming.security.credentials: password

  #  # IBM MQ example.
  #  factory: com.ibm.mq.jms.MQConnectionFactory
  #  config:
  #    hostName: 127.0.0.1
  #    port: 1414
  #    queueManager: QM1
  #    transportType: 1
  #    channel: DEV.APP.SVRCONN

  # Format of the JMS destination message.
  format:
    mode: flat-json
    metadata-key: metadata

  # Aerospike record routing to a JMS destination.
  routing:
    mode: static
    type: queue
    destination: aerospike  # <---- Change this to the name of the JMS destination.

  # The logging properties.
  logging:
    enable-console-logging: true

Here replicaCount is the count of connectors pods that are deployed. The connector configuration is provided as yaml under the key connectorConfig. See Aerospike JMS Outbound configuration for details.

Update the jms configuration to point to your JMS Provider.

We recommend naming the file with the name of the connector cluster. For example if you want to name your connector cluster as as-jms-outbound, create a file as-jms-outbound-values.yaml. Once you have created this custom values file, deploy the connectors, using the following command.

Create a new namespace

We recommend using aerospike namespace for the connector cluster. If the namespace does not exist run the following command:

kubectl create namespace aerospike

Create secrets

You can create additional secrets, for confidential data like TLS certificates, that are mounted to the connector pods. The connector can then be configured to use these secrets. See examples/tls for example.

Deploy the connector cluster

# helm install --namespace <target namespace> <helm release name/cluster name> -f <path to custom values yaml> aerospike/aerospike-jms-outbound
helm install --namespace aerospike as-jms-outbound -f as-jms-outbound-values.yaml aerospike/aerospike-jms-outbound

Here as-jms-outbound is the release name for the connector cluster and also its cluster name.

On successful deployment you should see output similar to below:

NAME: as-jms-outbound
LAST DEPLOYED: Mon Oct 17 20:44:34 2022
NAMESPACE: aerospike
STATUS: deployed
REVISION: 1
NOTES:
1. Get the list of connector pods  by running the command:

kubectl get pods --namespace aerospike --selector=app=as-jms-outbound-aerospike-jms-outbound --no-headers -o custom-columns=":metadata.name"

2. Configure XDR to use each of these connector pods in the datacenter section

Use the following command to get the pod DNS names and port to use.

kubectl get pods --namespace aerospike --selector=app=as-jms-outbound-aerospike-jms-outbound --no-headers -o custom-columns=":metadata.name" \
    | sed -e "s/$/.as-jms-outbound-aerospike-jms-outbound 8080/g"

Visit https://docs.aerospike.com/connect/common/change-notification for details

List pods for the connector

To list the pods for the connector run the following command:

# kubectl get pods --namespace aerospike --selector=app=<helm release name>-aerospike-jms-outbound
kubectl get pods --namespace aerospike --selector=app=as-jms-outbound-aerospike-jms-outbound

You should see output similar to the following:

NAME                                           READY   STATUS    RESTARTS   AGE
as-jms-outbound-aerospike-jms-outbound-0   1/1     Running   0          7m19s
as-jms-outbound-aerospike-jms-outbound-1   1/1     Running   0          7m40s
as-jms-outbound-aerospike-jms-outbound-2   1/1     Running   0          7m51s

Configure XDR to ship to connector pods

Pod DNS names can be used directly if the Aerospike cluster is also running in the same Kubernetes cluster. To get the pod DNS names and ports to be added to XDR DC section, run the following command.

# kubectl get pods --namespace <target namespace> --selector=app=<helm release name>-aerospike-jms-outbound --no-headers -o custom-columns=":metadata.name" \
#    | sed -e "s/$/.<helm release name>-aerospike-jms-outbound <service port or service TLS port as desired>/g"
kubectl get pods --namespace aerospike --selector=app=as-jms-outbound-aerospike-jms-outbound --no-headers -o custom-columns=":metadata.name" \
    | sed -e "s/$/.as-jms-outbound-aerospike-jms-outbound 8080/g"

You should see output similar to the following

as-jms-outbound-aerospike-jms-outbound-0.as-jms-outbound-aerospike-jms-outbound 8080
as-jms-outbound-aerospike-jms-outbound-1.as-jms-outbound-aerospike-jms-outbound 8080
as-jms-outbound-aerospike-jms-outbound-2.as-jms-outbound-aerospike-jms-outbound 8080

If you are using Aerospike Kubernetes Operator, see clear text and tls for reference.

Get logs for all connector instances

# kubectl -n aerospike logs -f statefulset/<helm release name>-aerospike-jms-outbound
# Skip the -f flag to get a one time dump of the log
kubectl -n aerospike logs -f statefulset/as-jms-outbound-aerospike-jms-outbound

Get logs for one connector pod

# kubectl -n aerospike logs -f <helm release name>-aerospike-jms-outbound-0
# Skip the -f flag to get a one time dump of the log
kubectl -n aerospike logs -f as-jms-outbound-aerospike-jms-outbound-0

Updating connector configuration

Edit the connectorConfig section in the custom values file and save the changes.

Upgrade the connector deployment using the following command.

#helm upgrade --namespace <target namespace> <helm release name> -f <path to custom values yaml file> aerospike/aerospike-jms-outbound
helm upgrade --namespace aerospike as-jms-outbound -f as-jms-outbound-values.yaml aerospike/aerospike-jms-outbound

On successful execution of the command the connector pods will undergo a rolling restart and come up with the new configuration.

To verify the changes are applied

• List the pods
• Verify the configuration in connector logs

NOTE: The changes might take some time to apply. If you do not see the desired connector config try again after some time. If connector pods are not being listed or report status as crashed see troubleshooting.

Scaling up/down the connectors

Edit the replicaCount to the desired connector count and upgrade the connector deployment using the following command.

#helm upgrade --namespace <target namespace> <helm release name> -f <path to custom values yaml file> aerospike/aerospike-jms-outbound
helm upgrade --namespace aerospike as-jms-outbound -f as-jms-outbound-values.yaml aerospike/aerospike-jms-outbound

Verify that the connectors have been scaled.

• List the pods and verify the count of connectors is as desired

NOTE: The changes might take some time to apply. If you do not see the desired count try again after some time. If connector pods are not being listed or report status as crashed see troubleshooting.

Update the XDR DC section

If you have scaled up add the new PODs to the XDR DC section else on scale down remove to additional pods DNS names.

Troubleshooting

Connector pods not listed

Check for any error events on the StatefulSet created for the connectors.

# kubectl -n aerospike describe statefulset <helm release name>-aerospike-jms-outbound
kubectl -n aerospike describe statefulset as-jms-outbound-aerospike-jms-outbound

Connector pods stuck in init or pending state

Check for any error events on the pod created for the connectors.

# kubectl -n aerospike describe pod <helm release name>-aerospike-jms-outbound-0
kubectl -n aerospike describe pod as-jms-outbound-aerospike-jms-outbound-0

The most likely reason is secret listed in connectorSecrets has not been created in the connector namespace.

Connector pods in crashed state

The most likely reason is connector configuration provided in connectorConfig is invalid. Verify this by viewing the connector logs, fix and update the connector configuration.