Cluster controller
Deploys a NATS cluster from one NatsCluster and restarts it one server at a time. It also joins NATS clusters into a supercluster, or to a hub as leaves.
- NatsCluster
Three controllers · Four API groups · v1beta1
nats-operator is three Kubernetes controllers that deploy NATS clusters, own their auth plane, and manage and balance JetStream. It is for platform engineers who run NATS on Kubernetes. You can install all three controllers or only the ones you need.
status: version: 2.15.0 replicas: 3 readyReplicas: 3 conditions: - type: Ready status: "True" - type: Settled status: "True" - type: Progressing status: "False" endpoints: client: nats://demo.nats-system.svc:4222 jetstream: metaLeader: demo-1 servers: - demo-0 ready: true rev: 3f9a1c - demo-1 ready: true rev: 3f9a1c - demo-2 ready: true rev: 3f9a1c
Deploys a NATS cluster from one NatsCluster and restarts it one server at a time. It also joins NATS clusters into a supercluster, or to a hub as leaves.
Creates the JWT auth plane, which is a NATS operator with its accounts and users. It distributes the auth plane to the servers and writes each user’s credentials to a Secret.
Manages streams, consumers, key-value buckets and object stores, and balances JetStream leadership and placement. It works through a NatsConnection, so the NATS cluster can be one that the cluster controller did not deploy.
You need Kubernetes 1.33, Helm 3.14 and nats-server 2.15.0, or later.
To install all three controllers, run this command with <version> replaced by a release version:
helm install nats-operator oci://ghcr.io/mikluko/nats-operator/charts/nats-operator \
--version <version> \
--namespace nats-operator --create-namespaceThen follow the quickstart to deploy a NATS cluster with JetStream.
Install shows how to install a subset of the controllers, upgrade and uninstall. Chart and controller flags lists the chart’s values and the RBAC of each controller. The images and the chart are signed keylessly with cosign and carry a GitHub build provenance attestation. Verifying a release has the commands that check both.