Guide d installation

Transcription

1 Guide d installation Installation de la plateforme Vanilla 5.2 Auteur : Contact: Patrick Beaucamp info@bpm-conseil.com Date: 31/03/2016 Document: BPM_Vanilla_Installation_v5_2_FR.docx Vanilla Version 5.2

2 1 Introduction A propos de cette documentation Prérequis Base de données technique (pour le fonctionnement de Vanilla) Distribution Vanilla MySQL Distribution Vanilla PostgreSQL Distribution Vanilla H Serveur Environnement Windows Environnement Java Variables systèmes Ports disponibles Environnement Unix Environnement Java Ports disponibles Interface graphique Caractéristiques performances et générales Processeur Mémoire Espace disque Architecture & Installation Téléchargements des serveurs Téléchargements additionnels Restauration des bases de données Version MySQL Restauration en ligne de commande Sur windows Sur Linux Restauration depuis un client (windows) Version PostgreSQL Restauration en ligne de commande Sur windows Sur Linux Restauration avec pgadmin Version H Installation du serveur Version MySQL Fichier vanilla.properties /17

3 6.2 Version PostgreSQL Fichier vanilla.properties Version H Administration initiale Vanilla Setup Référentiel Première connexion au portail Documentations /17

4 1 Introduction La plateforme Vanilla est distribuée en téléchargement suivant 2 versions principales : MySQL (version déjà packagée) ou PostgreSQL (scripts et configuration packagés) H2 La plateforme comprend un serveur applicatif tomcat hébergeant les applications web et les scripts des bases de données. Le serveur est par défaut configuré pour s'exécuter en environnement localhost. Afin de mettre en production votre plateforme, suivez attentivement cette documentation. Les 3 phases expliquées dans ce document sont les suivantes : Restauration des bases de données Configuration et mise en place du serveur Administration initiale de la plateforme 1.1 A propos de cette documentation Cette documentation porte sur l'installation de la plateforme Vanilla (version 5.2, sortie Mars 2016). Elle présente les phases principales d'installation en décrivant les points importants. 4/17

5 2 Prérequis 2.1 Base de données technique (pour le fonctionnement de Vanilla) Si votre choix de base de données s est porté sur h2, aucune installation de serveur de base de données n est à prévoir. Sinon, le serveur de base de données Mysql ou Postgres doit être installé. Les prérequis décrits ici ne concernent que le serveur de base de données qui contiendra les bases de données nécessaires au fonctionnement de la plate-forme Vanilla. Votre entrepôt de données peut être situé sur un autre serveur de base de données (Sql Serveur, Oracle ou autre) Distribution Vanilla MySQL Nous préconisons l'utilisation de MySQL Serveur version 5.5. Nous ne sommes pas compatibles avec la version 5.6 et ultérieur. Le serveur doit être installé et accessible depuis le serveur hébergeant l'applicatif Vanilla (vérification de la configuration réseau et des accords de connexion). Les lignes de configuration Mysql suivantes doivent être ajoutées dans le fichier my.cnf (unix) ou my.ini (windows): #attention à ne pas mettre d espace avant et après le signe «=» lower_case_table_names=1 sql-mode="ansi" Un utilisateur spécifique doit être crée pour l accès à la base de données technique de vanilla. L utilisateur standard, utilisé dans le fichier de configuration vanilla.properties (voir partie X.X) est configuré comme suit : # Copier-coller les commandes sql suivante mysql> CREATE USER localhost identified by biplatform ; mysql> GRANT ALL PRIVILIEGES ON *.* TO localhost WITH GRANT ACCESS; #Si vous souhaitez configurer votre serveur à distance via un client mysql, ajoutez l utilisateur suivant mysql> CREATE USER % identified by biplatform ; mysql> GRANT ALL PRIVILIEGES ON *.* TO % WITH GRANT ACCESS; Si pour des questions de sécurité, vous souhaitez utiliser un autre utilisateur avec un autre mot de passe, il faudra changer les configurations standards d accès aux bases de données techniques définies dans le fichier vanilla.properties. 5/17

6 2.1.2 Distribution Vanilla PostgreSQL Nous préconisons l'utilisation de PostgreSQL Serveur version 9.3. Le serveur doit être installé et accessible depuis le serveur hébergeant l'applicatif Vanilla (vérification de la configuration réseau et des accords de connexion). Un utilisateur spécifique doit être crée pour l accès à la base de données technique de Vanilla. L utilisateur standard, utilisé dans le fichier de configuration vanilla.properties (voir partie X.X) est configuré comme suit : # Copier-coller les commandes sql suivante CREATE USER biplatform CREATEDBPASSWORD biplatform ; GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO biplatform; Si pour des questions de sécurité, vous souhaitez utiliser un autre utilisateur avec un autre mot de passe, il faudra changer les configurations standards d accès aux bases de données techniques définies dans le fichier vanilla.properties Distribution Vanilla H2 Aucune installation ni manipulation n'est requise concernant le serveur de base de données (embarqué). 6/17

7 3 Serveur 3.1 Environnement Windows Si vous désirez installer Vanilla sur un serveur Windows (nous préconisons l'utilisation de Windows 2008/2012 serveur R2), veuillez lire attentivement les points suivants Environnement Java Un environnement Java JDK7 doit être installé sur le serveur Variables systèmes Les variables JAVA_HOME et PATH doivent être renseignées comme suivant. JAVA_HOME référence le chemin du dossier Java. PATH doit être complétée (ajout de ';') avec la valeur '%JAVA_HOME%\bin' Ports disponibles Veuillez-vous assurez que les ports 8005, 8009, 8443 et 8080 ne sont pas déjà utilisés ni bloqués sur le serveur. Effectuez la même vérification pour les ports 8082 et 9092 dans le cas d'une utilisation d'une version H Environnement Unix Si vous désirez installer Vanilla sur un serveur Unix (nous préconisons l'utilisation de Debian et 8.x), veuillez lire attentivement les points suivants Environnement Java Un environnement Java JDK 7 doit être installé sur le serveur. Nous déconseillons fortement l utilisation des Open JDK disponibles sur les versions Linux. Il est recommandé d installer la JDK 7 disponible sur le site Oracle Ports disponibles Veuillez-vous assurez que les ports 8005, 8009, 8443 et 8080 ne sont pas déjà utilisés ni bloqués sur le serveur. Effectuez la même vérification pour les ports 8082 et 9092 dans le cas d'une utilisation d'une version H Interface graphique Si le serveur est installé sans interface graphique, l'installation d'une librairie supplémentaire est nécessaire. Sur une distribution debian exécuter la commande suivante: #apt-getinstall lib32gcc1 7/17

8 3.3 Caractéristiques performances et générales Processeur 2 Ghz en DUAL CORE sont recommandés pour un environnement de test. 8 à 12 cœurs seront nécessaire dans le cadre d un environnement de Mémoire 4 Go de mémoire RAM sont recommandés en environnement de test. 8 Go ou plus sont recommandés pour une installation de production Espace disque 20 Go d'espace disque libres sont nécessaires et recommandés 8/17

9 4 Architecture & Installation 4.1 Téléchargements des serveurs Les deux versions de la plateforme Vanilla et les fichiers spécifiques à une installation sur SGBD PostgreSQL sont disponibles en téléchargement à l'url suivante : Téléchargements additionnels Les modules de création d'objets décisionnels sont disponibles en téléchargement à l'url suivante : Les modules d'administration de la plateforme Vanilla sont disponibles en téléchargement à l'url suivante : 9/17

10 5 Restauration des bases de données Les scripts des bases de données sont distribués avec la plateforme Vanilla. Les trois SGBD supportés par défaut sont MySQL, PostgreSQL et H2. Nous détaillons ici la restauration des scripts concernant ces trois SGBD. 5.1 Version MySQL Les scripts de la version MySQL sont accompagnés d'un fichier HOWTO vous décrivant les phases de la restauration. Restaurez vos bases depuis votre interface d'administration (scripts créés via MySQLAdministrator) ou en ligne de commande Restauration en ligne de commande Sur windows Dans l interface cmd.exe : cd«chemin_installation_mysql\bin».\mysql.exe ubiplatform pbiplatform<chemin_script\vanilla_5_ga_db_mysql_repository44.sql.\mysql.exe ubiplatform pbiplatform<chemin_scrpt\vanilla_5_ga_db_mysql_sampledata.sql.\mysql.exe ubiplatform pbiplatform<chemin_script\vanilla_5_ga_db_mysql_vanilla.sql.\mysql.exe ubiplatform pbiplatform<chemin_script\vanilla_5_ga_db_mysql_vanilla_kpi_sample.\mysql.exe ubiplatform pbiplatform<chemin_script\vanilla_5_ga_db_mysql_vanilladata.sql Sur Linux Entrer les lignes de commande suivante : mysql ubiplatform pbiplatform<chemin_script/vanilla_5_ga_db_mysql_repository44.sql mysql ubiplatform pbiplatform<chemin_scrpt/vanilla_5_ga_db_mysql_sampledata.sql mysql ubiplatform pbiplatform<chemin_script/vanilla_5_ga_db_mysql_vanilla.sql mysql ubiplatform pbiplatform<chemin_script/vanilla_5_ga_db_mysql_vanilla_kpi_sample mysql ubiplatform pbiplatform<chemin_script/vanilla_5_ga_db_mysql_vanilladata.sql 10/17

11 5.1.2 Restauration depuis un client (windows) Installez mysqlworkbench (téléchargeable ici). Créer la connexion à votre server mysql Une fois la session lancée sur votre connexion, cliquez sur «Data Import/Restore» Cliquez sur «Import from Self-contained file» et parcourez vos répertoire pour sélectionner un des fichiers de restauration.sql. Puis cliquez sur le bouton «Start import». Faites de même pour chaque fichier.sql de restauration 11/17

12 5.2 Version PostgreSQL Les scripts de la version PostgreSQL sont accompagnés d'un fichier HOWTO vous décrivant les phases de la restauration. Restaurez vos bases depuis votre interface d'administration (scripts créés via pgadmin) ou en ligne de commande Restauration en ligne de commande Sur windows Dans l interface cmd.exe : cd«chemin_installation_mysql\bin».\psql -U biplatform -W < "chemin_script\vanilla_5_ga_db_mysql_repository44.sql.\psql -U biplatform -W < "chemin_script\vanilla_5_ga_db_mysql_sampledata.sql.\psql -U biplatform -W < "chemin_script\vanilla_5_ga_db_mysql_vanilla.sql.\psql -U biplatform -W < "chemin_script\vanilla_5_ga_db_mysql_vanilla_kpi_sample.\psql -U biplatform -W < "chemin_script\vanilla_5_ga_db_mysql_vanilladata.sql Sur Linux Entrer les lignes de commande suivante : pour chaque commande il faudra entrer le mot de passe «biplatform» psql-u biplatform -W <chemin_script/vanilla_5_ga_db_mysql_repository44.sql psql-u biplatform -W <chemin_script/vanilla_5_ga_db_mysql_sampledata.sql psql-u biplatform -W <chemin_script/vanilla_5_ga_db_mysql_vanilla.sql psql-u biplatform -W <chemin_script/vanilla_5_ga_db_mysql_vanilla_kpi_sample psql-u biplatform -W <chemin_script/vanilla_5_ga_db_mysql_vanilladata.sql Restauration avec pgadmin Télécharger l outil pgadmin (disponible ici) Créer la base de données repository5, sampledata, vanilla, vanilla_kpi and vanilladata depuis pgadmin. Faites un clic droit sur chacune de ces bases de données et cliquer sur restore. Parcourez les scripts.backup correspondant à chaque base de données. 5.3 Version H2 Le serveur packagé H2 contient déjà les bases de données nécessaires au fonctionnement de la plateforme Vanilla et sont présentes dans le serveur applicatif et démarrés automatiquement au lancement du serveur. Aucune manipulation n'est donc nécessaire si vous possédez la version H2. 12/17

13 6 Installation du serveur Vos bases de données nécessaires au fonctionnement de la plateforme Vanilla restaurées (version H2 non concernée par la phase de restauration des bases de données), la plateforme livrée est fourni par défaut avec une configuration 'localhost'. Afin de passer votre plateforme en production, lisez attentivement les paragraphes ci-dessous. Ne pas extraire la plate-forme Vanillatomcat dans un répertoire dont le nom du chemin contiendrait un espace. La configuration de la plateforme s'effectue dans le dossier suivant : 'vanilla-conf'. Le fichier log.xml est à laisser dans l'état : pas de modifications. 6.1 Version MySQL Fichier vanilla.properties Le fichier vanilla.properties contient les références aux bases de données nécessaires au fonctionnement de la plateforme Vanilla. Par défaut, toutes les références sont en 'localhost', veuillez modifier les connections (si nécessaires) afin de vous connecter à votre SGBD. Si vous avez créé un utilisateur différent de biplatform et/ou avec un mot de passe différent de biplatform, veillez à mettre à jour les lignes de la forme suivante : bpm.*.user avec le nom de votre utilisateur bpm.*.password avec le mot de passe de votre utilisateur. Exemple de ligne à modifier : bpm.vanilla.database.username=votre_nom_utilisateur bpm.vanilla.database.password=votre_password_utilisateur 13/17

14 6.2 Version PostgreSQL Fichier vanilla.properties Par défaut le fichier vanilla.properties contient la configuration pour mysql. S il existe dans le dossier vanilla_conf un fichier nommé vanilla.postgres.properties, renommer le fichier vanilla.properties en vanilla.mysql.properties, et renommer le fichier vanilla.postgres.properties en vanilla.properties. Le fichier vanilla.properties contient les références aux bases de données nécessaires au fonctionnement de la plateforme Vanilla. Par défaut, toutes les références sont en 'localhost', veuillez modifier les connections (si nécessaires) afin de vous connecter à votre SGBD. Si vous avez créé un utilisateur différent de biplatform et/ou avec un mot de passe différent de biplatform, veillez à mettre à jour les lignes de la forme suivante : bpm.*.user avec le nom de votre utilisateur bpm.*.password avec le mot de passe de votre utilisateur. Exemple de ligne à modifier : bpm.vanilla.database.username=votre_nom_utilisateur bpm.vanilla.database.password=votre_password_utilisateur 6.3 Version H2 La version H2 ne demande aucune modification de votre part concernant ces fichiers de configuration car les bases de données sont embarquées dans le serveur applicatif. 14/17

15 7 Administration initiale Une fois votre configuration serveur effectuée, veuillez démarrer le serveur (start-vanilla.cmd ou startvanilla.sh suivant votre environnement d'exécution). Votre serveur indique qu'il est démarré par le message 'INFO : Vanilla Server startup in xx ms'. 7.1 Vanilla Setup Votre serveur démarré, il est configuré par défaut pour fonctionner en localhost. Pour modifier l'adresse du serveur, ouvrir et modifier le fichier «vanilla-conf/vanilla.properties» et changer la ligne suivante : bpm.vanilla.server.url= 7.2 Référentiel Le référentiel par défaut fourni dans la plateforme Vanilla est : Rendez-vous dans la vue 'Repositories Administration' du module EnterpriseServices. Modifiez ici le champ URL de votre référentiel (si nécessaire) en mettant l ip de votre serveur à la place de localhost puis cliquez sur Update. 15/17

16 8 Première connexion au portail Afin d'établir votre première connexion au portail (une fois le serveur démarré), veuillez démarrer un navigateur internet et renseigner l'url suivante : (ip_de_votre_serveur est à remplacer par l'ip ou le nom de votre serveur si un DNS est configuré) La page d'accueil du portail Vanilla apparaît : 16/17

17 9 Documentations Les documentations relatives aux applications web, aux modules d'administration et de création des objets décisionnels de la suite Vanilla sont disponibles dans les modules en eux-mêmes et en téléchargement à l'url suivante : 17/17