Distribuire l'Integration Service su un server on-premise

Prerequisiti

• Server che esegue un sistema operativo compatibile con Docker

  • Il deployment è stato testato su macchine Windows

• Record DNS e certificato SSL appropriato per il servizio web dell’Integration Service

• Project Access Token per estrarre l’immagine docker dal repository Gitlab privato di Prevu3D con i seguenti permessi:

  • Read Registry

  • Developer Role

• Docker CLI installata

• Docker-Desktop - Opzionale

Nota

Il Project Access Token viene fornito da Prevu3D solo su richiesta. Contatta il nostro team per richiedere l’accesso.

Attenzione

La procedura di deployment è attualmente in beta e soggetta a modifiche.

Passaggi di deployment

1. Accedi al repository di immagini docker di Gitlab con il Project Access Token fornito.

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

2. Estrai l’immagine docker di sviluppo dell’Integration Service.

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

3. Sull’host, crea una cartella “Assets” e una cartella “Config”. Queste cartelle verranno utilizzate come mount all’interno del container docker. Assets conterrà file che potrebbero essere richiesti dalle integrazioni, come gli JSON Schema per l’integrazione HTTP. Config conterrà il file di configurazione e ne garantirà la persistenza.

4. Avvia il container con la Docker CLI. Assicurati di montare le cartelle asset e config e di associare la porta dell’integration service. Il valore predefinito è 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. Anche queste variabili di ambiente sono disponibili durante la fase di esecuzione:

      1. PORT: porta a cui l’Integration Service si assocerà, all’interno del container. Il valore predefinito è 3000.

      2. DEBUG_MODE: imposta su “1” per abilitare i log di debug.

      3. CONFIG_FILE: nome e percorso del file di configurazione. Il valore predefinito è “/config/config.json”. Se il file di configurazione è ospitato su S3, deve essere fornito l’URI S3 (che inizia con s3://).

      4. CONFIG_FILE_TYPE: tipo del file di configurazione. Imposta su “s3” per usare un file ospitato in AWS S3 o local per un file ospitato all’interno del container. Il valore predefinito è “local”.

5. Naviga su http://localhost:3000/health per confermare che l’integration service sia in esecuzione.

6. Configura una voce DNS che punti all’integration service e aggiungi un certificato SSL per abilitare il traffico HTTPS.

7. Segui i passaggi per registrare il server di integrazione all’interno della piattaforma al fine di ottenere l’assetServicePublicKey e copiarlo all’interno del file config.json.