.. _extrainstall:

.. |repertoire_deploiement| replace:: ``deployment/``
.. |repertoire_inventory| replace:: ``environments/``
.. |repertoire_playbook ansible| replace:: ``ansible-vitam/``

Éléments *extras* de l'installation
###################################

.. caution:: Les éléments décrits dans cette section sont des éléments "extras" ; il ne sont pas officiellement supportés, et ne sont par conséquence pas inclus dans l'installation de base. Cependant, ils peuvent s'avérer utile, notamment pour les installations sur des environnements hors production.

.. caution:: Dans le cas où l'installateur souhaite utiliser un `repository` de binaires qu'il gère par lui-même, il est fortement recommandé de rajouter ``--skip-tags "enable_vitam_repo"`` à la commande ``ansible-playbook`` ; dans ce cas, le comportement de ``yum`` n'est pas impacté par la solution de déploiement.

Configuration des *extras*
==========================

Le fichier |repertoire_inventory|``group_vars/all/advanced/extra_vars.yml`` contient la configuration des *extras* :

.. literalinclude:: ../../../../deployment/environments/group_vars/all/advanced/extra_vars.yml
     :language: yaml
     :linenos:

.. bug #113

.. warning:: À modifier selon le besoin avant de lancer le playbook ! Les composant ihm-recette et ihm-demo ont la variable ``secure_cookie`` paramétrée à ``true`` par défaut, ce qui impose de pouvoir se connecter dessus uniquement en https (même derrière un reverse proxy). Le paramétrage de cette variable se fait dans le fichier ``environments/group_vars/all/advanced/vitam_vars.yml``

.. note:: La section ``metricbeat`` permet de configurer la périodicité d'envoi des informations collectées. Selon l'espace disponible sur le `cluster` Elasticsearch de log et la taille de l'environnement :term:`VITAM` (en particulier, le nombre de machines), il peut être nécessaire d'allonger cette périodicité (en secondes).


Le fichier |repertoire_inventory|``group_vars/all/main/vault-extra.yml`` contient les secrets supplémentaires des *extras* ; ce fichier est encrypté par ``ansible-vault`` et doit être paramétré avant le lancement de l'orchestration du déploiement, si le composant ihm-recette est déployé avec récupération des :term:`TNR`.

.. literalinclude:: ../../../../deployment/environments/group_vars/all/main/vault-extra.yml.plain
   :language: ini
   :linenos:

.. note:: Pour ce fichier, l'encrypter avec le même mot de passe que ``vault-vitam.yml``.


Déploiement des *extras*
========================

Plusieurs playbooks d'*extras* sont fournis pour usage "tel quel".

ihm-recette
-----------

Ce *playbook* permet d'installer également le composant :term:`VITAM` ihm-recette.

.. code-block:: console

   ansible-playbook ansible-vitam-extra/ihm-recette.yml -i environments/hosts.<environnement> --ask-vault-pass

.. caution:: Avant de jouer le playbook, ne pas oublier, selon le contexte d'usage, de positionner correctement la variable ``secure_cookie`` décrite plus haut.


*Extras* complet
----------------

Ce playbook permet d'installer :
  - des éléments de monitoring système
  - un serveur Apache pour naviguer sur le ``/vitam`` des différentes machines hébergeant :term:`VITAM`
  - mongo-express (en docker ; une connexion internet est alors nécessaire)
  - le composant :term:`VITAM` library, hébergeant la documentation du projet
  - le composant :term:`VITAM` ihm-recette (utilise si configuré des dépôts de jeux de tests)
  - un reverse proxy, afin de fournir une page d'accueil pour les environnements de test
  - l'outillage de tests de performance

.. warning:: Pour se connecter aux :term:`IHM`, il faut désormais configurer ``reverse_proxy_port=443`` dans l'inventaire.

.. code-block:: console

   ansible-playbook ansible-vitam-extra/extra.yml -i environments/hosts.<environnement> --ask-vault-pass