diff --git a/bienvenue.md b/bienvenue.md index d563a3bed079666e8e0f7a9022043cab88ef8b5a..f03ccf37d5862a7825165fc4706a725e8f2b08bd 100644 --- a/bienvenue.md +++ b/bienvenue.md @@ -2,8 +2,6 @@ # Bienvenue dans GTF -  - GTF (Gestionnaire de Tâches pour FME) est une application 100% web qui permet de publier sur internet des traitements conçus avec FME et de les mettre à disposition d'un grand nombre d'utilisateurs. C'est un outil de partage, de planification et de supervision de traitements FME. GTF offre des fonctions d'administration pour la création et la gestion des utilisateurs et l'attribution des droits sur les traitements. diff --git a/doc_module_gtf b/doc_module_gtf index 720ccec5a4ec17de6d2f114d06655a52329573c4..781d7b0eaa0429338d06e317324fc7d9e741ef9b 160000 --- a/doc_module_gtf +++ b/doc_module_gtf @@ -1 +1 @@ -Subproject commit 720ccec5a4ec17de6d2f114d06655a52329573c4 +Subproject commit 781d7b0eaa0429338d06e317324fc7d9e741ef9b diff --git a/doc_module_vitis b/doc_module_vitis index cdd6308200f2200b6f937078d2257270c64cd81f..90e745892389682b334ae87edef8aee8ce406f46 160000 --- a/doc_module_vitis +++ b/doc_module_vitis @@ -1 +1 @@ -Subproject commit cdd6308200f2200b6f937078d2257270c64cd81f +Subproject commit 90e745892389682b334ae87edef8aee8ce406f46 diff --git a/index_installation.rst b/index_installation.rst index f26635adf8c99d0df10fa5e266628ab217ec94fc..55720acbd3c2379a8c1ea7533ffda2cb2e31e5eb 100644 --- a/index_installation.rst +++ b/index_installation.rst @@ -4,5 +4,5 @@ Installation .. toctree:: :maxdepth: 2 - installation/linux/index.rst - installation/windows/index.rst \ No newline at end of file + installation/procedure_installation_gtf + installation/procedure_maj_gtf diff --git a/installation/linux/index.rst b/installation/linux/index.rst deleted file mode 100644 index a648eeff75eb8977e22b9447ac1f68235e253231..0000000000000000000000000000000000000000 --- a/installation/linux/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Installation de GTF sur Linux -============================= - -.. toctree:: - :maxdepth: 2 - - installation_linux \ No newline at end of file diff --git a/installation/linux/installation_linux.md b/installation/linux/installation_linux.md deleted file mode 100644 index cdd15f579cd0d4b0804bd0ced86d51c6da2b96b4..0000000000000000000000000000000000000000 --- a/installation/linux/installation_linux.md +++ /dev/null @@ -1,116 +0,0 @@ -# Procédure d'installation GTF sous linux - -## Prérequis - - L'installation est validée pour les distributions de type Debian (>=8) ou Ubuntu - - Les commandes dans la documentation suivante sont exécutées avec un compte administrateur ou un utilisateur possédant les - droits privilèges Administrateur. - - Une taille de 8 go est requise dans le cadre d'une installation GTF/FME Desktop - -> Dans la suite de la documentation, les commandes sont décrites sous un compte administrateur (root). Dans le cas où un utilisateur privilège est utilisé, les commandes seront précédées par sudo. - -## Mise à jour des paquets - -La mise à jour des dépôts linux permet de récupérer la dernière version des composants à installer, à savoir: -* Apache -* PostgreSql - - - apt-get update && apt-get upgrade - -## Installation de Apache - - apt-get install apache2 - -## Configuration du module ssl - - Dans le cadre d'une connexion sécurisé, merci de vous reporter à la documentation suivante : [Configuration SSL](http://www.veremes.com/configuration-ssl-apache) - - Comme indiqué, Veremes fournit des certificats SSL par défaut. Ces fichiers de configuration peuvent être récupérés par les commandes suivantes: - - wget https://s3.eu-west-3.amazonaws.com/veremes-dev-ressources/ssl/server.key - wget https://s3.eu-west-3.amazonaws.com/veremes-dev-ressources/ssl/server.crt - - Afin de terminer la procédure d'installation, vérifier que le mode ssl est bien activé. - - a2enmod ssl - Module ssl already enabled - -## Installation de Postgresql - - apt-get install postgresql - -Pour des raisons de sécurité, il est nécessaire de modifier le mot de passe de l'utilisateur postgres. - - su -postgres - psql - ALTER USER postgres WITH PASSWORD '<password>' - \q - exit -où <password> est un mot de passe alphanumérique de 8 caractères minimum (préconisation). - - -## Installation de l'application GTF - -Pour installer GTF, il faut télécharger l’installateur sur le site http://download.veremes.com, dans le répertoire gtf/gtfaaaa (où aaaa représente le millésime). Les codes d’accès (login et password) sont fournis par e-mail à la suite d’une commande ou demande d’évaluation. - -Ces informations peuvent être renvoyées sur simple demande à codes@veremes.com. - - cd /tmp - mkdir Installation - cd Installation - wget http://download.veremes.net/products/gtf/setup_gtf-xxx-linux.zip --user <user> --password <password> - -où <user\> et <password\> seront transmis lors de l'installation. - - - cd /tmp/installation - chmod -R 755 * - -Editer le fichier install.sh afin de définir les paramètres de votre installation. Les variables à modifier pour l’installation sont : - -* Répertoire d'installation -> dir='répertoire d'installation de l'application GTF' - -* Paramètre pour la connexion au SGBD -> serveur='adresse du serveur postgres' -> -> port='port du serveur postgres' - -* Nom de la base de données (vitis crée par défaut) -> bdd='base de données' - -* Compte SUPERUSER sur le SGBD -> dblogin='utilisateur' - -* Mot de passe du compte SUPERUSER -> dbpswd='mot de passe' - -* Compte Administrateur de l'application -> appAdmin=admin -* Son mot de passe -> appPswd=test - -L’installateur assure les opérations suivantes : - -* Copie du code du Serveur d’Application Vitis -* Installation du PHP -* Configuration du serveur HTTPS Apache -* Création de la base de données dans PostgreSql -* Création d’un compte administrateur dans PostgreSql - -Exécuter le script install.sh pour lancer l’installation. - - ./install.sh - -Attendre une minute environ pour obtenir un retour console. - -Un rapport d’installation install_report_dd-mm-yyyy.txt est généré dans le répertoire de téléchargement des ressources, il permet de savoir si l’installation s’est déroulée correctement. - - -## Test de connexion à GTF - -Le procédure de validation applicative est disponible à l'adresse suivante: -[Initialisation du compte Administrateur](../windows/initialisation_admin.md#Test_de_Connexion_du_compte_administrateur) diff --git a/installation/procedure_installation_gtf.md b/installation/procedure_installation_gtf.md new file mode 100644 index 0000000000000000000000000000000000000000..40e2e4d80de0a4816f57d2ce0e762271c409cf07 --- /dev/null +++ b/installation/procedure_installation_gtf.md @@ -0,0 +1,454 @@ +# Procédure d'installation + +GTF dispose d’un installateur spécifique VAI qui permet d’assurer l’installation et la mise à jour du produit sans perte de configuration ni de données. + +## 1. Préconisations techniques + +<table align="center" class="docutils" border="1"> +<thead valign="middle" align="center"> + <tr class="row-odd"> + <td> + <b>Poste</b> + </td> + <td> + <b>Configuration minimale</b> + </td> + <td> + <b>Configuration recommandée</b> + </td> + </tr> +</thead> + +<tbody valign="middle"> +<tr class="row-even"> + <td> + CPU + </td> + <td> + 2 coeurs + </td> + <td> + 4 coeurs + </td> +</tr> + +<tbody valign="middle"> +<tr class="row-even"> + <td> + Mémoire vive + </td> + <td> + 4 GB (8Gb sur un système 64-bit) + </td> + <td> + 8 GB (16Gb sur un système 64-bit) + </td> +</tr> + +<tr class="row-odd"> + <td> + Espace disque disponible + </td> + <td> + 8 GB + </td> + <td> + 60 GB + </td> +</tr> + +<tr class="row-even"> + <td> + Base de données + </td> + <td> + PostgreSql 9.3 ou plus + </td> + <td> + PostgreSql 9.3 ou plus + </td> +</tr> + +<tr class="row-odd"> + <td> + Serveur http + </td> + <td> + Apache 2.4.13 ou plus (avec mod_ssl) + </td> + <td> + Apache 2.4.13 ou plus (avec mod_ssl) + </td> +</tr> +</tbody> +</table> + +## 2. Installation des prérequis + +### Installation de FME + +Dans GTF, FME est en charge de l’exécution des projets. +Procéder en premier lieu à l'installation de FME pour que GTF puisse fonctionner et exécuter des traitements. + +[Procédure d'installation de FME en Anglais](https://docs.safe.com/fme/html/FME_Desktop_Documentation/FME_Desktop_Admin_Guide/FMEInstallation/Installing-FME-Desktop.htm) + +[Procédure d'installation de FME en Français](https://www.veremes.com/wp-content/uploads/fme_guide_installation-1.pdf) + +Si vous utilisez une version FE Database Edition de FME (Oracle), installer le client Oracle sur le serveur. + + Sur Linux, si vous voulez utiliser FME **2018**, exécuter le script suivant : +``` +cd /opt/fme-desktop-2018/metafile +sudo cp *.fmi ./dependencies/ +sudo cp *.fmf ./dependencies/ +``` + +### Installation d'Apache 2.4 + +GTF utilise le protocole sécurisé https qui assure le cryptage des échanges entre le Serveur d’Application Vitis et le poste client. Il est donc nécessaire d’installer une version spécifique du serveur http Apache compilé avec le module SSL. + +[Procédure d’installation Apache 2.4 pour Windows](http://www.veremes.com/installation-apache-2-4-mod_ssl-windows) + +[Procédure d’installation Apache 2.4 pour Linux](https://www.veremes.com/installation-apache-2-4-linux) + +### Installation de Postgresql + +GTF utilise une base Postgresql pour stocker les informations sur les projets FME et les demandes de traitement ainsi que sur les utilisateurs et leurs droits. Si Postgresql est déjà installé sur votre poste, cette étape est facultative. + +[Procédure d’installation Postgresql pour Windows](http://www.veremes.com/installation-postgresql-windows) + +[Procédure d’installation Postgresql pour Linux](https://www.veremes.com/installation-postgresql-linux) + +La base de données contenant l'application GTF doit utiliser le fuseau horraire **UTC**. + +Pour identifier le fuseau horraire utilisé par défaut dans votre base de données, exécuter la requête suivante : +``` +SHOW timezone; +``` + + + +Vous pouvez changer cette valeur en éditant la variable **timezone** qui se trouve dans la partie **Locale and Formatting** avant de lancer l'installation. + + + + +Si votre base est déjà existante, vous pouvez utiliser la requête suivante en remplaçant **[db_name]** par le nom de votre base de données : + +``` +ALTER DATABASE [db_name] SET timezone ='UTC'; +``` + +## 3. Installation de GTF + +Pour installer GTF, éditez le fichier install.cmd (Windows) ou install.sh (Linux) afin de définir les paramètres de votre installation. + +Les variables à modifier pour l’installation sont : + +<table align="center" class="docutils" border="1"> +<thead valign="middle" align="center"> + <tr class="row-odd"> + <td> + <b>Variable</b> + </td> + <td> + <b>Description</b> + </td> + </tr> +</thead> + +<tbody valign="middle"> +<tr class="row-even"> + <td> + dir + </td> + <td> + Répertoire d'installation (/var/www/gtf préférable pour Linux C:/server/gtf conseillé pour Windows) + </td> +</tr> + +<tr class="row-odd"> + <td> + serveur + </td> + <td> + Serveur de la base de données + </td> +</tr> + +<tr class="row-even"> + <td> + port + </td> + <td> + Port d'accès à la base de données + </td> +</tr> + +<tr class="row-odd"> + <td> + bdd + </td> + <td> + Nom de la base de données (La base de données peut être existante) + </td> +</tr> + +<tr class="row-odd"> + <td> + dblogin + </td> + <td> + Compte d'un superutilisateur de la base + </td> +</tr> + +<tr class="row-odd"> + <td> + dbpswd + </td> + <td> + Mot de passe du compte superutilisateur + </td> +</tr> + +<tr class="row-odd"> + <td> + apacheService + </td> + <td> + Nom du service Apache exploité par l'application + </td> +</tr> + +<tr class="row-odd"> + <td> + apachePort + </td> + <td> + Port du service https du serveur Apache + </td> +</tr> + +<tr class="row-odd"> + <td> + appAdmin + </td> + <td> + Compte PostgreSql de l'administrateur de l'application. Ce compte sera créé s'il n'existe pas. + </td> +</tr> + +<tr class="row-odd"> + <td> + appPswd + </td> + <td> + Mot de passe du compte précédent s'il doit être créé. Si le compte existe déjà cette valeur n'est pas exploitée. Il faut néammoins saisir une valeur car ce paramètre est obligatoire. + </td> +</tr> +</tbody> +</table> + +L’installateur de GTF assure les opérations suivantes : +- Copie du code du serveur d’application Vitis +- Copie du code du moteur GTF +- Installation et configuration de Pycron comme un service (Uniquement sur Windows) +- Installation du PHP +- Configuration du serveur HTTPS Apache +- Création de la base de données dans PostgreSQL +- Création d’un compte administrateur dans PostgreSQL + + +Sur Linux, donner les droits d’exécution aux fichiers install.sh et setup_gtf-[version_gtf].[build_gtf]. +``` +chmod +x install.sh +chmod +x setup_gtf-[version_gtf].[build_gtf] +``` + +Exécuter le script install.cmd ou install.sh pour lancer l’installation. + + +Sur Windows, il faut attendre une minute environ pour avoir un retour dans la console. + +Un rapport d’installation install_report_dd-mm-yyyy.txt est généré, il permet de savoir si l’installation s’est déroulée correctement. + +## 4. Configuration de PostgreSQL + +Il est nécessaire de configurer le serveur PostgreSQL pour permettre à l’application d’accéder à la base de données. + +*La procédure ci-dessous s’applique si le serveur PostgreSQL est sur la même machine que GTF. Si ce n’est pas le cas, il faut prévoir une configuration spécifique.* + +1. Editer le fichier pg_hba.conf de PostgreSQL : + + Immédiatement après « # IPv4 local connections » insérer la ligne : + + ``` + # IPv4 local connections + host gtfdatabase u_vitis 127.0.0.1/32 trust + host gtfdatabase u_scheduler 127.0.0.1/32 trust + ``` + + Immédiatement après « # IPv6 local connections » insérez la ligne : + + ``` + # IPv6 local connections + host gtfdatabase u_vitis ::1/128 trust + host gtfdatabase u_scheduler ::1/128 trust + ``` + +2. Redémarrer le service PostgreSQL + +## 5. Test de l'installation de GTF + +L'instance de GTF doit désormais être disponible à l’adresse : + +**https://[serveur]/gtf** + +Où <serveur> est l’adresse de la machine où vous avez installé l’application. + + La connexion à GTF par l’adresse localhost est impossible. + +Si vous vous connectez avec le protocole http, la connexion sera automatiquement redirigée vers https. + +Si vous avez créé vous-même votre propre certificat, votre serveur n’est pas sécurisé et votre navigateur va sans doute afficher un message d’alerte. + + + +Vous devrez créer une exception de sécurité dans votre navigateur avant de pouvoir accéder à votre site. + +Si vous utilisez un certificat valide ou si vous avez créé une exception de sécurité, vous devez arriver à la page de connexion : + + + +Vous pouvez vous connecter en utilisant le compte et le mot de passe définis lors de l’installation. + +La première chose à faire après la connexion est de s'attribuer des privilèges pour vous permettre d’exploiter toutes les fonctions d’administration et d’utilisation de GTF. + +Cliquez sur l’icône  pour passer en mode « Gestion des utilisateurs », choisissez l’onglet « Utilisateurs » (activé par défaut) et éditez votre compte. +- Attribuez les privilèges : gtf_admin et gtf_user à l’utilisateur +- Attribuez le groupe Administration à l’utilisateur + + + +Vous disposez maintenant de tous les droits pour administrer et utiliser GTF. Reconnectez-vous pour accéder aux nouvelles fonctionnalités. + +## 6. Configuration de GTF + +### 1. Configuration Générale + +Cliquer sur l’icône  pour passer en mode « Configuration ». + +Il est préférable de configurer un serveur SMTP pour pouvoir utiliser GTF. + + + +Il faut sauvegarder la configuration avant de pouvoir la tester. + +Si vous avez créé vous-même votre propre certificat, désactivez l’option "Vérifier la validité du certificat SSL". + +A partir de la version 2019.01.01, il est conseillé de générer un identifiant d'instance GTF. + +Allez dans « Configuration GTF », et cliquez sur le bouton "générer" pour avoir un identifiant GTF puis sauvegardez la configuration. + + + +### 2. Activation de votre licence GTF + +Toujours dans le mode configuration, cliquer sur la section "licence" pour demander/activer la licence GTF. + +Si vous ne disposez pas de licence GTF, vous pouvez envoyer un mail à l'adresse [codes@veremes.com](mailto:codes@veremes.com), ou cliquer sur le bouton "Demander le fichier de licence" (à condition d'avoir configurer un serveur SMTP). + +Si vous avez un fichier de licence GTF vous pouvez l'activer via le formulaire de cette section. + + + +### 3. Création d'un moteur GTF + +Cliquer sur l’icône  pour gérer vos moteurs. Cliquer sur l'objet serveur. + +La déclaration du serveur permet de définir les répertoires contenant l’ordonnanceur Pycron et le moteur GTF. + +Par défaut le serveur localhost est défini, il fonctionne pour une installation classique de GTF. + +  + +Ensuite, il faut définir les moteurs FME. Cliquer sur l'objet moteur FME du même mode. + +Un moteur FME est l'instance de FME en charge de l'exécution des projets. GTF permet d'exploiter différents moteurs hétérogènes. On peut ainsi exploiter un moteur FME 2015 en 32 bits et une instance de FME 2016 en 64 bits. + +**A partir de la version 2019.01.00 de GTF**, il est aussi possible d'exploiter une instance FME Serveur et/ou FME Cloud. Cette fonctionnalité est documentée en détail dans la partie Administration. + +La première étape consiste à déclarer un moteur FME exploitable par GTF. + +  + +  Il est conseillé de nommer le moteur FME en indiquant le numéro de version, le numéro de build et le nombre de bits. Par exemple : « FME2016 b16494-32b ». + +Le bouton 'Test' permet de vérifier la validité de la licence FME. Avec FME 2016, pour que la licence soit valide, copier le fichier de licence présent dans le répertoire C:\ProgramData\SafeSoftware\FME\Licenses) dans le répertoire \licenses du répertoire d'installation de FME2016. + +Il faut encore créer un moteur GTF. + +On entend par Moteur GTF la capacité d'exploiter un moteur FME dans GTF. La création d'un moteur GTF permet d'associer à un serveur un moteur et de définir une période de déclenchement de l'activité spécifique. Un moteur GTF est associé à un seul moteur FME mais plusieurs moteurs GTF peuvent exploiter le même moteur FME. + +L'ajout de moteurs GTF supplémentaires permet à l'administrateur d'appliquer une stratégie de traitement de projets en spécialisant par exemple certains moteurs et en permettant la parallélisation des traitements. + +cliquez sur l'objet moteur GTF du même mode et cliquez sur le bouton « Ajouter un moteur GTF » pour ouvrir le formulaire de création de moteur GTF. + +Attribuer un nom au moteur GTF et définir la période d'activité en minutes de ce dernier (période de déclenchement du moteur). On peut choisir de rendre inactif ce moteur, puis on sélectionne le serveur et le moteur FME à associer. Associer ensuite un ou plusieurs mots clés au moteur. + +  + + +  Associer un ou plusieurs mots clés à un moteur permet à l'administrateur de mettre en place une stratégie de distribution des traitements sur plusieurs moteurs GTF : quand un utilisateur crée une demande de traitement, un moteur spécifique est spécifiquement attribué. Chaque moteur GTF est associé à un ou plusieurs mots clés. Chaque projet FME est ensuite associé à un mot clé. L'affiliation d'un projet à un moteur GTF se fait ainsi à partir de mots clés. + L'administrateur peut choisir des mots clés existants et déjà affiliés à d'autres moteurs dans la partie de gauche 'Mots clés disponibles', ou saisir directement le nom d'un nouveau mot clé dans le bloc de droite 'Mot clé lié au moteur'. Un simple clic sur un mot clé disponible permet de le lier au moteur GTF. + + +Il est recommandé de nommer le moteur GTF selon cette règle : ID (auto) FME Version Service Pack. Par exemple : « #3 FME 2013 SP 3 ». + +Cliquer ensuite sur le bouton “Créer” pour finaliser la création du moteur GTF. + +### 4. Test du moteur GTF + +A ce stade, pour s'assurer du bon fonctionnement de GTF, il est recommandé de procéder à l'import de nouveaux traitements. Pour cela, Veremes met à disposition sur son site de téléchargement [vStore](https://vstore.veremes.net/store) un projets exemples au format .gex ou .fmw. + +Vous pouvez aussi ajouter un de vos propre projet via le mode "Publication". + +Le projet 'Admin\_Import' (associé au groupe Administration et installé automatiquement lors de l'installation de GTF) permet l'import de nouveaux traitements stockés dans un fichier .gex. Au préalable, l'administrateur doit être associé au groupe Administration pour pouvoir exploiter ces deux projets. + +Se connecter à GTF (compte administrateur) puis ajouter une demande. + +  + +Choisir le traitement "Admin-Import" puis dans « Fichier d'export GTF à importer (.gex) : », cliquer sur « Parcourir » et sélectionner le fichier .gex préalablement téléchargé. Définir ensuite le nom du rapport html à générer. Il indique la liste des projets importés, leurs clé et ID ainsi que le statut de l'importation : Inséré dans GTF, Mis à jour dans GTF ou Non mis à jour dans GTF. + +  Associer un ou plusieurs mots clés à un moteur permet à l'administrateur de mettre en place une stratégie de distribution des traitements sur plusieurs moteurs GTF : quand un utilisateur crée une demande de traitement, un moteur spécifique est spécifiquement attribué. Chaque moteur GTF est associé à un ou plusieurs mots clés. Chaque projet FME est ensuite associé à un mot clé. L'affiliation d'un projet à un moteur GTF se fait ainsi à partir de mots clés.Il est obligatoire d'insérer l'extension .html dans le champs Nom du rapport à générer. + +Le paramètre 'Que faire des projets existants déjà dans la base GTF (même Clé)' indique à GTF s'il doit charger ou pas les projets déjà existants dans la base GTF et identifiés de façon unique par l'attribut Clé (cet attribut est généré automatiquement et est associé de façon unique à chaque projet). + + - Si ce paramètre vaut 'Ne pas importer' et que le fichier .gex contient un projet FME avec une clé déjà existante dans la base GTF, alors le fichier n'est pas chargé. + - Inversement, si ce paramètre vaut 'Remplacer les projets existants', alors les projets dont la clé existe déjà dans la base de données GTF seront écrasés. + - Choisir 'Importer le projet avec un nouvel identifiant et un nouveau nom', si le projet FME avec la même clé existe déjà en base et que vous souhaitez importer le même projet mais avec un nouveau nom. Le projet est renommé en étant suffixé par la chaîne '(import date de l'import)'. + + + Cliquer sur « Créer la demande ». La demande est prise en compte et se retrouve dans la file d'attente du moteur GTF. + + S'assurer que la Demande ait bien été traitée en consultant le mode Supervision, puis retourner dans le mode Publication pour consulter la liste des traitements nouvellement importés. + + +## 7. Import des traitements d'administration + + Le projet 'Nettoyage des fichiers temporaires' est disponible sur notre site de téléchargement. Il permet les fonctions d'administration suivantes : + + - le nettoyage des fichiers temporaires stockés dans les répertoires temporaires de GTF et FME. + + + Pour importer ce fichier, procéder de la même manière que précédemment en téléchargeant sur le site [vStore](https://vstore.veremes.net/store) (répertoire gtf/gex) la ressource Cleaner. + + + Se connecter ensuite à GTF et faire une demande du Traitement Admin-Import. Choisir le fichier précédemment téléchargé. + Assurez-vous que dans le mode Publication, ce nouveau traitement ait bien été importé. + + L'administrateur peut procéder à la configuration spécifique de GTF en définissant le compte public, et mettant en place une stratégie de sécurité utilisateur. + + Il créé ensuite les utilisateurs et/ou les importe depuis un annuaire Active Directory. diff --git a/installation/procedure_maj_gtf.md b/installation/procedure_maj_gtf.md new file mode 100644 index 0000000000000000000000000000000000000000..a626b30d8ffe1e41066152e254293e64de49f6e4 --- /dev/null +++ b/installation/procedure_maj_gtf.md @@ -0,0 +1,143 @@ +# Procédure de mise à jour + +GTF dispose d’un installateur spécifique VAI qui permet d’assurer l’installation et la mise à jour du produit sans perte de configuration ni de donnée. + +## 1. Prérequis + +Avant toute mise à jour de GTF, penser à sauvegarder tous les fichiers que vous avez pu modifier, en dehors de l'application. (properties du moteur, licence GTF, license(s) FME, templates de mail pour la création de compte / récupération de mot de passe, ...). + +## 2. Mise à jour de GTF + +Pour mettre à jour GTF, éditer le fichier update.cmd (Windows) ou update.sh (Linux) afin de définir les paramètres de l'installation. + +Les variables à modifier pour la mise à jour sont : + +<table align="center" class="docutils" border="1"> +<thead valign="middle" align="center"> + <tr class="row-odd"> + <td> + <b>Variable</b> + </td> + <td> + <b>Description</b> + </td> + </tr> +</thead> + +<tbody valign="middle"> +<tr class="row-even"> + <td> + dir + </td> + <td> + Répertoire d'installation (/var/www/gtf préférable pour Linux C:/server/gtf conseillé pour Windows) + </td> +</tr> + +<tr class="row-odd"> + <td> + dblogin + </td> + <td> + Compte d'un superutilisateur de la base + </td> +</tr> + +<tr class="row-odd"> + <td> + dbpswd + </td> + <td> + Mot de passe du compte superutilisateur + </td> +</tr> + +<tr class="row-odd"> + <td> + apacheService + </td> + <td> + Nom du service Apache exploité par l'application + </td> +</tr> + +<tr class="row-odd"> + <td> + apachePort + </td> + <td> + Port du service https du serveur Apache + </td> +</tr> + +</tbody> +</table> + +L’installateur de GTF (en mise à jour) assure les opérations suivantes : +- Copie du code du serveur d’application Vitis +- Copie du code du moteur GTF +- Mise à jour du PHP +- Configuration du serveur HTTPS Apache +- Mise à jour de la base de données dans PostgreSQL + +Sur Linux, donner les droits d’exécution aux fichiers update.sh et setup_gtf-[version_gtf].[build_gtf]. +``` +chmod +x update.sh +chmod +x setup_gtf-[version_gtf].[build_gtf] +``` + +Exécuter le script update.cmd ou update.sh pour lancer l’installation. + +Sur Windows, attendre une minute environ pour avoir un retour dans la console. + +## 3. Spécificités liées aux versions + +### Version 2019.01.01 + +#### Tâches planifiées + +Dans GTF vous pouvez désormais planifier l'éxécution d'une demande. Pour que cette fonctionnalité fonctionne correctement il faut que votre base de données utilise le fuseau horraire **UTC**. Si ce n'est pas le cas vous devrez éxecuter la requête suivante en remplaçant **[db_name]** par le nom de la base de GTF : + +``` +ALTER DATABASE [db_name] SET timezone ='UTC'; +``` + +#### SMTP + +Les properties liées aux paramètrage SMTP ont été déplacées dans les properties de Vitis. + +**<u>Liste des properties concernées :</u>** + +``` +$properties['mail_sender'] = '************'; +$properties['nickname_sender'] = 'GTF v2019'; +$properties['smtp_host'] = '************'; +$properties['smtp_port'] = 587; +$properties['smtp_authentification'] = true; +$properties['smtp_login'] = '************'; +$properties['smtp_password'] = '************'; +``` + +Pour éviter que l'application n'utilise les informations de GTF à la place des properties de Vitis, il est préférable de déplacer la configuration SMTP du fichier **[dir]/vas/rest/conf/gtf/properties.conf** dans le fichier **[dir]/vas/rest/conf/properties.conf**. + + +#### Template de mail par défaut + +Vous pourrez mettre à jour votre template de mail par défaut pour intégrer les nouvelles fonctionnalités : +- Cryptage du résultat des traitements FME +- Utilisation de l'interface de fichier pour délocalisation du système de fichiers +- Utilisation d'un proxy interne à l'application pour améliorer la sécurité de vos logs et résultats FME. + +Dans la version **2019.01.01**, un nouveau template de mail fait son apparition **default-v2019.01.01**. + +Si vous avez modifié le template de mail **default**, il faudra reprendre votre template pour intégrer les nouveautés de **default-v2019.01.01**. + +Sinon, vous pourrez simplement copier-coller **default-v2019.01.01** dans **default**. Vous pouvez aussi ne pas tenir compte des ses améliorations, mais il est possible que votre template ne fonctionne plus lors de l'activation d'une nouvelle fonctionnalité. + +#### Utilisation de FME Serveur et FME Cloud + +Il faut générer un identifiant pour votre application GTF. + +Cliquez sur l’icône  pour passer en mode « Configuration ». Allez dans « Configuration GTF », et cliquez sur le bouton "générer" pour avoir un identifiant GTF puis sauvegardez la configuration. + + diff --git a/installation/windows/composants.md b/installation/windows/composants.md deleted file mode 100644 index fc121f3bc5cbe4e8111d99870830a5b71b826c2b..0000000000000000000000000000000000000000 --- a/installation/windows/composants.md +++ /dev/null @@ -1,82 +0,0 @@ -# Installation des composants pré-requis et de GTF - - -## Installation des Pré-requis - - ### Installation de FME - -Dans GTF, FME est en charge de l’exécution des projets. -Procéder en premier lieu à l'installation de FME pour que GTF puisse fonctionner et exécuter des traitements. - - -[Procédure d'installation de FME](http://documentation.veremes.net/public/fme/fme_guide_administration.pdf) - - - ### Installation du serveur https Apache 2.4 - -GTF utilise le protocole sécurisé https qui assure le cryptage des échanges entre le Serveur d’Application Vitis et le poste client. Il est donc nécessaire d’installer une version spécifique du serveur http Apache compilé avec le module SSL. - -[Procédure d’installation Apache 2.4 pour Windows](http://www.veremes.com/installation-apache-2-4-mod_ssl-windows) - -### Installation de Postgresql - -GTF utilise une base Postgresql pour stocker les informations sur les projets FME et les demandes de traitement ainsi que sur les utilisateurs et leurs droits. Si Postgresql est déjà installé sur votre poste, cette étape est facultative. - -[Procédure d’installation Postgresql pour Windows](http://www.veremes.com/installation-postgresql-windows) - -## Installation de GTF - -Editer le setup install.cmd (Windows) du répertoire 'installateur_gtf_application_web' contenu dans le répertoire de téléchargement des ressources, afin de définir les paramètres de votre installation. -Les variables à modifier pour l’installation sont : - -| Variable | Description | -|:-------|:-----------| -| dir | Répertoire d'installation (si le répertoire n'existe pas, il sera créé) | -| serveur |Serveur de la base de données | -|port |Port d'accès à la base de données| -|bdd |Nom de la base de données (La base de données peut être existante)| -|dblogin |Compte d'un super utilisateur de la base| -|dbpswd |Mot de passe du compte super utilisateur| -|apacheService |Nom du service Apache exploité par l'application| -|apachePort |Port du service https du serveur Apache| -|appAdmin |Compte PostgreSql de l'administrateur GTF. Ce compte sera créé s'il n'existe pas.| -|appPswd |Mot de passe du compte précédent s'il doit être créé. Si le compte existe déjà, cette valeur n'est pas exploitée mais la présence d'une valeur est obligatoire.| - - - - - -L’installateur assure les opérations suivantes : - -- Copie du code du Serveur d’Application Vitis -- Installation du PHP -- Configuration du serveur HTTPS Apache -- Création de la base de données dans PostgreSql -- Création d’un compte administrateur dans PostgreSql - -Exécuter le script install.cmd pour lancer l’installation. - -  Attendre une minute environ pour obtenir un retour console. - -Un rapport d’installation install_report_dd-mm-yyyy.txt est généré dans le répertoire de téléchargement des ressources, il permet de savoir si l’installation s’est déroulée correctement. - - - ## Test de l'installation de GTF - -L' instance de GTF doit désormais être disponible à l’adresse : https://\<serveur\>/gtf -où \<serveur\> est l’adresse de la machine où l’application est installée. - - Attention ! La connexion à GTF par l’adresse localhost est impossible. - - Si l'on se connecte avec le protocole http, la connexion est automatiquement redirigée vers https. - - Si vous avez généré un certificat de type "self signer", le serveur n’est pas sécurisé et le navigateur va afficher un message d’alerte. Créer alors une exception de sécurité afin de pouvoir accéder et se connecter à GTF. - - -Après exécution de l’installateur, il faut procéder à l’initialisation de l’application, c’est-à- dire à : - -- l'initialisation du compte administrateur de GTF -- l’installation du moteur GTF - - - diff --git a/installation/windows/index.rst b/installation/windows/index.rst deleted file mode 100644 index 70639bd29e651e125d9deea143a297bac311b904..0000000000000000000000000000000000000000 --- a/installation/windows/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -Installation de GTF sur Windows -=============================== - -Pour installer GTF, il faut télécharger l'installateur sur le site http://download.veremes.com, dans le répertoire gtf/gtfaaaa (où aaaa représente le millésime). -Les codes d'accès (login et password) sont fournis par e-mail à la suite d'une commande ou demande d'évaluation. - -Ces informations peuvent être renvoyées sur simple demande à codes@veremes.com. - -L'installateur comporte : - -- Installateur _gtf_application_web, exécutable et scripts d'installation, de mise à jour et de suppression de GTF. -- Moteur_gf.zip, archive d'installation du module GTF -- Pycron-0.5.9.0.exe, installateur de Pycron -- Procedure_installation_gtf_windows.pdf, la présente documentation. - - -Après téléchargement de l'installateur, décompresser l'intégralité de ces ressources dans un répertoire spécifique. Nous préconisons de nommer ce répertoire 'gtf_telechargement'. - - -Le processus d'installation de GTF sous Windows se déroule en 3 étapes - -.. toctree:: - :maxdepth: 2 - - composants - initialisation_admin - installation_moteur - mise_a_jour_gtf \ No newline at end of file diff --git a/installation/windows/initialisation_admin.md b/installation/windows/initialisation_admin.md deleted file mode 100644 index 8cf7c7f93a868233280095a42ce848b6016a27c9..0000000000000000000000000000000000000000 --- a/installation/windows/initialisation_admin.md +++ /dev/null @@ -1,41 +0,0 @@ -# Initialisation du compte Administrateur - -## Configuration du compte administrateur - -Le compte administrateur, défini en phase d'installation par la variable 'AppAdmin', dispose initialement des privilèges vitis\_user et vitis \_admin. - -La configuration du compte administrateur permet l'attribution des privilèges d'administration spécifiques à GTF, c'est à dire gtf\_admin : - -• Se connecter à GTF avec le compte administrateur - -• Mode Utilisateurs \> onglet Utilisateur, éditer le compte administrateur et lui attribuer les privilèges gtf\_admin. Attribuer à l'administrateur les autres privileges gtf\_author et gtf\_user. - -• Associer le compte courant au groupe Administration - -• Mettre à jour - -• Se déconnecter - -  - -En savoir plus sur les privilèges - -## Test de Connexion du compte administrateur - -A ce stade de l'initialisation, le compte administrateur peut se connecter à GTF ( https://\<serveur\>/gtf) et accéder à l'intégralité des 10 modes de l'application. - -Les 10 modes sont correctement affichés dans la barre de gauche : - -  - - - -Le compte administrateur peut procéder à une demande de traitement. Cette dernière restera en attente et ne sera pas exécutée. - -  3 traitements sont intégrés dans GTF : Admin-Import, Admin-export et Vérification des formulaires. - - - -Après avoir configuré le compte administrateur, procéder à l'installation du moteur GTF. - - diff --git a/installation/windows/installation_moteur.md b/installation/windows/installation_moteur.md deleted file mode 100644 index b14b757ba8d36093b5bcb127fbc577b53c212ed7..0000000000000000000000000000000000000000 --- a/installation/windows/installation_moteur.md +++ /dev/null @@ -1,209 +0,0 @@ - -# Installation du moteur GTF - -L'installation du moteur GTF se décline en 5 étapes : - -- Installation de Pycron -- Installation du moteur GTF -- Configuration du moteur GTF -- Configuration du serveur SMTP -- Activation de la licence - -## Installation de Pycron - -Pycron est le programme qui permet aux utilisateurs de systèmes Windows d'exécuter automatiquement des scripts, des commandes ou des logiciels à une date et une heure spécifiées à l'avance. Dans GTF, il permet l'exécution des demandes GTF aux dates et heures spécifiées. - -[Procédure d'installation de Pycron.](http://documentation.veremes.net/public/ressource/pycron_guide_installation.pdf#http://documentation.veremes.net/public/ressource/pycron_guide_installation.pdf) - -### Configuration de Pycron - -- Démarrer le service de Pyrcon - -Démarrer le service de pycron en ligne de commande : - - sc start PyCron - - ### Test de l'installation de Pycron - -Exécuter la commande suivante pour accéder à la liste des services de Windows : services.msc - -Rechercher dans la liste des services disponibles, le service Pycron (Python Cron Service). - -Vérifier que le service soit démarré et que le type de démarrage soit en mode Automatique. - - ### Déclaration du serveur Pyrcon dans GTF - -Dans GTF, indiquer le répertoire d'installation du Pycron dans le Mode Configuration \> Configuration GTF\> Répertoire de pycron. - - - **Test** : cette opération rajoute un répertoire 'Log' dans la fenêtre d'affichage des journaux du Mode Log. - -## Installation du Moteur - -Décompresser l'archive moteur\_gtf.zip, dans le répertoire d'installation au même niveau que les répertoires client et vas. - - - Lors de la décompression de l'archive gtf.engines, l'administrateur doit penser à modifier manuellement le fichier de configuration de la base de données PostgreSQL pour autoriser la connexion de l'utilisateur scheduler à la base de données créée lors de l'installation de GTF. Dans le répertoire d'installation de PostgreSQL (répertoire data), modifier à l'aide d'un éditeur de texte le fichier pg\_hba.conf en y insérant les lignes suivantes pour les deux connexions IPv4 et IPv6._ - - - -Immédiatement après « # IPv4 local connections » insérer la ligne : - - host<base de donnnées>u_scheduler 127.0.0.1/32 trust - -Immédiatement après « # IPv6 local connections » insérer la ligne : - - host<base de donnnées>u_scheduler ::1/128 trust - - - - _\<base de donnnées\> est le nom de la base de données créée en phase d'installation. (vitis par défaut)_ - - -Redémarrer le service PostgreSQL. - -## Configuration du moteur GTF - -### Déclaration du serveur - -La déclaration du serveur permet de définir les répertoires contenant l'ordonnanceur Pycron et le moteur GTF. - -- Mode Moteur\> Onglet Serveur : Ajouter un serveur - -- Nommer le serveur - -- Définir le répertoire d'installation de Pycron. - -- Définir le répertoire contenant le moteur GTF gtf.engines - -- Cliquer sur Créer - -  - - - - -### Déclaration d'un moteur FME - -Un moteur FME est l'instance de FME en charge de l'exécution des projets. GTF permet d'exploiter différents moteurs hétérogènes. On peut ainsi exploiter un moteur FME 2015 en 32 bits et une instance de FME 2016 en 64 bits. - -La première étape consiste à déclarer un moteur FME exploitable par GTF. - --Mode Moteurs \> Onglet Moteur FME : Ajouter un moteur FME - -- Nommer le moteur et indiquer le chemin du moteur fme.exe. - -- Associer le serveur désiré - -- Cliquer sur Créer - -  - - - Il est conseillé de nommer le moteur FME en indiquant le numéro de version, le numéro de build et le nombre de bits. Par exemple : « FME2016 b16494-32b ». - - Le bouton 'Test' permet de vérifier la validité de la licence FME. Avec FME 2016, pour que la licence soit valide, copier le fichier de licence présent dans le répertoire C:\ProgramData\SafeSoftware\FME\Licenses) dans le répertoire \licenses du répertoire d'installation de FME2016. - - - -### Déclaration de moteur GTF - -On entend par Moteur GTF la capacité d'exploiter un moteur FME dans GTF. La création d'un moteur GTF permet d'associer à un serveur un moteur et de définir une période de déclenchement de l'activité spécifique. Un moteur GTF est associé à un seul moteur FME mais plusieurs moteurs GTF peuvent exploiter le même moteur FME. - -L'ajout de moteurs GTF supplémentaires permet à l'administrateur d'appliquer une stratégie de traitement de projets en spécialisant par exemple certains moteurs et en permettant la parallélisation des traitements. - -Dans le mode Moteurs \>Onglet Moteur GTF, le bouton « Ajouter un moteur GTF » ouvre le formulaire de création de moteur GTF. - -Attribuer un nom au moteur GTF et définir la période d'activité en minutes de ce dernier (période de déclenchement du moteur). On peut choisir de rendre inactif ce moteur, puis on sélectionne le serveur et le moteur FME à associer. Associer ensuite un ou plusieurs mots clés au moteur. - - - - Associer un ou plusieurs mots clés à un moteur permet à l'administrateur de mettre en place une stratégie de distribution des traitements sur plusieurs moteurs GTF : quand un utilisateur crée une demande de traitement, un moteur spécifique est spécifiquement attribué. Chaque moteur GTF est associé à un ou plusieurs mots clés. Chaque projet FME est ensuite associé à un mot clé. L'affiliation d'un projet à un moteur GTF se fait ainsi à partir de mots clés._L'administrateur peut choisir des mots clés existants et déjà affiliés à d'autres moteurs dans la partie de gauche 'Mots clés disponibles', ou saisir directement le nom d'un nouveau mot clé dans le bloc de droite 'Mot clé lié au moteur'. Un simple clic sur un mot clé disponible permet de le lier au moteur GTF. - - - Il est recommandé de nommer le moteur GTF selon cette règle : ID (auto)\_ FME Version Service Pack. Par exemple : « #3 FME 2013 SP 3 ». - - - -  - - - -Cliquer ensuite sur le bouton 'Créer' pour finaliser la création du moteur GTF. - -## Configuration du serveur SMTP - -La phase de configuration du serveur SMTP est nécessaire à ce stade de l'initialisation, pour que l'administrateur puisse demander le fichier de licence GTF en envoyant un mail au service administratif de Veremes. - -Dans le mode Configuration,configuration GTF, la section serveur SMTP permet de procéder à la déclaration du serveur SMTP. - -## Activation du fichier de licence GTF - -L'installation du fichier de licence GTF est la dernière étape du processus d'initialisation de GTF. - -Dans le mode Configuration, la section Licence permet de demander un fichier de licence nécessaire pour activer les licences permanentes. - - -Le bouton « Demande de fichier de licence » permet d'envoyer au service administratif de Veremes une demande de génération de fichier de licence. Indiquer le numéro de licence fourni dans l'accusé de réception de votre commande, ainsi que l'adresse mail à laquelle le fichier doit être envoyé. - - -Une fois obtenu, indiquer l'emplacement du fichier de licence délivré par Veremes dans le champ 'Fichier.txt', puis cliquer sur 'Activer'. - -## Tests : Import de nouveaux traitements - -A ce stade, pour s'assurer du bon fonctionnement de GTF, il est recommandé de procéder à l'import de nouveaux traitements. Pour cela, Veremes met à disposition sur son site de téléchargement des projets exemples au format .gex. - -Le projet 'Admin\_Import' (associé au groupe Administration et installé automatiquement lors de l'installation de GTF) permet l'import de nouveaux traitements stockés dans un fichier .gex. Au préalable, l'administrateur doit être associé au groupe Administration pour pouvoir exploiter ces deux projets. - -Télécharger le fichier «exemples.gex» sur notre site de téléchargement. [http://download.veremes.com](http://download.veremes.com/) (répertoire gtf/gex) - -Se connecter à GTF (compte administrateur) puis ajouter une demande. - -  - - - -Choisir le traitement "Admin-Import" puis dans « Fichier d'export GTF à importer (.gex) : », cliquer sur « Parcourir » et sélectionner le fichier exemples.gex préalablement téléchargé. Définir ensuite le nom du rapport html à générer. Il indique la liste des projets importés, leurs clé et ID ainsi que le statut de l'importation : Inséré dans GTF, Mis à jour dans GTF ou Non mis à jour dans GTF. - - - Associer un ou plusieurs mots clés à un moteur permet à l'administrateur de mettre en place une stratégie de distribution des traitements sur plusieurs moteurs GTF : quand un utilisateur crée une demande de traitement, un moteur spécifique est spécifiquement attribué. Chaque moteur GTF est associé à un ou plusieurs mots clés. Chaque projet FME est ensuite associé à un mot clé. L'affiliation d'un projet à un moteur GTF se fait ainsi à partir de mots clés._Il est obligatoire d'insérer l'extension .html dans le champs Nom du rapport à générer. - - - Le paramètre 'Que faire des projets existants déjà dans la base GTF (même Clé)' indique à GTF s'il doit charger ou pas les projets déjà existants dans la base GTF et identifiés de façon unique par l'attribut Clé (cet attribut est généré automatiquement et est associé de façon unique à chaque projet). - -- Si ce paramètre vaut 'Ne pas importer' et que le fichier .gex contient un projet FME avec une clé déjà existante dans la base GTF, alors le fichier n'est pas chargé._ -- Inversement, si ce paramètre vaut 'Remplacer les projets existants', alors les projets dont la clé existe déjà dans la base de données GTF seront écrasés. -- Choisir 'Importer le projet avec un nouvel identifiant et un nouveau nom', si le projet FME avec la même clé existe déjà en base et que vous souhaitez importer le même projet mais avec un nouveau nom. Le projet est renommé en étant suffixé par la chaîne '(import date de l&'import)'. - - - -Cliquer sur « Créer la demande ». La demande est prise en compte et se retrouve dans la file d'attente du moteur GTF. - -S'assurer que la Demande ait bien été traitée en consultant le mode Supervision, puis retourner dans le mode Publication pour consulter la liste des traitements nouvellement importés. - -  - -3 nouveaux traitements sont désormais disponibles dans GTF. - - - -## Import des traitements d'administration - -Le projet 'Nettoyage des fichiers temporaires' est disponible sur notre site de téléchargement, via le projet admin.gex. Il permet les fonctions d'administration suivantes : - -- le nettoyage des fichiers temporaires stockés dans les répertoires temporaires de GTF et FME. - -Pour importer ce fichier, procéder de la même manière que précédemment en téléchargeant sur le site [http://download.veremes.com](http://download.veremes.com/) (répertoire gtf/gex) le fichier admin.gex. - -Se connecter ensuite à GTF et faire une demande du Traitement Admin-Import. Choisir le fichier admin.gex précédemment téléchargé. - -Assurez-vous que dans le mode Publication, ce nouveau traitement ait bien été importé : - - - - -Une fois le module GTF installé, l'administrateur peut procéder à la configuration spécifique de GTF en en définissant le compte public, et mettant en place une stratégie de sécurité utilisateur. - -Il créé ensuite les utilisateurs et/ou les importe depuis un annuaire Active Directory. - - diff --git a/installation/windows/mis_a_jour_gtf.md b/installation/windows/mis_a_jour_gtf.md deleted file mode 100644 index e9e93fad890899855841e37fbc13aef03c3e39a1..0000000000000000000000000000000000000000 --- a/installation/windows/mis_a_jour_gtf.md +++ /dev/null @@ -1,18 +0,0 @@ - - # Mise à jour de GTF - - - Télécharger le setup à l'adresse suivante [setup de GTF](http://download.veremes.net/products/gtf/setup_gtf-2017.01.03.b26443-win.zip) - - - Décompresser l'archive - - - Editer le fichier update.cmd - - ligne 15, (set dir=) indiquer l'emplacement de l'installation de GTF - - ligne 20, (set dbpswd=) indiquer le mot de passe de l'utilisateur postgres - - - Exécuter update.cmd en tant qu'administrateur - - - Télécharger le moteur de gtf à l'adresse suivante [Moteur GTF](http://download.veremes.net/products/gtf/gtf.engines.zip) - - - Décompresser l'archive gtf.engines.zip dans le répertoire d'installation au même niveau que les répertoires client et vas