Stories · 14 guides
Stories
Contents
The stories are the guides to the controllers, one task each, with the manifests that do it. Each manifest uses the resource API, and the API reference lists every kind and field.
If you are new to the controllers, start with the quickstart, a tutorial that deploys a NATS cluster with JetStream and creates a stream on it.
The other stories are how-to guides:
- The auth plane: put a NATS cluster under a NATS operator, let a team declare its own users and streams, share a stream and a service between accounts, and adopt a NATS operator and accounts made with nsc.
- JetStream: manage JetStream on a NATS cluster that you did not deploy, balance JetStream leaders and copies, move a stream to another NATS cluster, and retire a NATS cluster.
- Several NATS clusters: build a supercluster across Kubernetes clusters, deploy a production supercluster of three NATS clusters, join a NATS cluster to a hub as a leaf, and add a NATS cluster to a supercluster that you did not deploy.
- Metrics: scrape the controllers’ metrics over verified TLS.
Following a story#
Create the namespaces that the manifests use,
nats-systemand, in some stories,orders,paymentsormonitoring:for ns in nats-system orders payments monitoring; do kubectl create namespace "$ns"; doneIn a story that spans Kubernetes clusters, create them in each one.
Apply each manifest with the
kubectlcommand that follows it on the page. In a story that spans Kubernetes clusters, the command sets the kubeconfig context of its Kubernetes cluster with--context.Compare what
kubectl get -o yamlshows with the status file on the page. A value that differs from one Kubernetes cluster to the next is an example.
Running the stories#
To run the stories end to end on kind clusters from a checkout of the repository, run just e2e.
hack/e2e describes what the harness needs.