De integratieservice implementeren op een on-premserver

Vereisten

• Server met een besturingssysteem dat compatibel is met Docker

  • De implementatie is getest op Windows-machines

• DNS-record en geschikt SSL-certificaat voor de webservice van de integratieservice

• Project Access Token om de docker-image op te halen uit de privé-GitLab-repository van Prevu3D met de volgende rechten:

  • Read Registry

  • Developer Role

• Docker CLI geïnstalleerd

• Docker Desktop - optioneel

Opmerking

Het Project Access Token wordt alleen op aanvraag door Prevu3D verstrekt. Neem contact op met ons team om toegang aan te vragen.

Waarschuwing

De implementatieprocedure bevindt zich momenteel in bèta en kan worden gewijzigd.

Implementatiestappen

1. Log in bij de GitLab docker-imagerepository met het verstrekte Project Access Token.

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

2. Haal de docker-image van de development-integratieservice op.

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

3. Maak op de host een map “Assets” en een map “Config” aan. Deze mappen worden gebruikt als mount binnen de docker-container. Assets bevat bestanden die mogelijk vereist zijn door de integraties, zoals JSON-schema’s voor de HTTP-integratie. Config bevat het configuratiebestand en zorgt ervoor dat het behouden blijft.

4. Start de container met de docker CLI. Zorg ervoor dat u de asset- en config-mappen mount en de poort van de integratieservice bindt. De standaardwaarde is 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. Deze omgevingsvariabelen zijn ook beschikbaar tijdens de run-fase:

      1. PORT: poort waar de integratieservice bindt, binnen de container. Standaard is 3000.

      2. DEBUG_MODE: stel in op “1” om debuglogs in te schakelen.

      3. CONFIG_FILE: naam en pad van het configuratiebestand. Standaard is “/config/config.json”. Als het configuratiebestand op S3 wordt gehost, moet de S3-URI worden opgegeven (begint met s3://).

      4. CONFIG_FILE_TYPE: type van het configuratiebestand. Stel in op “s3” om een bestand te gebruiken dat wordt gehost in AWS S3, of local voor een bestand dat binnen de container wordt gehost. Standaard is “local”.

5. Navigeer naar http://localhost:3000/health om te bevestigen dat de integratieservice actief is.

6. Configureer een DNS-vermelding die naar de integratieservice verwijst en voeg een SSL-certificaat toe om HTTPS-verkeer in te schakelen.

7. Volg de stappen om de integratieserver binnen het platform te registreren om de assetServicePublicKey te verkrijgen en kopieer deze in het bestand config.json.