L'outil ORI-OAI-quick-install

Depuis la version 1.1 de ORI-OAI, ce package permet une installation et une prise en main beaucoup plus rapide du projet avec une configuration centralisée des paramètres de configuration et de déploiement les plus importants. Le principe est de n'éditer qu'un seul fichier de configuration qui est partagé par tous les modules de ORI-OAI. La mise en place de l'outil se fait donc plus rapidement sans avoir à ouvrir et à connaître le fonctionnement de chaque fichier de configuration.

Téléchargement de ORI-OAI-quick-install

Tout comme il est conseillé pour les modules, utilisez Subversion pour télécharger ORI-OAI-quick-install. Depuis le répertoire [ORI_HOME]/src, tapez la commande :

Vous pouvez aussi télécharger une version ZIP de ce module à cette adresse: https://sourcesup.renater.fr/frs/?group_id=374

Si vous faîtes le choix d'installer les modules ORI-OAI sur différents serveurs pour la production, nous vous conseillons de tout d'abord faire l'installation sur un unique serveur.
Vous pourrez ensuite déployer le module ori-oai-quick-install sur chacun des serveurs en n'installant sur chacun que le(s) module(s) désiré(s).

Architecture des modules

Les fichiers de déploiement

Le fichier build.properties ainsi que la plupart des fichiers de configuration des modules ont été modifiés pour remplacer les valeurs proposées par défaut par des variables du type [MA_VARIABLE]. Lors de la phase de déploiement, toutes ces variables sont donc remplacées dynamiquement par les valeurs que vous aurez définies dans le fichier de configuration central (commons-parameters.properties ; voir plus bas).

Les tâches ANT

Dans le but commun de simplifier l'installation de ORI-OAI, les tâches permettant l'installation de tous les modules ont été au maximum homogénéisées. Maintenant, la mise en place de la version standard d'un module se fait uniquement par l'exécution des tâches suivantes ANT suivantes :

  • init-build : Cette tâche permet de rapatrier le fichier de configuration central dans le module et de générer le fichier build.properties qui servira aux étapes suivantes en fonction des paramètres définis dans ce fichier de configuration central. Si le fichier de configuration central existe déjà en local, il est écrasé. De même pour le fichier build.properties.

Important : Cette tâche est à utiliser dès lors que vos paramètres centraux ont été modifiés et qu'ils doivent être répercutés au sein du module.

  • init : Cette tâche n'existe pas dans tous les modules. Elle permet d'initialiser un environnement propre au module comme par exemple une base de données ou la création du dossier qui contient l'index.
  • upgrade : Cette tâche n'existe pas dans tous les modules. Elle permet de faire des mises à jour sur l'environnement propre au module comme une migration du format de la base de données.
  • all : Cette tâche regroupe toutes les étapes nécessaires au déploiement comme la suppression des anciennes classes, la suppression du contexte du Tomcat, la compilation, la mise à jour de toutes les variables contenues dans les fichiers de configuration (à partir de celles définies dans le fichier central) et le déploiement de l'application au sein du Tomcat.

Architecture de ORI-OAI-quick-install

Le fichier principal qui nous intéresse dans ORI-OAI-quick-install est commons-parameters.properties. C'est ce fichier qui contient toutes les variables principales et les plus importantes et c'est ce fichier qu'il est nécessaire de modifier. Nous verrons dans la suite de ce document tous les paramètres que ce fichier contient. Nous avons également un fichier build.xml qui sert au déploiement avec ANT.

Configuration centralisée

Le fichier de configuration central commons-parameters.properties contient trois types de paramètres:

  • Chemin vers les sources de tous les modules
  • Paramètres communs aux applications
  • Paramètres propres aux différents modules

Installation des Tomcat

Depuis la version 1.6, les paramètres utilisés pour l'installation des serveurs tomcat (ports, mémoire allouée, etc.) se trouvent dans le fichier tomcat.properties.

Les tâches ANT pour le déploiement des modules

Lors d'un déploiement complet de ORI-OAI à partir de ORI-OAI-quick-install, il est possible d'utiliser les diverses tâches ANT que ce fichier contient. Ces diverses tâches ne sont que des appels aux tâches ANT définies dans les modules eux-mêmes.

Ces tâches sont les suivantes:

  • init-build-[NOM_MODULE] pour lancer la tâche init-build du module [NOM_MODULE]. Exemple: ant init-build-workflow
  • init-build pour lancer la tâche init-build sur tous les modules
  • init-[NOM_MODULE] pour lancer la tâche init du module [NOM_MODULE]. Exemple: ant init-indexing
  • init pour lancer la tâche init sur tous les modules
  • upgrade-[NOM_MODULE] pour lancer la tâche upgrade du module [NOM_MODULE]. Exemple: ant upgrade-harvester
  • upgrade pour lancer la tâche upgrade sur tous les modules
  • all-[NOM_MODULE] pour lancer la tâche all du module [NOM_MODULE]. Exemple: ant all-search
  • all pour lancer la tâche all sur tous les modules
  • No labels