Guide du Dashboard Viewer de SKOOR

Introduction

Ce guide traite de l'installation du SKOOR Dashboard Viewer. Pour l'installation de SKOOR Engine ou Redhat, veuillez consulter le guide d'installation de SKOOR Engine. Pour plus d'informations sur l'architecture des composants du Dashboard, veuillez consulter la page Composants dans la section Architecture de ce guide.

Prérequis

Le référentiel RPM SKOOR est disponible

Matériel

Système Dashboard Viewer

Le Viewer Service fonctionne sur une petite machine. 2 Go de RAM et 2 cœurs de processeur suffisent.

Système Dashboard Provider

En général, le service Dashboard Provider est installé sur la machine serveur SKOOR Engine. Si cette machine a été dimensionnée avec une certaine marge, ce composant devrait fonctionner correctement sur le même système. De plus, dans la plupart des cas, un composant Dashboards est déjà installé et présente les mêmes prérequis.

Logiciel

Système Dashboard Viewer

Le Dashboard Viewer nécessite un serveur Apache HTTP avec mod_ssl. Veuillez installer les RPM correspondants à partir des référentiels et démarrer le serveur :

$ sudo yum install httpd mod_ssl
$ sudo /sbin/service httpd start

Configurez httpd pour qu'il démarre au lancement du système :

$ sudo systemctl enable httpd

Configurez firewalld :

$ sudo firewall-cmd --add-port=443/tcp --permanent
$ sudo firewall-cmd --reload

Avant d'installer les composants SKOOR, SELINUX doit être désactivé :

# vi /etc/selinux/config
SELINUX=permissive

# setenforce 0
#
# sestatus
...
Current mode:                 permissive
...

Enfin, Dashboard Viewer a besoin d'un Dashboard Provider qui lui fournit les données provenant du SKOOR Webservice.

Système Dashboard Provider

Les composants SKOOR suivants doivent être installés sur le système où le fournisseur de tableau de bord sera installé :

Bien sûr, une instance de l’SKOOR Engine doit également être disponible.

Installation

Système Dashboard Viewer

Installez à partir du référentiel RPM SKOOR à l'aide de yum :

sudo yum install eranger-nodejs eranger-dashboard-viewer-service eranger-doc

Pour configurer Dashboard Viewer, ouvrez le fichier /etc/opt/eranger/eranger-dashboard-viewer-service.json.

Exemple :

{
  "port": 8092,
  "presharedKey": "1234567890",
  "logLevel": "debug",
  "defaultUsername": "dashboard-user",
  "defaultPassword": "dashboard-user"
}

Paramètre	Description
`port`	Port TCP sur lequel le service est accessible localement par le server Web
`presharedKey`	Cette clé doit être partagée entre le fournisseur du tableau de bord et le service Dashboard Viewer. Pour des raisons de sécurité, elle doit être remplacée par une valeur unique.
`logLevel`	Définissez ce paramètre sur l'une des valeurs suivantes : debug, info, warn, error
`defaultUsername`	Les tableaux de bord peuvent être affichés avec ou sans connexion utilisateur. Un utilisateur et un mot de passe doivent être définis pour le tableau de bord par défaut. Ceci doit être configuré avec un utilisateur en lecture seule SKOOR Engine. Veuillez noter que le même utilisateur par défaut doit être configuré dans tous les SKOOR Engines qui fournissent des données à ce viewer.
`defaultPassword`	Avec le nom d'utilisateur par défaut, ce mot de passe est utilisé pour authentifier l'utilisateur configuré avec le nom d'utilisateur par défaut.

Vérifiez l'état du Dashboard Viewer en demandant l'URL suivante à l'aide d'un navigateur :

https://<NOM du serveur du visualiseur>/SKOOR Dashboard Viewer Service/status

Le résultat devrait ressembler à ceci :

{"status":"ok"}

En supposant que le Dashboard Viewer soit accessible sous son propre nom de domaine complet dédié, par exemple hostname.domain.com. Configurez la redirection directement vers la page principale du Dashboard Viewer en ajoutant les lignes suivantes dans le fichier de configuration apache ssl /etc/httpd/conf.d/ssl.conf (dans le bloc <VIRTUALHOST *:443> existant) :

<VirtualHost *:443> #find this existing block in your ssl configuration file and add the lines below

    # Rewrite only / without anything else to /skoor-dashboard-viewer/
    RewriteEngine On
    RewriteRule ^/$ https://%{SERVER_NAME}/skoor-dashboard-viewer/ [R,L]

Pour que cette configuration fonctionne, le répertoire DocumentRoot doit exister. Créez-le, puis redémarrez le serveur web à l'aide des commandes suivantes :

$ sudo mkdir -p /srv/eranger/html
$ sudo systemctl restart httpd

Système Dashboard Provider

Installez le paquet nodejs et dashboard-viewer-provider :

$ sudo yum install eranger-dashboard-viewer-provider

Configurez le Viewer Provider Dashboard Viewer en modifiant le fichier /etc/opt/eranger/eranger-dashboard-viewer-provider.json. Voici une brève description des propriétés disponibles :

Paramètre	Description
`logLevel`	Sélectionnez l'un des niveaux suivants : debug, info, Warning, error
`webserviceUrl`	Service web à partir duquel obtenir les données
`tenantId`	Identifie les différents locataires si plusieurs alimentent le même viewer de tableau de bord. La valeur préconfigurée est « default ». La connexion au locataire « default » ne nécessite pas de préfixe tenandId. Les autres locataires peuvent se connecter en ajoutant « <TENANTNAME>/ » avant le nom d'utilisateur
`viewerServices`	Ce paramètre est utilisé pour configurer un ou plusieurs viewers avec un nom, son URL et une clé pré-partagée. Le paramètre presharedKey doit être identique sur tous les fournisseurs qui alimentent le même Viewer Service Le paramètre url peut pointer directement vers le service du fournisseur si le viewer est installé sur l'hôte local : "url": "http://localhost:8092" Si le viewer est installé dans une zone démilitarisée (DMZ), l'URL doit pointer vers le port 443 qui est servi par Apache HTTP. "url": "https://<viewer server name or ip>/skoor-dashboard-viewer-service"
`presharedKey`	Cette clé doit être partagée entre le fournisseur du tableau de bord et le Dashboard Viewer Service. Ceci est nécessaire pour des raisons de sécurité, elle doit donc être remplacée par une valeur unique.

Exemple :

{
  "logLevel": "debug",
  "webserviceUrl": "http://localhost:8090",
  "authUrl": "http://localhost:8094",
  "tenantId": "default",
  "viewerServices": {
    "dashboard-viewer": {
      "url": "https://<viewer server name or ip>/skoor-dashboard-viewer-service",
      "presharedKey": "1234567890"
    }
  }
}

Redémarrez maintenant le service fournisseur :

sudo systemctl restart eranger-dashboard-viewer-provider.service

Mise à jour

Mettez à jour tous les paquets SKOOR à l'aide de yum update :

$ sudo yum update eranger-dashboards-*.rpm

Smoke test

Ouvrez l'URL https://<NOM du serveur de visualisation>/skoor-dashboard-viewer dans un navigateur Web. Un tableau de bord visible par l'utilisateur par défaut configuré doit s'afficher sans qu'il soit nécessaire de se connecter au préalable. Si disponible, il est possible de passer à un autre locataire en ajoutant le paramètre URL tenantId à l'URL : https://<NOM du serveur de visualisation>/skoor-dashboard-viewer?tenantId=someTenant

Dans le menu utilisateur, le lien Log In permet de se connecter avec un autre utilisateur, généralement un utilisateur qui permet d'afficher des informations privilégiées qui ne devraient pas être visibles pour l'utilisateur par défaut :

Cliquez sur Connexion et fournissez les informations d'identification, éventuellement avec un autre locataire avant le nom de connexion :

Les tableaux de bord privés devraient désormais être visibles.