Spécifcation technique

Transcription

1 Spécifcation technique ITSM Cockpit Page: 1 / 21

2 Table des matières Introduction... 4 Architecture... 5 Confguration... 7 I.Logiciels installés...7 II.Localisation des fchiers...7 A.Base de données... 7 B.ITSM Cockpit... 7 III.Allocation de la mémoire...7 IV.Tâches planifées...8 V.Lancement des applications...8 VI.Batchs ITSM Cockpit...8 Arrêt / Démarrage de l application ITSM Cockpit...10 I.Séquencement...10 II.Base de données MariaDB...10 A.Vérifer le statut de l'application B.Stopper l'application C.Démarrer l'application III.ITSM Cockpit Portal...11 IV.ITSM Cockpit Engine...11 V.ITSM Cockpit Manager...12 A.Vérifer le statut de l'application B.Stopper l'application C.Démarrer l'application Sauvegardes et restaurations I.Sauvegardes...13 A.Fichiers de confguration et librairies B.Application C.Documents D.Base de données II.Restaurations...14 A.Fichiers B.Base de données Eléments à surveiller A.Système des serveurs B.Sauvegardes C.Application ITSM Cockpit Mises à jour I.Mise à jour de l'instance ITSM Cockpit...17 A.Sauvegarde B.Mise à jour de la base de données C.Mise à jour d'itsm Cockpit Portal D.Mise à jour d'itsm Cockpit Engine (mode local) Page: 2 / 21

3 E.Mise à jour d'itsm Cockpit Engine (mode déporté) II.Mise à jour d'itsm Cockpit Manager...20 III.Mise à jour de la licence...21 Page: 3 / 21

4 Introduction Ce document s'adresse aux techniciens en charge de l'administration courante des différents composants liés à l'application ITSM Cockpit. Il décrit les modes opératoires des principales tâches d'administration ainsi que les éléments à superviser afn de s'assurer du bon fonctionnement de l'application ITSM Cockpit. Il indique quels sont les fchiers de confguration et de logs et comment y accéder. Il défnit les procédures à suivre afn de mettre à jour les différents composants. Page: 4 / 21

5 Architecture Une instance ITSM Cockpit est composée de plusieurs éléments : Une base de données Un ou plusieurs portails Un ou plusieurs moteurs Le schéma ci-après décrit l'architecture d'une instance ITSM Cockpit simple. Page: 5 / 21

6 Le schéma ci-après décrit l'architecture ITSM Cockpit avec plusieurs moteurs déportés sur des réseaux différents. Page: 6 / 21

7 Confguration I. Logiciels installés Système d'exploitation Base de données Utilisation ITSM Cockpit Portal Version 2 ITSM Cockpit Engine ITSM Cockpit Manager Ubuntu server (64 bits) Debian (64 bits) MariaDB 5.X (64 bits) Logiciel II. Localisation des fchiers A. Base de données Fichier Utilisation Localisation koaly.cnf Confguration de la base de données MariaDB /etc/mysql/conf.d/ syslog Logs de la base de données MariaDB /var/log/ B. ITSM Cockpit Répertoire /home/koaly/backups /var/lib/mysql/ /home/koaly/exp/documents /home/koaly/exp/engine /home/koaly/exp/portal /home/koaly/management-interface /home/koaly/update /home/koaly/tools Utilisation Sauvegardes Données Base de données MariaDB Données Fichiers (documents, pièces jointes, etc.) ITSM Cockpit Engine ITSM Cockpit Portal ITSM Cockpit Manager Fichiers de mise à jour Outils (sauvegarde, etc.) III. Allocation de la mémoire L'allocation de la mémoire pour chacun des composants d'une instance ITSM Cockpit est confgurable en fonction de l'architecture et des serveurs utilisés. Afn de modifer la mémoire allouée pour chacun des composants, il faut éditer les fchiers décrits dans le tableau suivants. Page: 7 / 21

8 Composant Fichier Paramètre Valeur par défaut Base de données /etc/mysql/conf.d/koaly.cnf innodb_buffer_pool_size 512M Portail /etc/init.d/koaly-exp-portal MAX_HEAP 1536m Moteur /etc/init.d/koaly-exp-engine RT_MAX_HEAP 1536m Le tableau suivant indique les valeurs recommandées par composant en fonction de la mémoire physique disponible sur le serveur, dans le cas où tous les composants sont installés sur un serveur unique. Mémoire physique Base de données Portail Moteur 2 Gb 128M 1024m 768m 4 Gb 512M 1536m 1536m 8 Gb 2048M 4096m 2048m 16 Gb 4096M 9216m 3072m IV. Tâches planifées Liste des tâches planifées au niveau du planifcateur de tâches du système Tâche Description Fréquence /home/koaly/tools/koaly_exp_db_dump Exécute un Dump de la base de données 1 fois par jour V. Lancement des applications Mode de lancement des applications Service Description Démarrage koaly-exp-engine ITSM Cockpit Engine Automatique koaly-exp-portal ITSM Cockpit Portal Automatique koaly-management-interface ITSM Cockpit Manager Automatique mysql Base de données MariaDB Automatique VI. Batchs ITSM Cockpit Un planifcateur interne permet d'exécuter des batchs régulièrement. Il s'agit de bacths techniques nécessaires au bon fonctionnement de l'application. Les bacths sont exécutés par le portail. Batch Liste des batchs Planifcateur de tâches Module «Tâches» Planifcation des tâches Fonction Agrégation des données Module «Infrastructure» Consolidation des données du capacity planning Page: 8 / 21

9 Purge Archivage Statistiques JMS Module «Supervision» Consolidation des données des contrôles avec graphique Suppression des données obsolètes (logs, tâches acquittées, etc.) Archivage des données anciennes dans une seconde base de données Récupération et mise à jours des statistiques du Bus Afn de confgurer les batchs (portail d'exécution, statut, horaire, etc.), il faut : Se connecter au portail ITSM Cockpit. Ouvrir le menu «Administration / Paramétrage / Outils / Planning des batchs». Page: 9 / 21

10 Arrêt / Démarrage de l application ITSM Cockpit I. Séquencement Arrêt : 1. ITSM Cockpit Engine 2. ITSM Cockpit Portal 3. ITSM Cockpit Manager 4. Base de données MariaDB Démarrage : 1. Base de données MariaDB 2. ITSM Cockpit Manager 3. ITSM Cockpit Portal 4. ITSM Cockpit Engine Note : L'interface de gestion ITSM Cockpit Manager est indépendante de l'application ITSM Cockpit. Elle peut être arrêtée et démarrée sans impacter l'application ITSM Cockpit. II. Base de données MariaDB A. Vérifer le statut de l'application Commande : sudo service mysql status Résultat si l'application est démarrée : Server version 5.5.XX-MariaDB-1ubuntu0.XX.XX.X-log... Uptime: XX days XX hours XX min XX sec Résultat si l'application est arrêtée : MariaDB is stopped. B. Stopper l'application Commande : sudo service mysql stop Résultat : Page: 10 / 21

11 Stopping MariaDB database server mysqld [OK] C. Démarrer l'application Commande : sudo service mysql stop Résultat : Starting MariaDB database server mysqld [OK] III. ITSM Cockpit Portal Se connecter à l'itsm Cockpit Manager du serveur cible (par défaut: Ouvrir le menu de gestion des portails. Ouvrir le panneau de contrôle du portail. Ouvrir l'onglet «Contrôle». Vérifer le statut de l'application : Contrôler le statut actuel. Cliquer sur «Recharger» afn de mettre le statut à jour. Démarrer l'application : Cliquer sur «Stopper». Cliquer sur «Recharger» afn de mettre le statut à jour. Stopper l'application : Cliquer sur «Arrêter». Cliquer sur «Recharger» afn de mettre le statut à jour. IV. ITSM Cockpit Engine Se connecter à l'itsm Cockpit Manager du serveur cible (par défaut: Ouvrir le menu de gestion des moteurs. Ouvrir le panneau de contrôle du moteur. Ouvrir l'onglet «Contrôle». Note : Le menu de contrôle des moteurs est accessible depuis le portail ITSM Cockpit (menu Administration / Paramètres techniques / Moteurs) Vérifer le statut de l'application : Contrôler le statut actuel. Cliquer sur «Recharger» afn de mettre le statut à jour. Démarrer l'application : Cliquer sur «Stopper». Page: 11 / 21

12 Cliquer sur «Recharger» afn de mettre le statut à jour. Stopper l'application : Cliquer sur «Arrêter». Cliquer sur «Recharger» afn de mettre le statut à jour. ITSM Cockpit Administration Linux V. ITSM Cockpit Manager A. Vérifer le statut de l'application Commande : sudo service koaly-management-interface status B. Stopper l'application Commande : sudo service koaly-management-interface stop C. Démarrer l'application Commande : sudo service koaly-management-interface start Page: 12 / 21

13 Sauvegardes et restaurations I. Sauvegardes A. Fichiers de confguration et librairies Sauvegarder les fchiers de confguration (koaly.ini, etc.) après chaque modifcation. B. Application Sauvegarder les fchiers de l'application ITSM Cockpit (/home/koaly/exp) après chaque modifcation. C. Documents Réaliser une sauvegarde quotidienne du répertoire: /home/koaly/exp/documents D. Base de données U n d u m p d e l a b a s e d e d o n n é e s e s t r é a l i s é r é g u l i è r e m e n t v i a l e s c r i p t «/home/koaly/tools/koaly_exp_db_dump» lancé depuis le planifcateur du système. Le dump génère un fchier SQL compressé et stocke ce fchier dans le répertoire «/home/koaly/backups/database». Le format du fchier est «KOALYEXP_AAAAMMJJ_HHMM.gz». Les dix derniers fchiers sont conservés. Réaliser une sauvegarde quotidienne du répertoire des dumps. Conserver la sauvegarde quotidienne durant une semaine au moins. Afn de réaliser un dump manuel (si besoin) en ligne de commande, il faut exécuter la commande suivante. Commande : mysqldump koalyexp -u utilisateur -pmotdepasse -BFcq --single-transaction > nom_fchier.sql Description de la commande : Commande : mysqldump Options : u : utilisateur SQL p : mot de passe de l'utilisateur SQL B : indique «USE dbname» au niveau du fchier SQL de dump. F : effectuer un fush des logs avant de lancer la sauvegarde c : générer des INSERTs complets des données Page: 13 / 21

14 q : permet d'accélérer la sauvegarde des tables volumineuses single-transaction : génère le dump dans une seule transaction afn que le dump soit consistant nom_fchier.sql : nom du fchier SQL généré par le dump II. Restaurations A. Fichiers La restauration des fchiers (confguration, librairies, application, documents) s'effectue par recopie des fchiers. B. Base de données Il est possible de restaurer les fchiers de dump SQL. Commande : mysql -u root -p Indiquer le mot de passe. Si nécessaire, supprimer l'ancienne base de données ITSM Cockpit. DROP DATABASE koalyexp; Créer la base de données. CREATE DATABASE koalyexp; Sélectionner la base de données ITSM Cockpit. USE koalyexp; Restaurer le dump. source xxxx.sql; Description des options : u : utilisateur SQL p : mot de passe de l'utilisateur SQL xxxx.sql : nom du fchier à restaurer Page: 14 / 21

15 Eléments à surveiller A. Système des serveurs Contrôler les points suivants régulièrement. Disque Supervision des disques /home 30.00% Seuil d'espace libre Service /home/koaly/exp/engine/rt/bin/java /home/koaly/exp/portal/rt/bin/java koaly-management-interface /usr/sbin/mysqld Supervision des services Actif Actif Actif Actif Statut B. Sauvegardes Dumps SQL. Effectuer régulièrement un test de restauration sur une base de données MariaDB indépendante. Sauvegarde des documents. Effectuer régulièrement un test de restauration des fchiers dans un répertoire indépendant. C. Application ITSM Cockpit Contrôler le statut des moteurs. Au niveau du portail, ouvrir le menu «Accueil / Tableau de bord». Le statut de tous les moteurs doit être vert. Contrôler régulièrement les logs des moteurs. Se connecter à l'itsm Cockpit Manager du serveur cible (par défaut: Ouvrir le menu de gestion des moteurs. Ouvrir le panneau de contrôle du moteur. Ouvrir l'onglet «Logs». Page: 15 / 21

16 Contrôler les fchiers de log suivants. Fichiers de logs des moteurs Nom Description engine.log Ensemble des messages warn.log Messages de niveau «error» et «warning» error.log Messages de niveau «error» mail.log Messages liés à la fonctionnalité d'envoi de mails (passerelle SMTP) sms.log Messages liés à la fonctionnalité d'envoi de sms (passerelle SMS) Contrôler régulièrement les logs des portails. Se connecter à l'itsm Cockpit Manager du serveur cible (par défaut: Ouvrir le menu de gestion des portails. Ouvrir le panneau de contrôle du portail. Ouvrir l'onglet «Logs». Contrôler les fchiers de log suivants. Fichiers de logs des portails Nom Description koaly_exp.log Ensemble des messages koaly_exp_warring.log Messages de niveau «error» et «warning» koaly_exp_error.log Messages de niveau «error» Contrôler régulièrement les logs des batchs internes. Se connecter au portail ITSM Cockpit. Ouvrir le menu «Administration / Paramétrage / Outils /Logs des batchs». Vérifer qu'il n'y a pas d'événement «Erreur» dans l'historique. Page: 16 / 21

17 Mises à jour I. Mise à jour de l'instance ITSM Cockpit A. Sauvegarde Avant la mise à jour de l'instance, il est recommandé de sauvegarder les différents éléments qui composent l'instance. 1. Sauvegarde de la base de données. 2. Sauvegarde des documents (répertoire par défaut /home/koaly/exp/documents). En cas de système sécurisé (cluster, réplication), débrayer le système de synchronisation (si possible) afn de conserver un des environnements dans l'ancienne version. La synchronisation pourra être activée après validation de la mise à jour. B. Mise à jour de la base de données 1. Se connecter à l'itsm Cockpit Manager du serveur cible (par défaut: 2. Sélectionner le menu «Base de données». 3. Choisir le fchier koaly-exp-db-update-x.y.z (fourni par le support) dans la partie «Téléchargement paquet de mise à jour». 4. Cliquer sur «Télécharger». 5. Vérifer que la version indiquée dans le champs «Dernière version» correspond à la version à installer. Pour lancer la mise à jour, il y a deux options. 1. Mise à jour depuis le Manager Cliquer sur «Lancer migration». Les logs de migration s'affchent dans une zone de notifcation. Elles peuvent être téléchargées et envoyées à l'éditeur en cas d'erreur de mise à jour. 2. Génération d'un script de mise à jour Cliquer sur «Générer script». Le script généré peut être appliqué manuellement à la base de données. C. Mise à jour d'itsm Cockpit Portal Page: 17 / 21

18 1. Se connecter à l'itsm Cockpit Manager associé au portail (par défaut: 2. Ouvrir le menu de gestion des portails. 3. Ouvrir le panneau de contrôle du portail. 4. Ouvrir l'onglet «Mise à jour». Les noms de la version actuelle et la nouvelle version apparaissent. 5. Charger le fchier de mise à jour koaly-exp-portal-service-update.zip (fourni par le support) et appuyer sur «Télécharger». 6. Vérifer que la version indiquée dans le champs «Dernière version» correspond à la version à installer. 7. Cliquer sur le bouton «Mettre à jour». 8. Le portail est mis à jour. L'arrêt puis le redémarrage du portail sont automatiques. 9. Contrôler les logs du portail. 10. Se connecter au portail afn de s'assurer qu'il fonctionne correctement. Note : L'ancienne version du portail est conservée dans le répertoire parent du répertoire d'installation (par défaut : /home/koaly/exp). Le répertoire qui contient l'ancienne version est renommé en suivant le format «portal_aaaammjj». Il est recommandé de conserver la version précédente du portail, les versions antérieures doivent être supprimées. D. Mise à jour d'itsm Cockpit Engine (mode local) 1. S'assurer que les librairies externes sont bien présentes dans le répertoire des librairies (par défaut : /home/koaly/update/koaly-exp-engine/ext/lib) 2. Se connecter à l'itsm Cockpit Manager associé au moteur (par défaut: 3. Ouvrir le menu de gestion des moteurs. 4. Ouvrir le panneau de contrôle du moteur. 5. Ouvrir l'onglet «Mise à jour». Les noms de la version actuelle et la nouvelle version apparaissent. 6. Charger le fchier de mise à jour koaly-exp-engine-service-update.zip (fourni par le support) et appuyer sur «Télécharger». 7. Vérifer que la version indiquée dans le champs «Dernière version» correspond à la version à installer. 8. Cliquer sur le bouton «Mettre à jour». 9. Le moteur est mis à jour. L'arrêt puis le redémarrage du moteur sont automatiques. 10. Contrôler les logs du moteur. Note : L'ancienne version du moteur est conservée dans le répertoire parent du répertoire d'installation (par défaut : /home/koaly/exp). Le répertoire qui contient l'ancienne version est renommé en suivant le format «engine_aaaammjj». Il est recommandé de conserver la version précédente du moteur, les versions antérieures doivent être supprimées. Page: 18 / 21

19 E. Mise à jour d'itsm Cockpit Engine (mode déporté) 1. Mise à jour automatique Dans la plupart des cas, la mise à jour des moteurs déportés se fait automatiquement. Le moteur détecte qu'une nouvelle version est disponible en se connectant au portail et se met à jour automatiquement. Pour mettre à disposition une nouvelle version au niveau du portail : 1. Télécharger le fchier koaly-exp-engine-standalone-service-update.zip. 2. Au niveau du portail, ouvrir le menu «Administration / Paramétrage / Moteur / Mise à jour» et cliquer sur «Mettre en ligne». 3. Sélectionner le fchier koaly-exp-engine-standalone-service-update.zip pour le mettre en ligne. 4. Une fois la mise en ligne effectuée, les moteurs déportés téléchargeront la nouvelle version et se mettront à jour automatiquement. Les logs du processus de mise à jour se trouvent dans le syslog et dans le fchier update/work/logs/update.log. 2. Mise à jour manuelle Certaines mises à jour majeures ne pourront pas être effectuées automatiquement. Ce point sera spécifé dans les mails d'information qui accompagnent les mises à jour. La procédure de mise à jour manuelle peut également être nécessaire en cas de dysfonctionnement de la Page: 19 / 21

20 mise à jour automatique. A fn de mettre à jour manuellement un moteur déporté : 1. Télécharger le fchier koaly-exp-engine-v.x.x.x-setup.bin. 2. Stopper le service ITSM Cockpit Engine sudo service koaly-exp-engine stop 3. Sauvegarder les répertoires suivants : confguration (par défaut : /home/koaly/exp/engine/conf) librairies externes (par défaut : /home/koaly/exp/engine/ext/lib) 4. Sauvegarder l'init script /etc/init.d/koaly-exp-engine s'il a été modifé. 5. Désinstaller le moteur. sudo /usr/sbin/update-rc.d koaly-exp-engine remove sudo rm /etc/init.d/koaly-exp-engine sudo rm -rf /home/koaly/exp/engine 6. Exécuter le programme koaly-exp-engine-v.x.x.x-setup.bin. sudo./koaly-exp-engine-vx.x.x-setup 7. Restaurer les répertoires et le fchier sauvegardés. 8. Revoir le paramètre RT_MAX_HEAP dans l'init script /etc/init.d/koaly-exp-engine (voir guide d'installation pour connaître les valeurs recommandées) et rétablir les paramètres modifés de la version sauvegardée. 9. Démarrer le service ITSM Cockpit Engine. sudo service koaly-exp-engine start II. Mise à jour d'itsm Cockpit Manager Afn de mettre à jour ITSM Cockpit Manager, il faut le désinstaller puis le réinstaller. 1. Arrêter le service ITSM Cockpit Manager. sudo service koaly-management-interface stop 2. Ouvrir le répertoire d'installation d'itsm Cockpit Manager r (par défaut /home/koaly/managementinterface). Sauvegarder les fchiers suivants : conf/service.xml conf/koaly.confg 3. Renommer le répertoire /home/koaly/management-interface en /home/koaly/managementinterface_backup (pour roll-back, peut être supprimé lors de la prochaine installation) sudo mv /home/koaly/management-interface /home/koaly/management-interface_backup 4. Installer la nouvelle version d'itsm Cockpit Manager. sudo unzip./koaly-management-interface-vxxx-setup.zip -d /home/koaly/managementinterface Page: 20 / 21

21 5. Ouvrir le répertoire d'installation d'itsm Cockpit Manager (par défaut /home/koaly/managementinterface). Copier les anciens fchiers dans le nouveau répertoire (remplacer les fchiers existants si nécessaire). conf/service.xml conf/koaly.confg 6. Démarrer le service ITSM Cockpit Manager. sudo service koaly-management-interface start 7. Se connecter à l'interface d'itsm Cockpit Manager (par défaut: III. Mise à jour de la licence 1. Se connecter au portail. 2. Ouvrir le menu «Administration / Paramètres techniques / Portail / Licences». 3. Cliquer sur le bouton «Télécharger» et télécharger le fcher de licence fourni par le support. 4. Un message indique si la licence est valide ou pas. 5. Si la licence est valide, cliquer sur le bouton «Sauvegarder». 6. Si la licence n'est pas valide, contacter le support. Fin du document Page: 21 / 21