NATS (`nats`)

Système de messagerie avec la persistance JetStream pour les événements et les files de travail. Serveur unique ou cluster avec routes.

Généré depuis catalog/services/nats.yaml : ne pas modifier à la main.

Résumé


Version	`2.11.17`
Usage	installer et configurer
Couche	infrastructure (présentée à part)
Catégorie	Plateformes de données
Méthodes d'installation	`binary`, `podman`
Connexion externe	`nats`
Réservé au bac à sable	non

Licence


Identifiant SPDX	`Apache-2.0`
Politique de licence	licence socle (MIT ou Apache-2.0)
Exception de licence	-
Composant de la plateforme	`nats`

Paquets et artefacts

Un paquet que publie le projet du service (son image, son archive binaire, son paquet Python ou système) porte la licence du service ; un paquet tiers porte la licence écrite sur sa ligne, lue dans les métadonnées officielles du projet amont.

Type	Paquet	Version	Licence	Détails
image de conteneur	`docker.io/library/nats`	`2.11.17`	`Apache-2.0`	clé d'image `nats`, utilisée par `server`, condensé `sha256:c991221cdddd53a24893cd18a90faf7a42396108496aed076bb982a349e76484`
archive binaire	`nats-server-v2.11.17-linux-amd64.tar.gz`	`2.11.17`	`Apache-2.0`	https://github.com/nats-io/nats-server/releases/download/v2.11.17/nats-server-v2.11.17-linux-amd64.tar.gz, x86_64, somme de contrôle sha256

Les images sont épinglées par étiquette dans le descripteur, et par condensé (digest) quand le descripteur en déclare un (le bundle hors ligne refuse alors une image téléchargée qui ne le porte pas) ; le condensé est enregistré dans le miroir du Manager à l'import du bundle hors ligne, et chaque téléchargement ou chargement est vérifié par rapport à lui.

Systèmes et architectures pris en charge

Méthode	Systèmes d'exploitation	Architectures
`binary`	famille RHEL (dnf), famille Debian (apt), Arch Linux (pacman)	x86_64 (architecture des artefacts du descripteur)
`podman`	famille RHEL (dnf), famille Debian (apt), Arch Linux (pacman)	x86_64, aarch64 (non restreintes par le descripteur)

Systèmes hôtes certifiés : RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). Le contrôle préalable des hôtes accepte ces systèmes (une autre version d'une famille connue donne un avertissement, une version en fin de vie est refusée) et les architectures x86_64 et aarch64.

Prérequis

Hôte

au moins 1024 Mo de mémoire (bloquant, memory).

Réseau et ports

Composant	Nom du port	Port	Ouvert dans le pare-feu de l'hôte
`server`	`client`	4222/tcp	oui
`server`	`route`	6222/tcp	oui
`server`	`monitor`	8222/tcp	oui

Services et connexions nécessaires

Ce service n'a aucune dépendance.

Méthodes et modes d'installation

Méthode	Défaut	Ce que la méthode utilise
`binary`	oui	les archives binaires du descripteur, décompressées dans le répertoire du service
`podman`	-	les images de conteneur du descripteur, exécutées par Podman sous systemd

Composants

Composant	Type	Méthodes d'installation	Ports
Serveur NATS (`server`)	maître	`binary`, `podman`	4222/tcp, 6222/tcp, 8222/tcp

Serveur unique (`standalone`) (par défaut)

Un seul serveur NATS.

Ce que le mode déploie :

Composant	Placement
`server`	min 1, max 1

Cluster (`cluster`)

Serveurs reliés par des routes ; JetStream exige un nombre impair (3 ou 5) pour son quorum Raft.

Ce que le mode déploie :

Composant	Placement
`server`	min 3, nombre impair, recommandé 3

Installer ce service

L'assistant d'installation du Navin Manager planifie, valide et exécute l'installation ; il faut la permission services:install sur le cluster.

Ouvrez l'assistant. Dans Clusters, choisissez l'action de ligne Installer des services du cluster cible. L'assistant s'ouvre sur sa première étape, Service.
Choisissez le service. À l'étape Service, sélectionnez NATS. La carte affiche la licence Apache-2.0. Choisissez la Méthode parmi binary, podman (par défaut binary). Pour enregistrer à la place un service nats existant de votre organisation, activez Utiliser un service externe existant.
Choisissez les hôtes et le mode. À l'étape Hôtes, cochez les hôtes, puis choisissez le Mode : standalone (par défaut), cluster. Chaque mode déploie les composants listés dans Méthodes et modes d'installation.
Liaisons. Ce service n'a aucune dépendance : l'étape Liaisons n'a rien à lier.
Configurez. À l'étape Configuration, relisez les paramètres (voir Paramètres de configuration). Les mots de passe laissés vides avec une valeur générée par défaut sont générés et scellés par le Manager.
Relisez et installez. À l'étape Installation, le Manager valide le plan et affiche l'ordre d'installation ; quand il indique « Le plan est valide. Prêt pour l'installation. », choisissez Installer. Un mode hautement disponible n'est installé que si ses contrôles HA réussissent.
Vérifiez. L'opération se termine quand les contrôles de santé de chaque instance réussissent (voir Contrôles de santé) ; le service apparaît alors en marche dans Services. Ouvrez le service et choisissez Lancer le test fonctionnel dans la carte Contrôles : S'abonne à un sujet neuf, y publie un message et attend sa livraison (protocole NATS de base).

Haute disponibilité


Cluster	natif (`native`)
Haute disponibilité	natif (`native`)
Bascule	côté client (`client`)
Réplication	natif (`native`)
Quorum	Raft (`raft`)
Découverte	statique (`static`)
Point d'entrée	découverte par le client (`client-discovery`)
Documentation officielle	https://docs.nats.io/learn/clustering/
Paramètre TLS entre pairs	`tls_enabled`
Commande d'état du cluster	`server_report`

Topologie par mode

Modes	Niveau le plus haut du catalogue	Répartition	Composant du quorum	Domaines de panne	Description
`standalone`	autonome (`standalone`)	unique (`single`)	-	1	Un serveur NATS.
`cluster`	cluster (`cluster`)	actif-actif (`active-active`)	`server`	3	Serveurs reliés par des routes ; JetStream garde un quorum Raft sur un nombre impair de serveurs.

Remarques

Les flux JetStream ne sont répliqués que s'ils sont créés avec 3 (ou 5) réplicas ; les clients listent plusieurs serveurs et se reconnectent seuls.

Paramètres de configuration

Réseau

Paramètre	Type	Défaut	Valeurs permises	Obligatoire	Secret	Redémarrage	Description
Port client (`client_port`)	`port`	`4222`	-	non	non	non	Port des connexions clientes.
Port des routes (`cluster_port`)	`port`	`6222`	-	non	non	non	Port des routes entre les serveurs du cluster.
Port de supervision (`monitor_port`)	`port`	`8222`	-	non	non	non	Port des points de supervision HTTP (/healthz, /varz).

JetStream

Paramètre	Type	Défaut	Valeurs permises	Obligatoire	Secret	Redémarrage	Description
JetStream (`jetstream_enabled`)	`bool`	`true`	-	non	non	non	Activer les flux persistants.
Disque JetStream (`jetstream_max_file`)	`size`	`10g`	-	non	non	non	Disque maximal utilisé par les flux.
Mémoire JetStream (`jetstream_max_memory`)	`size`	`1g`	-	non	non	non	Mémoire maximale utilisée par les flux en mémoire.

Sécurité

Paramètre	Type	Défaut	Valeurs permises	Obligatoire	Secret	Redémarrage	Description
TLS (`tls_enabled`)	`bool`	`false`	-	non	non	non	Exiger TLS pour les clients et les routes avec le certificat de l'autorité de la console.
Utilisateur (`username`)	`string`	`navin`	`^[A-Za-z0-9_-]{1,64}$`	non	non	non	Utilisateur des connexions clientes.
Mot de passe (`password`)	`password`	généré	-	non	oui	non	Mot de passe de l'utilisateur client.
Mot de passe des routes (`route_password`)	`password`	généré	-	non	oui	non	Identifiant des routes entre serveurs.

Points d'accès

Point d'accès	Schéma	Composant	Port	Chemin	Paramètre TLS	Paramètres de liaison	Secrets de liaison	Commande de provisionnement
`client`	`nats`	`server`	4222 (`client_port`)	-	`tls_enabled`	`username`	`password`	-

Commandes

Commande	Composant	Cible	Description
Rapport des serveurs (`server_report`)	`server`	tous les hôtes	Lit /varz et /routez de chaque serveur (connexions, routes, mémoire).
Rapport JetStream (`jetstream_report`)	`server`	premier hôte	Lit /jsz (flux, consommateurs, leader méta).

Contrôles de santé

Vivacité (par instance)

Composant	Contrôle	Détails
`server`	HTTP `http://{{ host.ip or '127.0.0.1' }}:{{ config.monitor_port }}/healthz`	Attendu 200 ; 30 tentatives

Disponibilité (contrôle du service)

Contrôle	Détails
HTTP `http://{{ host.ip or '127.0.0.1' }}:{{ config.monitor_port }}/healthz?js-enabled-only=true`	Attendu 200

Test fonctionnel

S'abonne à un sujet neuf, y publie un message et attend sa livraison (protocole NATS de base). (server: publish_subscribe)

Contrôles préalables

Contrôle	Type	Signification	Sévérité	Composants
`memory`	`memory_mb` `{"min": 1024}`	au moins 1024 Mo de mémoire	bloquant	tous les composants
`client_port_free`	`port_free` `{"param": "client_port"}`	port 4222 libre sur l'hôte	bloquant	tous les composants

Sauvegarde et restauration

Archive du magasin JetStream prise pendant un arrêt de quelques secondes du serveur (flux, consommateurs et messages).


Format	`nats-jetstream`
Composant	`server`
Fichiers	`{{ backup.dir }}/jetstream.tar.gz`
Test de restauration	non
Instances arrêtées pendant la restauration	oui

Mise à niveau


Prise en charge depuis	`2.11.4`
Avec état	oui
Sauvegarde avant la mise à niveau	oui
Retour arrière	oui

Désinstallation

Chemins supprimés quand les données sont purgées : {{ paths.data }}, {{ paths.log }}.

Liens rapides

Supervision : http://{{ host.fqdn }}:{{ config.monitor_port }}/varz

Documentation amont

Site : https://nats.io
Sources : https://github.com/nats-io/nats-server
Haute disponibilité : https://docs.nats.io/learn/clustering/

Résumé​

Licence​

Paquets et artefacts​

Systèmes et architectures pris en charge​

Prérequis​

Hôte​

Réseau et ports​

Services et connexions nécessaires​

Méthodes et modes d'installation​

Composants​

Serveur unique (standalone) (par défaut)​

Cluster (cluster)​

Installer ce service​

Haute disponibilité​

Topologie par mode​

Remarques​

Paramètres de configuration​

Réseau​

JetStream​

Sécurité​

Points d'accès​

Commandes​

Contrôles de santé​

Vivacité (par instance)​

Disponibilité (contrôle du service)​

Test fonctionnel​

Contrôles préalables​

Sauvegarde et restauration​

Mise à niveau​

Désinstallation​

Liens rapides​

Documentation amont​