Déploie un service d'intégration sur un serveur local

Prérequis

• Serveur fonctionnant sous un système d’exploitation compatible avec Docker

  • Le déploiement a été testé sur des machines Windows

• Enregistrement DNS et certificat SSL approprié pour le service web du Service d’intégration

• Project Access Token pour extraire l’image docker du dépôt privé Gitlab de Prevu3d avec les permissions suivantes :

  • Lire la liste des registres

  • Rôle du développeur

• Docker CLI installée

• Docker-Desktop - Optionnel

Note

Le jeton d’accès au projet est fourni uniquement par Prevu3D à la demande. Veuillez contacter notre équipe pour demander l’accédre.

Avertissement

La procédure de déploiement est actuellement en phase bêta et susceptible d’être modifiée.

Étapes de déploiement

1. Connectez-vous au dépôt d’images docker de Gitlab avec le jeton d’accès au projet fourni.

   docker login registry.gitlab.com -u <ANY_USERNAME> -p <PROJECT_ACCESS_TOKEN>

2. Extrait l’image docker du Service d’intégration de développement.

   docker pull registry.gitlab.com/prevu3d/product/integration-service:develop

3. Sur l’hôte, créez un dossier « Assets » et un dossier « Config ». Ces dossiers seront utilisés comme support à l’intérieur du conteneur docker. Les assets contiendront des fichiers qui pourraient être requis par les intégrations, tels que les schémas JSON pour l’intégration HTTP. Config contiendra le fichier de configuration et veillera à ce qu’il persiste.

4. Démarrez le conteneur avec la CLI docker. Assurez-vous de monter les dossiers d’assets et de configuration et de lier le port du service d’intégration. La valeur par défaut est 3000.

   docker run registry.gitlab.com/prevu3d/product/integration-service:develop -v path\to\assets\folder\on\host:/usr/app/assets -v path\to\config\folder\on\host:/usr/app/config -p 3000:3000

   1. Ces variables d’environnement sont également disponibles pendant la phase d’exécution :

      1. PORT : Port où le service d’intégration se liera, à l’intérieur du conteneur. Par défaut, c’est 3000.

      2. DEBUG_MODE : Réglez sur « 1 » pour activer les journaux de débogage.

      3. CONFIG_FILE : Nom et chemin du fichier de configuration. Par défaut, c’est « /config/config.json ». Si le fichier de configuration est hébergé sur S3, l’URI S3 doit être fournie (commence par s3 ://).

      4. CONFIG_FILE_TYPE : Type du fichier de configuration. Réglez sur « s3 » pour utiliser un fichier hébergé dans AWS S3 ou local pour un fichier hébergé dans le conteneur. Par défaut, c’est « local ».

5. Naviguez jusqu’à http://localhost:3000/health pour confirmer que le service d’intégration fonctionne.

6. Configurez une entrée DNS pour pointer vers le service d’intégration et ajoutez un certificat SSL pour activer le trafic HTTPS.

7. Suivez les étapes pour enregistrer le serveur d’intégration dans la plateforme afin d’obtenir l’assetServicePublicKey et de la copier dans le fichier config.json.