bitnamicharts/nats
Bitnami Helm chart for NATS
100K+
NATS is an open source, lightweight and high-performance messaging system. It is ideal for distributed systems and supports modern cloud architectures and pub-sub, request-reply and queuing models.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/nats
Looking to use NATS in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
This chart bootstraps a NATS deployment on a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/nats
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploys NATS on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
The Bitnami NATS chart, when upgrading, reuses the secret previously rendered by the chart or the one specified in existingSecret
. To update credentials, use one of the following:
helm upgrade
specifying a new password in auth.password
helm upgrade
specifying a new secret in existingSecret
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
This chart can be integrated with Prometheus by setting metrics.enabled
to true
. This will deploy a sidecar container with prometheus-nats-exporter in all pods and a metrics
service, which can be configured under the metrics.service
section. This metrics
service will have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true
. Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars
property.
extraEnvVars:
- name: LOG_LEVEL
value: DEBUG
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM
or the extraEnvVarsSecret
values.
If additional containers are needed in the same pod (such as additional metrics or logging exporters), they can be defined using the sidecars
config parameter.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts
parameter (where available), as shown in the example below:
service:
extraPorts:
- name: extraPort
port: 11311
targetPort: 11311
NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the
--enable-metrics=true
parameter at deployment time. Thesidecars
parameter should therefore only be used for any extra sidecar containers.
If additional init containers are needed in the same pod, they can be defined using the initContainers
parameter. Here is an example:
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Learn more about sidecar containers and init containers.
There are cases where you may want to deploy extra objects, such a ConfigMap containing your app's configuration or some extra deployment with a micro service used by your app. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy
parameter.
This chart allows you to set custom Pod affinity using the affinity
parameter. Find more information about Pod affinity in the Kubernetes documentation.
As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Force target Kubernetes version (using Helm capabilities if not set) | "" |
nameOverride | String to partially override common.names.fullname template (will maintain the release name) | "" |
fullnameOverride | String to fully override common.names.fullname template | "" |
commonLabels | Add labels to all the deployed resources | {} |
commonAnnotations | Add annotations to all the deployed resources | {} |
clusterDomain | Kubernetes Cluster Domain | cluster.local |
extraDeploy | Array of extra objects to deploy with the release | [] |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the deployment | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployment | ["infinity"] |
Name | Description | Value |
---|---|---|
image.registry | NATS image registry | REGISTRY_NAME |
image.repository | NATS image repository | REPOSITORY_NAME/nats |
image.digest | NATS image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
image.pullPolicy | NATS image pull policy | IfNotPresent |
image.pullSecrets | NATS image pull secrets | [] |
image.debug | Enable NATS image debug mode | false |
auth.enabled | Switch to enable/disable client authentication | true |
auth.user | Client authentication user | nats_client |
auth.password | Client authentication password | "" |
auth.token | Client authentication token | "" |
auth.timeout | Client authentication timeout (seconds) | 1 |
auth.usersCredentials | Client authentication users credentials collection | [] |
auth.noAuthUser | Client authentication username from auth.usersCredentials map to be used when no credentials provided | "" |
cluster.name | Cluster name | nats |
cluster.connectRetries | Configure number of connect retries for implicit routes, otherwise leave blank | "" |
cluster.auth.enabled | Switch to enable/disable cluster authentication | true |
cluster.auth.user | Cluster authentication user | nats_cluster |
cluster.auth.password | Cluster authentication password | "" |
jetstream.enabled | Switch to enable/disable JetStream | false |
jetstream.maxMemory | Max memory usage for JetStream | 1G |
debug.enabled | Switch to enable/disable debug on logging | false |
debug.trace | Switch to enable/disable trace debug level on logging | false |
debug.logtime | Switch to enable/disable logtime on logging | false |
maxConnections | Max. number of client connections | "" |
maxControlLine | Max. protocol control line | "" |
maxPayload | Max. payload | "" |
writeDeadline | Duration the server can block on a socket write to a client | "" |
natsFilename | Filename used by several NATS files (binary, configuration file, and pid file) | nats-server |
configuration | Specify content for NATS configuration file (generated based on other parameters otherwise) | "" |
existingSecret | The name of an existing Secret with your custom configuration for NATS | "" |
command | Override default container command (useful when using custom images) | [] |
args | Override default container args (useful when using custom images) | [] |
extraEnvVars | Extra environment variables to be set on NATS container | [] |
extraEnvVarsCM | ConfigMap with extra environment variables | "" |
extraEnvVarsSecret | Secret with extra environment variables | "" |
Name | Description | Value |
---|---|---|
resourceType | NATS cluster resource type under Kubernetes. Allowed values: statefulset (default) or deployment | statefulset |
replicaCount | Number of NATS nodes | 1 |
schedulerName | Use an alternate scheduler, e.g. "stork". | "" |
priorityClassName | Name of pod priority class | "" |
updateStrategy.type | StrategyType. Can be set to RollingUpdate or OnDelete | RollingUpdate |
podManagementPolicy | StatefulSet pod management policy | OrderedReady |
containerPorts.client | NATS client container port | 4222 |
containerPorts.cluster | NATS cluster container port | 6222 |
containerPorts.monitoring | NATS monitoring container port | 8222 |
podSecurityContext.enabled | Enabled NATS pods' Security Context | true |
podSecurityContext.fsGroupChangePolicy | Set filesystem group change policy | Always |
podSecurityContext.sysctls | Set kernel settings using the sysctl interface | [] |
podSecurityContext.supplementalGroups | Set filesystem extra groups | [] |
podSecurityContext.fsGroup | Set NATS pod's Security Context fsGroup | 1001 |
containerSecurityContext.enabled | Enabled containers' Security Context | true |
containerSecurityContext.seLinuxOptions | Set SELinux options in container | {} |
containerSecurityContext.runAsUser | Set containers' Security Context runAsUser | 1001 |
containerSecurityContext.runAsGroup | Set containers' Security Context runAsGroup | 1001 |
`containerSecurityContext.runAsNonR |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/nats/README.md