6. Installatie vantage6

6.1. Randvoorwaarden

  • Docker geïnstalleerd

  • Huidige gebruiker heeft voldoende rechten Docker te gebruiken.

  • Python ≥ 3.10

Tip

Voor de installatie van Python packages raden we een virtual environment aan. Zie de documentatie van de gebruikte Python distributie voor meer informaite over hoe dit op te zetten.

Distributie

Documentatie

Python3 (vanilla)

Creation of virtual environments

Anaconda

Managing environments

6.2. Installatie van vantage6 software

Vantage6 nodes draaien als Docker container op de server. Om interactie met deze containers te vergemakkelijken, is er een command line interface (CLI) beschikbaar. Deze CLI is geschreven in Python3 en is als package beschikbaar via PyPI.

Het volgende commando installeert de laatste versie van CLI:

pip install --upgrade vantage6

Tip

Het volgende commando verifieert of installatie van de software succesvol was.

vnode --help

6.3. Configuratie van de node(s)

Binnen een vantage6 netwerk is het mogelijk om verschillende samenwerkingsverbanden te definieren. Per samenwerkingsverband wordt bepaald 1) welke data wordt gebruikt, en 2) wat er precies mee gedaan mag worden.

PLUGIN beoogt een of meerdere landelijke samenwerkingsverbanden (bijv. voor AI-ondersteund-coderen of aanlevering aan de NKR), maar faciliteert ook andere samenwerkingen. Zo is het, bijvoorbeeld, mogelijk om voor de mProve of de Santeon ziekenhuizen onderling afspraken te maken.

Per samenwerkingsverband, wordt een node geconfigureerd: de node heeft toegang tot de (juiste) data én houdt in de gaten dat alleen de toegestane algoritmes op de data worden toegepast.

Om een configuratiebestand voor een nieuwe node aan te maken wordt vanaf de command line het commando vnode new gebruikt.

vnode new

Dit start een “wizard” die een aantal vragen stelt. Deze worden hieronder nader toegelicht.

Configuratie wizard

Prompt

Antwoord / Omschrijving

Please enter a configuration-name

Naam van de node (en het configuratiebestand).

Dit is enkel voor intern gebruik. Binnen IKNL wordt hier vaak een combinatie van naam van de organisatie en samenwerking voor gebruikt. Bijvoorbeeld LUMC-PLUGIN voor een node die geïnstalleerd wordt door het LUMC en gebruikt wordt voor PLUGIN.

Please select the environment you want to configure

Kies application. Deze vraag verdwijnt in een toekomstige versie van vantage6.

Enter given api-key

De API-key wordt gebruikt voor authenticatie van de node bij de server. Deze ontvangt u van DHD, IKNL, of EZA.

The base-URL of the server

Kies een van

Enter port to which the server listens

Kies/typ 443 (https).

Path of the api

Haal de standaardwaarde /api weg.

Task directory path

Accepteer de voorgesteld waarde.

Task directory path

Accepteer de voorgesteld waarde.

Do you want to add a database?

Kies Yes.

Enter unique label for the database

Accepteer de voorgestelde waarde default.

Database URI

Voer de URI voor de database in. Dit is of een URI in de vorm dialect+driver://username:password@host:port/database of een absoluut pad naar een databestand (bijv. /home/melle/database.csv).

Database type

Kies het juiste database/bestands type.

Do you want to add a database?

Kies No.

Which level of logging would you like?

Kies DEBUG.

Do you want to connect to a VPN server?

Kies Yes.

Subnet of the VPN server you want to connect to

Kies een van …

  • IKNL: 10.76.0.0/16

  • DHD: 10.76.0.0/16

Enable encryption?

Kies Yes.

Path to private key file

Geef een absoluut pad op naar de private key. Deze key maken we in de vervolgstap Aanmaken private key aan.

Na afronding van de wizard, wordt de locatie van het aangemaakte configuratiebestand op het scherm getoond. Dit bestand kan m.b.v. een tekst-editor (bijv. Notepad of Visual Studio Code) worden geopend en aangepast.

De locatie van dit configuratiebestand kan ook worden teruggevonden met behulp van het volgende commando:

vnode files

6.4. Aanmaken private key

Het handmatig aanmaken van een private key kan via het volgende commando:

vnode create-private-key

Hiervoor heeft zijn de gebruikersnaam en password, verstrekt door DHD, IKNL, of EZA, noodzakelijk.

6.5. Starten en stoppen van een node

Om een node te starten, wordt het volgende commando gebruikt:

vnode start

Om een idee te krijgen van wat er op de achtergrond gebeurd, is het mogelijk om de output van de node naar het scherm te sturen. Dit kan op twee manieren:

vnode start --attach

Of open een later oment via het commando

vnode attach

Voor het stoppen van een node bestaat een vergelijkbaar commando:

vnode stop

6.6. Meer informatie

Zie voor meer informatie de documentatie van vantage6

Pas op

De specificaties in de officiële vantage6 documentatie kunnen afwijken van de specificaties in dit document.