Versions Compared

Old Version 1

changes.mady.by.user David Labardin

Saved on

compared with

New Version Current

changes.mady.by.user David Labardin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Concepts

Pour accéder à cette interface, vous devez pointer votre navigateur Web vers l'adresse affichée durant l'installation.

  • Par défaut, l'interface de visualisation est accessible sur le port dédié 7767 (via le protocole HTTP). Par exemple

Overview

To access the Interface, you must point your Web Browser to the URL provided during installation.

By default the Visualization Tool is accessible on the dedicated port 7767 (HTTP). For example
.130The file

Ce chapitre explique comment paramétrer l'interface de Visualisation.

 

This chapter explain how to configure the Visualization UI

  • Le fichier /etc/shinken/modules/webui.
cfg contains configuration parameters.
  • you can set 
    • the HTTPS
    • the port 
    • activated modules
    • the language
    • ... 

    •  

    HTTPS

    • cfg contient les paramètres de configuration.
    • Ce fichier contient la définition du module WebUI, module qui permet l'affichage de l'interface de visualisation.
    • Grace aux paramètres du module WebUI, vous pouvez paramétrer : 
      • le SSL et certificats
      • le port d'écoute 
      • le système SSO (Single Sign On)
      • l'activation des modules
      • la langue


    Panel
    titleSommaire

    Table of Contents


    SSL et certificats

    L'interface de visualisation peut être protégée par un accès HTTPS et des certificats.

    Les paramètres se trouvent dans le fichier /etc/shinken/modules/webui.cfg.

     

    Code Block
        # HTTPs part, enable if you want to set the visualisation interface listen in HTTPs mode
    # disabled by default. Set your own certificates.
    use_ssl                   0
    ssl_cert                  /etc/shinken/certs/server.cert
    ssl_key                   /etc/shinken/certs/server.key

     

    Activation du HTTPS

    • Pour activer le HTTPS:
      • la propriété est use_ssl
        • par défaut la valeur est à 0 (pas de HTTPS)
        • mettre la valeur à 1 pour l'activer

     

    Certificats

    • Activez les certificats en mettant à jour les 2 paramètres suivant:
      • ssl_cert=

    The UI can be now protected by an HTTPS access.

    In the webui.cfg,  

    • to activate the HTTPS:
      • use_ssl      0
        • by default it is set to 0. 
        • Set it to 1 to activate.
           
    • to set certificates by updating the 3 following parameters:
      • ssl_cert      /etc/shinken/certs/server.cert
      • ssl_key      =/etc/shinken/certs/server.key

     

    Info
    The files default files Les fichiers par défaut /etc/shinken/certs/server.cert and et /etc/shinken/certs/server.key are just samples that are provided with the installation and MUST be changed by your own certificates.

    Accessing to the UI will still use the default dedicated port 7766 (but in HTTPS).

    sont justes des exemples qui sont fournis avec l'installation, mais ces certificats ne sont pas approuvés et valides, vous DEVEZ les changer avec vos propres certificats..

    L'accès à l'interface se fera toujours via le port dédié par défaut 7767 (mais via le protocole HTTPS).

     

    Log in

    You must Sign in to access the Administration Tool :
    1. Enter your Username and Password
       
    2. Click the Login Button or hit Enter

     

     

    Info

    If Shinken is connected to an active directory, please use your usual active directory account (without the DOMAIN\ part).

    You can also use your active dorectory email address as your login.

     

     

    Warning

    If an error occurred (wrong login or password), you will be prompted again

     

    Link the Login authentication to an Active Directory Server

    Configure the auth_active_directory module

    Edit the auth_active_directory.cfg in /etc/shinken/modules:
     Property Example Description
    ldap_urildaps://myserverThe address of the Active Directory server.
    user userThe user name to connect to the lapd server
    password passwordThe password
    DCDC =google,DC=comBase OU for the users.

    Le port d'écoute

    Le port de l'interface de visualisation peut être modifié.

    Le paramètre se trouve dans le fichier /etc/shinken/modules/webui.cfg.

    Code Block
        #======== Listening address =========
    # host: IP address to listen to.
    #       note: 0.0.0.0 = all interfaces.
    host                      0.0.0.0
    # port to listen
    port                      7767

    Pour changer le port il suffit de modifier la valeur 7767 de la propriété port.

    Il est également possible de n'écouter que les IP de la propriété host. (par défaut, toutes les IP peuvent communiquer avec l'interface de visualisation).

     

    Paramétrage SSO

    L'interface de visualization peut être accessible via SSO (Single SignOn).

    Les paramètres se trouvent dans le fichier /etc/shinken/modules/webui.cfg.

     

    Code Block
        # Remote application authentification
    # if 1: allow the user to be load from a HTTP Header
    remote_user_enable          0

    # which HTTP header to get user name if remote_user_enable is 1
    remote_user_variable        X_Remote_User

    Voici un exemple de paramétrage ici.

     

    Modules

    Les modules qui seront chargés par le module Webui exposant l'UI de Visualisation sont listés via la propriété modules.

    Dans le fichier /etc/shinken/modules/webui.cfg,

    Code Block
        #======== Modules =========
    # Modules loaded by the Visualisation interface
    # Available:
    # - Cfg_password          : check password from the user configuration
    # - auth-active-directory : check password from active directory
    # - Mongodb               : [mandatory] use to save user data (hive, favorites, ...)
    # - webui-enterprise      : [mandatory]
    # - sla                   : [mandatory] read sla from this module definition
    modules                   Cfg_password, Mongodb,webui-enterprise, sla

     

    Pour activer un module :

      • utilisez le paramètre modules
      • la liste des modules disponibles sont écrits en commentaire dans le fichier ( Cfg_password, auth-active-directory, Mongodb...)

     

    Langues

    La langue de l'interface de visualisation peut être changée.

    Le paramètre se trouve dans le fichier /etc/shinken/modules/webui.cfg.

     

    Code Block
        #======== Lang =========
    # Select the lang that will be used by default on the UIs
    # Currently managed:
    # -en    (english)
    # -fr    (francais)
    lang                                fr

     

    Pour activer une langue :

      • utilisez le paramètre lang
      • A ce jour, 2 langues sont supportées: l'anglais (en) et le francais (fr)

    Il est souhaitable que la sortie des démons soient également définies dans la même langue.

    Pour cela, dans le fichier /etc/shinken/shinken.cfg

    • il faut dé-commenter ou rajouter la ligne 
      • language=fr
      • A ce jour, 2 langues sont supportées: l'anglais (en) et le francais (fr)

    Affichage des tuiles

    Il est possible de définir comment les tuiles des portails vont être affichées, selon si le statut, le contexte, ou le duo statut/contexte, veulent être mis en avant à l'utilisateur.

    Ce paramétrage n'agit en rien sur les statuts ou contextes de vos éléments en supervision, il s'agit ici uniquement de personnaliser leur affichage. Ce paramétrage est global, et affectera la visualisation de l'ensemble des utilisateurs et administrateurs de Shinken.

    Trois types de configurations sont possibles.

    Configuration par défaut

    1. Si un contexte est défini:
      La couleur de fond est celui du contexte (violet pour Prise en compte(Acknowledge), gris foncé pour une période d’arrêt (Downtime), ... )
      L'icône principale est celle du contexte, une icône complémentaire représentant le statut du tableau de bord est présent.

       

    2. Si aucun contexte n'est défini:
      Seule la couleur du statut est affiché (sur l'ensemble de la tuile).
      Et une seule icône centrale représente le statut du tableau de bord.

    Image Added Image Added

    Configuration "contexte et statut"


    1. Si un contexte est défini:

      la couleur de fond de la tuile se divise en deux :

      • au dessus, la couleur du contexte (violet pour Prise en compte(Acknowledge), gris foncé pour une période d’arrêt (Downtime), ... ).

      • en dessous, la couleur du statut (rouge pour Critique, vert pour Ok, ....).

      L'icône principale est celle du contexte, une icône complémentaire représentant le statut du tableau de bord est présent

    2. Si aucun contexte n'est défini:
      Seule la couleur du statut est affiché. (sur l'ensemble de la tuile)
      L’icône centrale représente le statut du tableau de bord, pas d'icône complémentaire.

    Image Added Image Added

    Configuration "le statut avant tout"


    1. Si un contexte est défini:

      la couleur de fond est celui du statut (rouge pour Critique, vert pour Ok, ....).

      L'icône principale est celle du statut, une icône complémentaire représentant le contexte est présent

    2. Si aucun contexte n'est défini:
      Seul la couleur du statut est affiché. (sur l'ensemble de la tuile)
      L’icône centrale représente le statut du tableau de bord, pas d'icône complémentaire.

    Image AddedImage Added

    Paramétrer sa configuration

    La configuration est accessible via une propriété du module webui, tiles_background, avec les valeurs possibles context, context_and_status, et status, correspondant à ces options respectives.

    Pour accéder à cette configuration, il faut modifier le fichier au chemin suivant de la configuration centrale :

    Code Block
    themeMidnight
    /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg

    Un fichier d'exemple permet de connaître les clés et valeurs disponibles au chemin correspondant de shinken-user-example :

    Code Block
    themeMidnight
    /etc/shinken-user-example/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg

    Then activate this module in the webui.cfg file

    Edit the webui.cfg file in /etc/shinken/modules

     Property Example Description

     modules            

    Cfg_password, auth-active-directory, Mongodb, webui-enterprise, sla

    		By default, auth-active-directory should be present in the line. If missing, add it to activate the module.
    Info
    It will first try to identify the login/pass provided in the via the active directory module, then check in the synchronizer database, and then reject it if not found or valid.