Siirry suoraan sisältöön.
Suomi.fi-palveluväylä

Palveluväylän kontitettu liityntäpalvelin

Docker-kontitettu liityntäpalvelin on yksi Palveluväylän liityntäpalvelinvaihtoehdoista. Kontitus mahdollistaa Palveluväylään liittymisen kevyesti, mutta tarvittaessa se skaalautuu myös raskaisiin käyttötarpeisiin. Kontitetun liityntäpalvelimen voi sijoittaa pilviympäristöön, konesaliin tai Linux-koneelle.

Tutustu myös Palveluväylän toiseen liityntäpalvelinvaihtoehtoon RHEL- tai Ubuntu-liityntäpalvelimeen.

Kontitettu liityntäpalvelin

Mikä on kontitettu liityntäpalvelin?

Kontitettu liityntäpalvelin on Docker-kontti, johon on pakattu X-road-liityntäpalvelinohjelmisto ja kaikki muu mitä ohjelmisto vaatii toimiakseen. Kontitetun liityntäpalvelimen voi pystyttää samalle palvelimelle kuin itse tietojärjestelmän.

Kontitetun liityntäpalvelimen voi asentaa mille tahansa Linux-alustalle, eikä se välttämättä tarvitse omaa alustapalvelinta.

Liityntäpalvelinta voi käyttää sekä palvelujen tarjoamiseen että hyödyntämiseen.

Tarjoamamme kontitettu liityntäpalvelin perustuu laajasti käytettyyn Docker-teknologiaan (Docker Inc., englanniksi)Avautuu uuteen ikkunaan..

Millaiselle organisaatiolle sopii?

Hyvä vaihtoehto organisaatiolle, joka tuntee konttiteknologian ja hyödyntää sitä jo muissa palveluissaan.

Mitä liityntäpalvelin vaatii organisaatiolta?

Organisaatiolla on oltava tarvittavat resurssit liityntäpalvelimen ylläpitoon ja hallinnointiin. Kustannuksia voi arvioida Nordic Institute for Interoperability Solutionsin laskurilla (englanniksi)Avautuu uuteen ikkunaan.. Huomioi, että laskuria ei ole kehitetty suoraan Palveluväylän käyttöön, joten kaikkia laskurin kohtia ei välttämättä voi soveltaa sellaisenaan.

Liityntäpalvelimesta vastaavan henkilön olisi hyvä tuntea seuraavat teknologiat:

  • Docker-teknologia
  • X-road-ohjelmiston perusteet
  • Linux

Jos liityntäpalvelin sijoitetaan pilveen, liityntäpalvelimesta vastaavan henkilön olisi hyvä tuntea myös:

  • AWS-pilviympäristö
  • Kubernetes-teknologia

Alustan tekniset vaatimukset:

  • Käyttöjärjestelmä: Linux-alusta, jolle on asennettu Docker-ohjelmisto
  • Prosessori (CPUt): vähintään 2
  • Käyttömuisti: 2 GB
  • Levytila: 2 GB

Tutustu kontitetun liityntäpalvelimen teknisiin vaatimuksiin.

Kontitettu liityntäpalvelin sopii niin kevyeen kuin raskaaseenkin käyttöön.

  • Kevyt käyttö: Kontitettua liityntäpalvelinta voi kevyimmillään käyttää esimerkiksi vain muutaman Palveluväylän palvelun hyödyntämiseen.
  • Raskas käyttö: Kontitettu liityntäpalvelin skaalautuu myös monimutkaisiin ja raskaisiin tarpeisiin, esimerkiksi usean palvelun tarjoamiseen ja hyödyntämiseen yhtä aikaa.

Tarjoamme useita erilaisia Docker-kuvia (imageita) eri käyttötarkoituksiin. Löydät kaikki imaget listattuna käyttötarkoituksineen NIIS:in Docker Hubista (englanniksi)Avautuu uuteen ikkunaan..

Liityntäpalvelimen käyttöympäristöt

Valitse liityntäpalvelimen käyttöympäristö organisaation tarpeiden mukaan.

Liityntäpalvelimen voi sijoittaa:

  • Pilviympäristöön: esim. Amazonin pilviympäristö (AWS)
  • Konesaliin: esim. Suomessa sijaitseva konesali
  • Linux-koneelle: esim. Sidecar slim asiointipalvelun kanssa samalla koneella

Mieti valintaa tehdessäsi, mitä teknologioita organisaatiollasi on jo käytössä ja millaista Palveluväylän käyttö tulee olemaan.

Liityntäpalvelin pilviympäristössä (AWS)

Pilviympäristöön sijoitetun liityntäpalvelimen etuja ovat muun muassa kustannustehokkuus ja skaalautuvuus. Pilviympäristössä liityntäpalvelimen tarvitsemaa kapasiteettia on helppo kasvattaa ja toteutuksesta voidaan rakentaa hyvin vikasietoinen.

Liityntäpalvelin kannattaa sijoittaa pilviympäristöön erityisesti silloin, kun:

  1. Organisaatiollasi on ennestään tietoa pilviteknologioista ja organisaatiosi muut palvelut ovat jo pilviympäristössä
  2. Palveluväylän suunniteltu käyttö on raskasta ja kapasiteetin tarve vaihtelee. Esimerkiksi:
  • Organisaatiosi tarjoaa ja/tai hyödyntää monia palveluja.
  • Organisaatiosi palvelujen käyttöaste vaihtelee, esimerkiksi tietojen hakemisessa tulee ajoittaisia kovan kysynnän piikkejä.
  • Organisaatiosi tarjoamien palveluiden täytyy olla erityisen vikasietoisia.

Pilviympäristö voi olla hyvä vaihtoehto myös silloin, kun organisaation tarvitsema kapasiteetti on vähäistä, mutta organisaation muut palvelut ovat jo valmiiksi pilviympäristössä tai siirtymässä sinne.

Suosittelemme sijoittamaan liityntäpalvelimen Amazonin pilviympäristöön (AWS), sillä tuemme ja tarjoamme ohjeistusta Kubernetes-ajoympäristölle AWS-pilvialustalla. Docker-kontin pystyttäminen myös muihin pilviympäristöihin on mahdollista, mutta olemme testanneet toimintaa vain AWS-ympäristössä ja tuemme ainoastaan sitä.

Pilviympäristöissä käytetään usein kustannustehokasta hinnoittelua, jossa maksat vain siitä kapasiteetista, jota käytät. Kustannukset vaihtelevat käytettävän pilviympäristön mukaan. Kustannusten arvioimisen avuksi on olemassa hinnoittelulaskureita. Katso esimerkiksi Amazonin pilviympäristön (AWS) laskuri (englanniksi)Avautuu uuteen ikkunaan..

Tutustu AWS:n tuottamaan parhaat käytännöt -ohjeistukseen liityntäpalvelimen sijoittamisesta AWS-ympäristöön (englanniksi)Avautuu uuteen ikkunaan..

Huomioi pilviympäristön valinnassa oman palvelusi tietoturva- ja tietosuojavaatimukset. Pilvessä olevaa tietoa käsitellään yleensä pilviympäristöstä riippuen Suomen ulkopuolella. On mahdollista, että esimerkiksi AWS-ympäristön tapauksessa dataa käsitellään Irlannissa.

Liityntäpalvelin konesalissa

Konesaliin sijoitettu liityntäpalvelin sopii sekä raskaaseen että kevyeen käyttöön. Konesaliin sijoitetun liityntäpalvelimen kapasiteettia on hankalampaa kasvattaa.

Liityntäpalvelin kannattaa sijoittaa konesaliin erityisesti silloin, kun:

  • Organisaatiolla on jo valmiiksi omaa konesali-infraa ja tietämystä konesaleista
  • Palveluväylällä käsiteltävän tiedon täytyy säilyä Suomessa tietosuoja- tai tietoturvavaatimusten takia

Liityntäpalvelin Linux-palvelinkoneella

Jos Palveluväylän käyttötarpeet ovat vähäiset, kontitetun liityntäpalvelimen voi pystyttää esimerkiksi samalle Linux-palvelinkoneelle organisaation oman asiointipalvelun kanssa. Tuemme tuotantokäytössä ainoastaan Linux-alustoja.

Huomaa, että vaikka Docker-teknologia itsessään mahdollistaa kontin ajamisen esimerkiksi kannettavalla tietokoneella, liityntäpalvelimen voi kevyimmilläänkin asentaa vain palvelinkoneelle. Tämä johtuu Palveluväylän vaatimuksista.

Erot RHEL- tai Ubuntu-alustapalvelin liityntäpalvelimeen

Kontitettu liityntäpalvelin:

  • On RHEL- tai Ubuntu-pohjaiseen liityntäpalvelimeen verrattuna hieman kevyempi vaihtoehto. Muun muassa kapasiteettivaatimukset ovat pienempiä.
  • Ei tarvitse omaa erillistä alustapalvelinta. Yhdellä palvelimella voi olla monia kontitettuja liityntäpalvelimia, jolloin tarvitset vähemmän alustapalvelimia kuin esimerkiksi RHEL- tai Ubuntu-pohjaista liityntäpalvelinta käyttäessä.
  • Voi asentaa mille tahansa Linux-alustalle. Käyttöjärjestelmävaatimukset ovat vapaammat kuin RHEL- tai Ubuntu-pohjaisessa liityntäpalvelimessa.
  • Perustuu Docker-kontitusteknologiaan. Vähemmän ylläpidettävää kuin alustapalvelimeen pohjautuvassa liityntäpalvelimessa. Esimerkiksi ohjelmistojen riippuvuuksista ei tarvitse huolehtia päivitysten yhteydessä.

Esimerkkejä kontitetusta liityntäpalvelimesta eri ympäristöissä

Asiointipalvelun kyljessä omassa IT-infrassa

Yksityisellä organisaatiolla on asiointipalvelu, jossa organisaatio haluaa alkaa hyödyntää yritystietoja PRH:n ja Verohallinnon Yritys- ja yhteisötietojärjestelmästä (YTJ) Palveluväylän kautta. Organisaatio ei aio tarjota palveluita itse Palveluväylässä vaan ainoastaan hyödyntää Palveluväylää pienimuotoisesti, joten organisaatio päättää asentaa Sidecar Slim -asennuspaketin samalle palvelimelle, jossa myös organisaation oma asiointipalvelu pyörii. Tämän kaltainen kevyt toteutus palvelee organisaation tarpeita hyvin.

Pilvipalvelussa

Julkinen organisaatio tarjoaa monia palveluita Palveluväylässä sekä samalla hyödyntää toisten organisaatioiden tarjoamia palveluita. Organisaation tarjoamien palveluiden käyttöaste vaihtelee säännöllisesti ja palveluissa on välillä isoja käyttöpiikkejä. On erityisen tärkeää, että palvelut kestävät nämä kyselypiikit, sillä ne ovat toiminnaltaan kriittisiä. Organisaatio varmistaa ensin, voiko se sijoittaa palvelunsa pilviympäristöön ja onko tietojenkäsittelyaluetta tarvetta rajata esimerkiksi EU/ETA-alueelle. Tämän jälkeen organisaatio päättää asentaa Sidecar-liityntäpalvelimen ja sijoittaa sen pilviympäristöön, jotta se voi hyödyntää pilvipalvelun tarjoamia skaalautumisen ja tietoturvan ratkaisuja. Niiden avulla organisaatio voi esimerkiksi konfiguroida toteutuksensa niin, että se skaalautuu automaattisesti vastaamaan sen hetkistä kysyntää ja lisäksi liityntäpalvelimen kapasiteettia voi kasvattaa helposti tarpeen vaatiessa.

Konesalissa

Julkinen organisaatio on liittymässä Palveluväylään ja organisaatiolla on oma konesali. Organisaatio tarvitsee Palveluväylää varten useamman liityntäpalvelimen, jotka se aikoo sijoittaa omaan konesaliinsa voidakseen hyödyntää oman organisaationsa konesaliosaamista. Organisaation haluaa säästää liityntäpalvelinkuluissa, joten se päättää asentaa kontitetun Sidecar liityntäpalvelimen, sillä niitä voi asentaa useamman samalle palvelimelle.

Huomioi nämä käyttöönotossa!

Ota huomioon nämä suositukset, kun mietit liityntäpalvelimen toteuttamista kontitettuna.

  • Jos otat käyttöön tai käytössäsi on kontitettu liityntäpalvelin, käytä samaa X-road-versiota kuin mitä Palveluväylän keskuspalvelimet käyttävät. Voit tarkistaa käytössä olevan version Versiopäivitykset-sivulta.
  • Käytä vain Suomi.fi-palveluväylän käyttöön mukautettuja Docker-imageja. Tarkista, että asennuspaketissa on fi-tunnus. Fi-tunnus tarkoittaa, että kyseisessä imagessa on valmiina asetukset, jotka sopivat Palveluväylään.
  • Kun käytät Palveluväylää palvelujen tarjoamiseen, käytä imageiden Sidecar -fi -versioita. Suosittelemme, että palveluntarjoajat käyttävät Sidecar-imagea, joka sisältää kaikki ominaisuudet. Organisaatiot, jotka ainoastaan hyödyntävät Palveluväylän palveluita voivat käyttää Sidecar slim -versiota. Slim-imageissa ei ole sanomien lokitukseen eikä monitorointiin tarvittavia ominaisuuksia. Huomioi organisaatiosi lokitustarpeet versiota valitessa.
  • Varmista tietoturva- ja tietosuojavaatimusten täyttyminen valitsemassasi käyttöympäristössä. Esimerkiksi liityntäpalvelimella käsiteltävä tieto saattaa rajoittaa sitä, missä tietoja voidaan maantieteellisesti käsitellä. Tämä rajoitus voi tulla myös organisaatiosi ulkopuolelta.
  • Valitse sama liityntäpalvelinvaihtoehto sekä testi- että tuotantoympäristöön. Eri liityntäpalvelinvaihtoehtojen käyttäminen on teknisesti mahdollista, esimerkiksi kontitetun liityntäpalvelimen käyttäminen testiympäristössä ja alustapalvelimen käyttäminen tuotantoympäristössä. Ylläpidon helpottamiseksi ja vikatilojen minimoimiseksi suosittelemme kuitenkin, että testi- ja tuotantoympäristöt vastaavat toisiaan. Tämä auttaa esimerkiksi päivitysten asentamisessa.
  • Muista huolehtia kontitetun liityntäpalvelimen päivityksistä. Sidecar-ohjelmisto päivittyy tulevaisuudessa samaan tahtiin muiden X-road-päivitysten kanssa.

Huomioi myös:

  • Ohjeistukset sekä mallitoteutukset ovat suunniteltu AWS-alustalle Kubernetes-ajoympäristöön.
  • Tuotantoympäristössä tuemme ainoastaan Linux-alustan käyttöä. Emme ole testanneet emmekä tue Windowsin tai MacOS:n käyttöä, mutta niitä voi käyttää testitarkoituksessa kehitysympäristössä.

Liityntäpalvelimen käyttöönotto

Jos organisaatiosi aikoo ottaa kontitetun liityntäpalvelimen käyttöön, tutustu seuraaviin materiaaleihin

Lue myös

Päivitetty: 14.10.2024

Oletko tyytyväinen tämän sivun sisältöön?