4.2.7. Elements extras de l’installation

Prudence

Les élements décrits dans cette section sont des élements « 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.

Prudence

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.

4.2.7.1. Configuration des extras

Le fichier environments /group_vars/all/extra_vars.yml contient la configuration des extras :

---

vitam:
    ihm_recette:
        vitam_component: ihm-recette
        host: "ihm-recette.service.{{ consul_domain }}"
        port_service: 8445
        port_admin: 28204
        baseurl: /ihm-recette
        static_content: "{{ vitam_defaults.folder.root_path }}/app/ihm-recette"
        baseuri: "ihm-recette"
        secure_mode:
            - authc
        https_enabled: true
        secret_platform: "false"
        cluster_name: "{{ elasticsearch.data.cluster_name }}"
        session_timeout: 1800000
        secure_cookie: true
        use_proxy_to_clone_tests: "yes"
        metrics_enabled: true
        logback_rolling_policy: true
        logback_max_file_size: "10MB"
        logback_total_size_cap:
          file: 
            history_days: 10
            totalsize: "5GB"
          security:
            history_days: 10
            totalsize: "5GB"
        jvm_log: false
        performance_logger: "false"
        reconstruction:
        consul_check_business: 10 # value in seconds
        consul_admin_check: 10 # value in seconds
        acceptableRequestTime: 10 # value in seconds
        # metricslevel: DEBUG
        # metricsinterval: 3
        # metricsunit: MINUTES
        access_retention_days: 15 # Number of days for file retention
        access_total_size_cap: "14GB" # total acceptable size
        elasticsearch_mapping_dir: "{{ vitam_defaults.folder.root_path }}/conf/ihm-recette/mapping"
    library:
        vitam_component: library
        host: "library.service.{{ consul_domain }}"
        port_service: 8090
        port_admin: 28090
        baseuri: "doc"
        https_enabled: false
        secret_platform: "false"
        metrics_enabled: false
        logback_rolling_policy: true
        logback_max_file_size: "10MB"
        logback_total_size_cap:
          file: 
            history_days: 10
            totalsize: "5GB"
          security:
            history_days: 10
            totalsize: "5GB"
        jvm_log: false
        performance_logger: "false"
        reconstruction:
        consul_check_business: 30 # value in seconds
        consul_admin_check: 30 # value in seconds
        acceptableRequestTime: 10 # value in seconds
        # metricslevel: DEBUG
        # metricsinterval: 3
        # metricsunit: MINUTES
        access_retention_days: 15 # Number of days for file retention
        access_total_size_cap: "14GB" # total acceptable size

tenant_to_clean_before_tnr: ["0","1"]

# Period units in seconds
metricbeat:
    system:
        period: 10
    mongodb:
        period: 10
    elasticsearch:
        period: 10

docker_opts:
    registry_httponly: yes
    vitam_docker_tag: latest

gatling_install: false
docker_install: true # whether or not install docker & docker images

Avertissement

A 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/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 VITAM (en particulier, le nombre de machines), il peut être nécessaire d’allonger cette périodicité (en secondes).

Le fichier environments /group_vars/all/all/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 TNR.

# Example for git lfs ; uncomment & use if needed
#vitam_gitlab_itest_login: "account"
#vitam_gitlab_itest_password: "change_it_4DU42JVf2x2xmPBs"

Note

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

4.2.7.2. Déploiement des extras

Plusieurs playbooks d”extras sont fournis pour usage « tel quel ».

4.2.7.2.1. ihm-recette

Ce playbook permet d’installer également le composant VITAM ihm-recette.

ansible-playbook ansible-vitam-extra/ihm-recette.yml -i environments/<ficher d'inventaire> --ask-vault-pass

Prudence

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

4.2.7.2.2. 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 VITAM
• mongo-express (en docker ; une connexion internet est alors nécessaire)
• le composant VITAM library, hébergeant la documentation du projet
• le composant 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

Avertissement

Pour se connecter aux IHM, il faut désormais configurer reverse_proxy_port=443 dans l’inventaire.

ansible-playbook ansible-vitam-extra/extra.yml -i environments/<ficher d'inventaire> --ask-vault-pass