OpenSearch Dashboards (opensearch-dashboards)
Console web d'OpenSearch : recherche, exploration des journaux, visualisations, administration des index et de la sécurité. Sans état, ses objets enregistrés sont stockés dans OpenSearch.
Généré depuis catalog/services/opensearch-dashboards.yaml : ne pas modifier à la main.
Résumé
| Version | 2.19.2 |
| Usage | installer et configurer |
| Couche | infrastructure (présentée à part) |
| Catégorie | Plateformes de données |
| Méthodes d'installation | binary, podman |
| Connexion externe | non |
| 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 | opensearch-dashboards |
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/opensearchproject/opensearch-dashboards | 2.19.2 | Apache-2.0 | clé d'image opensearch-dashboards, utilisée par account, dashboards, condensé sha256:569b0ed262c231eac57fa9b582029e081c94e5663867191308eccca15118a1b4 |
| archive binaire | opensearch-dashboards-2.19.2-linux-x64.tar.gz | 2.19.2 | Apache-2.0 | https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/2.19.2/opensearch-dashboards-2.19.2-linux-x64.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).
Programmes que les commandes et les contrôles du service lancent sur l'hôte, hors des racines gérées : les ajouter à allowed_commands de l'agent (voir Sécurité de l'agent Navin), sinon l'agent les refuse avec command_not_allowed : /usr/bin/curl.
Réseau et ports
| Composant | Nom du port | Port | Ouvert dans le pare-feu de l'hôte |
|---|---|---|---|
dashboards | web | 5601/tcp | oui |
Services et connexions nécessaires
opensearch:opensearch.
Détail et résolution : voir Dépendances.
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 |
|---|---|---|---|
Création du compte de service (account) | ponctuel | binary, podman | - |
Serveur de la console (dashboards) | maître | binary, podman | 5601/tcp |
Instance unique (single) (par défaut)
Un seul serveur de console, suffisant pour la plupart des installations.
Ce que le mode déploie :
| Composant | Placement |
|---|---|
account | min 1, max 1 |
dashboards | min 1, max 1 |
Répliqué (replicated)
Plusieurs serveurs sans état derrière le répartiteur de charge (HAProxy), qui partagent la clé du cookie de session.
Ce que le mode déploie :
| Composant | Placement |
|---|---|
account | min 1, max 1 |
dashboards | min 2, recommandé 2 |
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 OpenSearch Dashboards. La carte affiche la licence
Apache-2.0et les dépendances dont l'installation a besoin. Choisissez la Méthode parmibinary,podman(par défautbinary). -
Choisissez les hôtes et le mode. À l'étape Hôtes, cochez les hôtes, puis choisissez le Mode :
single(par défaut),replicated. Chaque mode déploie les composants listés dans Méthodes et modes d'installation. Avec plusieurs composants, placez chacun sur ses hôtes dans Répartition des composants (Proposer un placement propose un placement qui respecte les cardinalités). -
Liez les dépendances. À l'étape Liaisons, choisissez pour chaque dépendance (
opensearch) Installer avec la plateforme ou Utiliser une connexion existante ; une dépendance facultative peut rester sur Aucune liaison. -
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.
Haute disponibilité
| Cluster | réplicas (replication) |
| Haute disponibilité | externe (external) |
| Bascule | répartiteur (load-balancer) |
| Réplication | stockage partagé (shared-store) |
| Quorum | aucun (none) |
| Découverte | aucun (none) |
| Point d'entrée | répartiteur (load-balancer) |
| Documentation officielle | https://opensearch.org/docs/latest/install-and-configure/install-dashboards/index/ |
| Paramètre TLS entre pairs | tls_enabled |
Prérequis
| Prérequis | Doit être hautement disponible | Modes | Description |
|---|---|---|---|
opensearch | oui | modes de niveau ha ou cluster | OpenSearch avec son greffon de sécurité et TLS, lui-même hautement disponible (mode cluster) ; il stocke les objets enregistrés. |
Topologie par mode
| Modes | Niveau le plus haut du catalogue | Répartition | Composant du quorum | Domaines de panne | Description |
|---|---|---|---|---|---|
single | autonome (standalone) | unique (single) | - | 1 | Un serveur de console, sans tolérance aux pannes. |
replicated | ha (ha) | actif-actif (active-active) | - | 2 | Plusieurs serveurs sans état derrière HAProxy qui partagent la clé du cookie ; les objets enregistrés sont dans OpenSearch. |
Remarques
- La multilocation est désactivée car le compte de service n'est pas le server_username du greffon de sécurité d'OpenSearch.
Paramètres de configuration
Réseau
| Paramètre | Type | Défaut | Valeurs permises | Obligatoire | Secret | Redémarrage | Description |
|---|---|---|---|---|---|---|---|
Port web (port) | port | 5601 | - | non | non | oui | Port de la console web et de /api/status. |
TLS (tls_enabled) | bool | true | - | non | non | oui | Servir la console en TLS avec un certificat émis par l'autorité de la console (à garder activé : le cookie de session est alors marqué sécurisé). |
Sécurité
| Paramètre | Type | Défaut | Valeurs permises | Obligatoire | Secret | Redémarrage | Description |
|---|---|---|---|---|---|---|---|
Compte de service (dashboards_username) | string | navin_dashboards | ^[a-z][a-z0-9_]{2,40}$ | non | non | non | Compte OpenSearch dédié du serveur de la console (rôle kibana_server), créé à l'installation. Jamais l'utilisateur de démonstration kibanaserver. (avancé) |
Mot de passe du compte de service (dashboards_password) | password | généré | - | non | oui | non | Mot de passe du compte de service, généré à chaque installation et haché par OpenSearch. |
Clé du cookie de session (cookie_password) | password | généré | - | non | oui | non | Clé qui chiffre le cookie de session des utilisateurs (32 caractères, partagée par les répliques). |
Durée de session (session_ttl_ms) | int | 3600000 | min 300000, max 86400000, ms | non | non | non | Durée de vie d'une session utilisateur sans activité, en millisecondes (une heure par défaut). |
Dépendances
Pour chaque dépendance active, le Manager prend la première solution parmi : la liaison choisie dans l'assistant ; un service de la même installation qui la fournit ; un service déjà installé dans le cluster ; la seule connexion du type attendu. Sinon, une dépendance facultative reste non liée, et une dépendance obligatoire est ajoutée à l'installation dans son mode par défaut (la colonne ci-dessous nomme le service du catalogue ajouté).
| Liaison | Fournie par | Type de connexion | Point d'accès | Facultative | Quand rien n'est lié | Description |
|---|---|---|---|---|---|---|
opensearch | opensearch | - | http | non | opensearch est ajouté à l'installation | Cluster OpenSearch présenté par la console, avec son greffon de sécurité et TLS activés. |
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 |
|---|---|---|---|---|---|---|---|---|
web | http | dashboards | 5601 (port) | - | tls_enabled | - | - | - |
Commandes
| Commande | Composant | Cible | Description |
|---|---|---|---|
État de la console (status) | dashboards | premier hôte | Lit /api/status avec le compte de service (état global, greffons, connexion à OpenSearch). |
Créer le compte de service (create_account) | account | premier hôte | Crée ou met à jour le compte de service dans OpenSearch avec le mot de passe actuel (idempotent, après une rotation du mot de passe par exemple). |
Contrôles de santé
Vivacité (par instance)
| Composant | Contrôle | Détails |
|---|---|---|
dashboards | HTTP {{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn if config.tls_enabled else (host.ip or '127.0.0.1') }}:{{ config.port }}/api/status | Attendu 200, 401 ; 90 tentatives ; intervalle 2 s ; délai 5 s |
Disponibilité (contrôle du service)
| Contrôle | Détails |
|---|---|
/usr/bin/curl -sS --fail -o /dev/null --netrc-file {{ paths.etc }}/dashboards.netrc --cacert {{ tls.ca_file }} {{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn }}:{{ config.port }}/api/status | 10 tentatives ; intervalle 3 s ; délai 10 s |
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 | dashboards |
web_port_free | port_free {"param": "port"} | port 5601 libre sur l'hôte | bloquant | dashboards |
Désinstallation
Chemins supprimés quand les données sont purgées : {{ paths.data }}, {{ paths.log }}.
Liens rapides
- OpenSearch Dashboards :
{{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn }}:{{ config.port }}/ - État :
{{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn }}:{{ config.port }}/app/status