ONYX - MMC - ONYX Mapping Management Console

Différence entre versions

De MappingDoc
(Cette version a été marquée pour être traduite)
Ligne 2 : Ligne 2 :
 
<translate>
 
<translate>
  
==Introduction==
+
==Introduction== <!--T:1-->
 
La console centralisée de MAPPING (Mapping Management Console : MMC) donne la possibilité de monitorer plusieurs serveurs MAPPING à la fois.
 
La console centralisée de MAPPING (Mapping Management Console : MMC) donne la possibilité de monitorer plusieurs serveurs MAPPING à la fois.
  
==prérequis==
+
==prérequis== <!--T:2-->
  
 +
<!--T:3-->
 
*Un (ou plusieurs) serveur Mapping Onyx installé(s) et configuré(s)
 
*Un (ou plusieurs) serveur Mapping Onyx installé(s) et configuré(s)
 
*Installer NodeJS (v14 minimum) (Node.js )
 
*Installer NodeJS (v14 minimum) (Node.js )
  
  
 +
<!--T:4-->
 
<u>Exemple d’installation de NodeJS sur centos</u> :  
 
<u>Exemple d’installation de NodeJS sur centos</u> :  
  
  curl -sL https://rpm.nodesource.com/setup_14.x | bash - &&  yum -y install nodejs
+
  <!--T:5-->
 +
curl -sL https://rpm.nodesource.com/setup_14.x | bash - &&  yum -y install nodejs
  
==Installation==
+
==Installation== <!--T:6-->
 
====Installation sur une VM====
 
====Installation sur une VM====
 
=====Command de mapping-spooler-api=====
 
=====Command de mapping-spooler-api=====
Ligne 21 : Ligne 24 :
 
Le registre npm utilisé est privé, et nécessite donc une authentification.
 
Le registre npm utilisé est privé, et nécessite donc une authentification.
  
=====Authentification=====
+
=====Authentification===== <!--T:7-->
  
  npm login --registry http://npm-registry.mappingsuite.com:4873
+
  <!--T:8-->
 +
npm login --registry http://npm-registry.mappingsuite.com:4873
  
 +
<!--T:9-->
 
username : partnermappingsuite</br>
 
username : partnermappingsuite</br>
 
password : (voir sur LastPass : [M-S] IT> NPM Registry for Partner )</br>
 
password : (voir sur LastPass : [M-S] IT> NPM Registry for Partner )</br>
 
email : partner_mappingsuite@mappingsuite.com</br>
 
email : partner_mappingsuite@mappingsuite.com</br>
  
=====Installation=====
+
=====Installation===== <!--T:10-->
  
  npm install -g mapping-spooler-api --registry http://npm-registry.mappingsuite.com:4873
+
  <!--T:11-->
 +
npm install -g mapping-spooler-api --registry http://npm-registry.mappingsuite.com:4873
  
  
===Configuration===
+
===Configuration=== <!--T:12-->
  
 +
<!--T:13-->
 
Une fois la commande installée il faut configurer chaque serveur Onyx pour définir le port http utilisé par l’api Spooler.
 
Une fois la commande installée il faut configurer chaque serveur Onyx pour définir le port http utilisé par l’api Spooler.
  
 +
<!--T:14-->
 
Ceci peut se faire en ajoutant une entrée SPOOLER_API_PORT au mapping.conf de chacun des serveurs MAPPING à monitorer.
 
Ceci peut se faire en ajoutant une entrée SPOOLER_API_PORT au mapping.conf de chacun des serveurs MAPPING à monitorer.
  
 +
<!--T:15-->
 
Cette valeur doit être unique pour chaque serveur Onyx présent sur la VM.
 
Cette valeur doit être unique pour chaque serveur Onyx présent sur la VM.
  
  
====Exemple====
+
====Exemple==== <!--T:16-->
 
  <block name="WEB CONFIG">
 
  <block name="WEB CONFIG">
 
   <group>
 
   <group>
Ligne 52 : Ligne 61 :
 
  </block>
 
  </block>
  
 +
<!--T:17-->
 
<u>Note</u>:Ces numéros de port seront utiles lors de l’ajout du serveur dans l’interface de la MMC.</br>
 
<u>Note</u>:Ces numéros de port seront utiles lors de l’ajout du serveur dans l’interface de la MMC.</br>
  
  
===Démarrage===
+
===Démarrage=== <!--T:18-->
  
 +
<!--T:19-->
 
Pour démarrer l’api http il suffit de lancer la commande mapping-spooler-api, en ayant au préalable défini la variable d’environnement MAPPING_PATH correspondant au serveur Onyx désiré.
 
Pour démarrer l’api http il suffit de lancer la commande mapping-spooler-api, en ayant au préalable défini la variable d’environnement MAPPING_PATH correspondant au serveur Onyx désiré.
  
 +
<!--T:20-->
 
Cela peut se faire en appelant la commande mappingenv pour sélectionner l’environnement Onyx, puis lancer la commande mapping-spooler-api.</br></br>
 
Cela peut se faire en appelant la commande mappingenv pour sélectionner l’environnement Onyx, puis lancer la commande mapping-spooler-api.</br></br>
  
  
 +
<!--T:21-->
 
<u>Note</u>:La commande mapping-spooler-api ne rend pas la main et ne dispose pas d’option natives pour s’exécuter en arrière plan.
 
<u>Note</u>:La commande mapping-spooler-api ne rend pas la main et ne dispose pas d’option natives pour s’exécuter en arrière plan.
 
Pour lancer la commande en arrière plan on peut utiliser ce genre de chose :
 
Pour lancer la commande en arrière plan on peut utiliser ce genre de chose :
Ligne 70 : Ligne 83 :
  
  
====Avec Docker====
+
====Avec Docker==== <!--T:22-->
  
 +
<!--T:23-->
 
L’API Spooler doit absolument être installé sur le même hôte que le serveur Mapping Onyx.
 
L’API Spooler doit absolument être installé sur le même hôte que le serveur Mapping Onyx.
  
 +
<!--T:24-->
 
Il faut donc ajouter l’installation de l’api spooler à l’image docker Mapping Onyx.
 
Il faut donc ajouter l’installation de l’api spooler à l’image docker Mapping Onyx.
  
  
=====Exemple de Dockerfile=====
+
=====Exemple de Dockerfile===== <!--T:25-->
  
  # Base Image Mapping Suite Server
+
  <!--T:26-->
 +
# Base Image Mapping Suite Server
 
  FROM mappingsuite.azurecr.io/onyxserver:10.2.0
 
  FROM mappingsuite.azurecr.io/onyxserver:10.2.0
 
  # NPM Registry Token for Authentication
 
  # NPM Registry Token for Authentication

Version du 29 octobre 2021 à 14:23

Autres langues :
English • ‎français

Introduction

La console centralisée de MAPPING (Mapping Management Console : MMC) donne la possibilité de monitorer plusieurs serveurs MAPPING à la fois.

prérequis

  • Un (ou plusieurs) serveur Mapping Onyx installé(s) et configuré(s)
  • Installer NodeJS (v14 minimum) (Node.js )


Exemple d’installation de NodeJS sur centos :

curl -sL https://rpm.nodesource.com/setup_14.x | bash - &&  yum -y install nodejs

Installation

Installation sur une VM

Command de mapping-spooler-api

La commande s’installe avec npm (gestionnaire de paquet, installé avec NodeJS). Le registre npm utilisé est privé, et nécessite donc une authentification.

Authentification
npm login --registry http://npm-registry.mappingsuite.com:4873

username : partnermappingsuite
password : (voir sur LastPass : [M-S] IT> NPM Registry for Partner )
email : partner_mappingsuite@mappingsuite.com

Installation
npm install -g mapping-spooler-api --registry http://npm-registry.mappingsuite.com:4873


Configuration

Une fois la commande installée il faut configurer chaque serveur Onyx pour définir le port http utilisé par l’api Spooler.

Ceci peut se faire en ajoutant une entrée SPOOLER_API_PORT au mapping.conf de chacun des serveurs MAPPING à monitorer.

Cette valeur doit être unique pour chaque serveur Onyx présent sur la VM.


Exemple

<block name="WEB CONFIG">
 <group>
  <element>
   <info name="[SPOOLER_API_PORT]">8080</info>
  </element>
 </group>
</block>

Note:Ces numéros de port seront utiles lors de l’ajout du serveur dans l’interface de la MMC.


Démarrage

Pour démarrer l’api http il suffit de lancer la commande mapping-spooler-api, en ayant au préalable défini la variable d’environnement MAPPING_PATH correspondant au serveur Onyx désiré.

Cela peut se faire en appelant la commande mappingenv pour sélectionner l’environnement Onyx, puis lancer la commande mapping-spooler-api.


Note:La commande mapping-spooler-api ne rend pas la main et ne dispose pas d’option natives pour s’exécuter en arrière plan. Pour lancer la commande en arrière plan on peut utiliser ce genre de chose :

mapping-spooler-api > /dev/null 2>&1 &

(Ou utiliser un outils comme supervisor) L’option SPOOLER_API_PORTdu mapping.conf est optionnelle. Si l’entrée n’est pas trouvé l’api cherchera une variable d’environnement PORT.


Avec Docker

L’API Spooler doit absolument être installé sur le même hôte que le serveur Mapping Onyx.

Il faut donc ajouter l’installation de l’api spooler à l’image docker Mapping Onyx.


Exemple de Dockerfile
# Base Image Mapping Suite Server
FROM mappingsuite.azurecr.io/onyxserver:10.2.0
# NPM Registry Token for Authentication
ARG npm_token
# Update & Supervisor (for running Onyx + Rest API in parrallel)
RUN yum -y install epel-release && \ 
   yum -y update && \
   yum -y install supervisor
# Install NodeJS
RUN curl -sL https://rpm.nodesource.com/setup_14.x | bash - && \ 
   yum -y install nodejs	
# NPM Private Registry Authentication 
RUN npm set //npm-registry.mappingsuite.com:4873//:_authToken ${npm_token}
# NPM install mapping-spooler-api with private NPM Registry
RUN npm install -g mapping-spooler-api --registry http://npm-registry.mappingsuite.com:4873
# Required env var for API REST 
ENV PORT=8080
ENV MAPPING_PATH=/apps/mapping/data/conf/mapping.conf
# Supervisor Configuration
RUN echo "[supervisord]" > /etc/supervisord.conf  && \
 echo "nodaemon=true" >> /etc/supervisord.conf  && \
 echo "[program:spooler-api]" >> /etc/supervisord.conf  && \
 echo "command=bash -c 'sleep 5 && exec mapping-spooler-api'" >> /etc/supervisord.conf  && \
 echo "[program:onyx-server]" >> /etc/supervisord.conf  && \
 echo "command=/home/docker/scripts/init.sh"  >> /etc/supervisord.conf 
EXPOSE 8080
# Run Supervisor
ENTRYPOINT ["/usr/bin/supervisord"]