STAN on Kubernetes

Minimal STAN Setup

You can start with the following:

  1. kubectl apply -f https://raw.githubusercontent.com/nats-io/k8s/master/nats-streaming-server/single-server-stan.yml

Next, try using nats-box to connect to the nats service to confirm that you have set NATS Streaming correctly.

  1. kubectl run -i --rm --tty nats-box --image=synadia/nats-box --restart=Never
  3. # Send/Receive message to STAN
  4. nats-box:~# stan-pub -s nats -c stan hello world
  5. Published [hello] : 'world'
  7. nats-box:~# stan-sub -s nats -c stan hello
  8. Connected to nats clusterID: [stan] clientID: [stan-sub]
  9. Listening on [hello], clientID=[stan-sub], qgroup=[] durable=[]
  10. [#1] Received: sequence:1 subject:"hello" data:"world" timestamp:1579544643374163630

HA Setup Using StatefulSets

In order to have higher availability you can setup NATS Streaming (STAN) to run in clustering mode. The following commands will setup a 3 node NATS cluster as well as a 3 node NATS Streaming cluster that has an attached volume for persistence. Note, you will need more than one node available in your Kubernetes cluster in order for this to work, so in case of deploying onto minikube or docker desktop, please try the single node installer instead.

  1. # Create STAN cluster
  2. kubectl apply -f https://raw.githubusercontent.com/nats-io/k8s/master/nats-streaming-server/simple-stan.yml

For NATS Streaming, it is actually recommended to use the Fault Tolerance mode as that would show better performance than clustering mode and better failover. You can follow this guide to setup NATS Streaming with Fault Tolerance.

Using Helm Charts

NATS Streaming has officially supported Helm charts as well: