Gå direkt till innehållet.
Suomi.fi-informationsled

Informationsledens X-Road Toolkit – automatiska administrationsskript för anslutningsservern

Med Informationsledens automatiska administrationsskript (X-Road Toolkit) automatiserar du definitionen av en eller flera anslutningsservrar. Med automatiska skript är definitionen av anslutningsservern smidigare och risken att göra fel är mindre.

Vad är X-Road Toolkit?

X-Road Toolkit är ett Python-baserat verktyg för automatisk installation och administration av anslutningsserver. Den kan användas för att definiera alla anslutningsserveralternativ (RHEL, Ubuntu, Docker) i Informationsleden. Med hjälp av X-Road Toolkit kan du definiera en eller flera anslutningsservrar åt gången.

Automatiska skript lämpar sig endast för användningen av Suomi.fi-informationsleden. Detta innebär att till exempel certifikat som skapats med hjälp av skript är avsedda för Finland.

X-Road Toolkit har publicerats som Python Package Index (PyPl) -paket.

Titta på en demo video i Youtube (på engelska).Öppnas i ett nytt fönster.

Vad möjliggör X-Road Toolkit?

X-Road Toolkit möjliggör en grunddefinition av en eller flera anslutningsservrar. Det är enklare och snabbare att definiera anslutningsservern med X-Road Toolkit än manuell konfigurering. Automatiseringen av definitionen sparar tid och minskar risken för fel. Automatiska skript underlättar också användningen av administrationsytan för anslutningsservern som publicerades i version X-Road 6.24.0, dvs möjliggör fjärrkontroll av anslutningsservern.

X-Road Toolkit gör det också möjligt att skapa installationspaket. Man kan till exempel definiera lämpliga tjänster färdigt i YAML-konfigurationsfilen, varvid endast organisationsspecifika basuppgifter behöver redigeras separat, till exempel organisationens namn.

Grunddefinitionen av anslutningsservern avser bland annat följande kommandon:

  • Initiering av anslutningsserver och tillägg av konfigurationsankare
  • Tokens. Inloggning Token, lista över Tokens
  • Inställning av anslutningsserverns tidsstämpeltjänst
  • Certifikat: signatur-, autentiserings- och TLS-certifikat. Skapa signatur- och autentiseringsnyckel samt certifikatbegäran, installation av mottagna certifikat på anslutningsservern, registrering och aktivering av autentiseringscertifikat och laddning av interna TLS-certifikat
  • Subsystem. Skapa och registrera ett eller flera subsystem.
  • Tjänster. Skapa en eller flera tjänster. Typ av tjänst: REST API Base Path, REST OpenAPI 3 eller WSDL. Inställning av tjänstens parametrar och tillträdesrättigheter.

Utöver grunddefinitionen av anslutningsservern kan du också:

Läs mer om kommandon i Github (på engelska)Öppnas i ett nytt fönster..

Ta i bruk X-Road Toolkit

Du hittar instruktioner för hur du installerar X-Road Toolkit i Github (på engelska)Öppnas i ett nytt fönster..

Observera att du måste öppna de nödvändiga portarna på din server innan du definierar anslutningsservern. Läs anvisningarna om brandväggsöppningar i punkt 2.

Förutsättningar för användning av Toolkit:

1. På plattformsservern där anslutningsserverprogrammet installeras finns färdigt

  • RHEL-operativsystem (8) eller Ubuntu-operativsystem (24.04LTS)
  • eller Docker installerat på vilken Linux-distribution som helst

2. På plattformsservern har installerats

  • installationspaket för anslutningsserver som bygger på plattformsserver (RHEL, Ubuntu)
  • eller installationspaket för konterad anslutningsserver (Docker)

3. Python-version 3.6 eller nyare

Läs mer om förutsättningarna för ibruktagande (på engelska)Öppnas i ett nytt fönster..

Toolkits önskvärda funktion och data definieras i YAML-konfigurationen. Uppgifter som ska definieras är till exempel:

  • anslutningsserverns uppgifter, såsom FQDN-namnet samt
  • uppgifter om ägaren till anslutningsservern, såsom typ av organisation.

Lär mer om redigering av YAML-konfigurationsfilen (på engelska)Öppnas i ett nytt fönster..

Åtgärder som definierats för Toolkits konfiguration kan köras antingen på en gång eller en efter en.

  • Hela konfigurationen kan köras på en gång med kommandot xrdsst apply
  • Delar av konfigurationen kan köras individuellt med underkommandon. Till exempel xrdsst init laddar ner konfigurationsankaret och formaterar anslutningsserverns uppgifter

I Informationsleden registreras subsystemen automatiskt, så hela processen kan köras i två delar.

  1. Den första konfigureringskörningen med kommandot xrdsst apply slutar med ett meddelande om att certifikaten måste undertecknas.
  2. Ladda ner begäran om certifikat med kommandot xrdsst cert download-csrs och skicka dem för underskrift till adressen palveluvayla@palveluvayla.fi.
  3. När du har fått de undertecknade certifikaten från Informationsledens stöd, lägg till en sökväg till de signerade certifikaten i konfigurationsfilen och fortsätt därefter att köra hela konfigurationen med kommandot xrdsst apply.

Om det uppstår fel under definieringen av anslutningsservern, stannar konfigureringen av felmeddelandet. I felmeddelandet anges var felet uppstod och hur det kan korrigeras. Om felmeddelandet inte hjälper eller du inte kan korrigera felet ska du kontakta Informationsledens stöd palveluvayla@palveluvayla.fi.

OBS! Om du definierar den cointainrade Sidecar Slim anslutningsservern med X-Road Toolkit får du ett felmeddelande i konfigureringen om att konfigureringen av tidsstämpeltjänsten inte lyckades. Detta beror på att Sidecar Slim inte innehåller loggning eller tidsstämplingstjänst, varvid de inte heller kan definieras. Detta fel kan kringgås eftersom det går att definiera anslutningsservern och anslutningsservern fungerar trots felmeddelandet.

Läs mer om felsituationer (på engelska)Öppnas i ett nytt fönster..

Vill du veta mer?

Bekanta dig med X-Road Toolkits tekniska dokumentation i Github (på engelska)Öppnas i ett nytt fönster..

Om du har frågor om automatiska skript, kontakta vår administration palveluvayla@palveluvayla.fiÖppnas i ett nytt fönster.

Uppdaterad: 29.8.2025

Är du nöjd med innehållet på denna sida?