Palveluväylän kontitetun liityntäpalvelimen tekniset tiedot

Docker-kontitettu liityntäpalvelin on yksi Palveluväylän liityntäpalvelinvaihtoehdoista. Sen voi pystyttää pilviympäristöön, konesaliin tai Linux-palvelinkoneelle. Kontitettu liityntäpalvelin sopii sekä Palveluväylän palveluntarjoajien että palveluita hyödyntävien organisaatioiden käyttöön. Palveluväylän käyttöön on saatavilla erikseen mukautetut Docker-imaget.

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

Huomioi seuraavat Palveluväylään liittyvät suositukset, kun suunnittelet kontitetun liityntäpalvelimen käyttöönottoa.

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 täällä.

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:

• Pilvialustoista tuemme Amazonin pilviympäristöä (AWS) ja sen Kubernetes-ajoympäristöä. Tarjoamme ohjeet ja esimerkit liityntäpalvelimen käyttöönottoon ja ylläpitoon kyseisissä ympäristöissä. 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ä.
• 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ä.

Tekniset vaatimukset

Asenna Docker ennen kontitetun liityntäpalvelimen asentamista. Lue lisää Dockerin asentamisesta (englanniksi)Avautuu uuteen ikkunaan..

Huomioi, että tuemme tuotantoympäristössä ainoastaan Linux-alustojen käyttöä, joten asenna Dockerin Linuxille tarkoitettu versio.

Alustan minimivaatimukset:

• CPUt (suoritin): 2
• Muisti: 2 GB
• Levytila: 2 GB

Lue lisää teknisistä vaatimuksista (englanniksi)Avautuu uuteen ikkunaan..

Siitä huolimatta, että Docker-teknologia itsessään mahdollistaa konttien ajamisen esimerkiksi läppärillä, liityntäpalvelin täytyy aina asentaa kevyimmilläänkin palvelinkoneelle Palveluväylän vaatimusten takia.

Ohjeet ja esimerkit ovat tehty AWS-alustalle Kubernetes-ajoympäristöön. Tarjoamme ohjeistuksen mm. kuormantasaukseen, tietoturvaan, redundanssiin (varmennus), tietokantojen toteuttamiseen ja klusterointiin.

Näin otat kontitetun liityntäpalvelimen käyttöön

Seuraa Githubista löytyviä asennusohjeita (englanniksi)Avautuu uuteen ikkunaan..

Löydät Sidecar Kubernetes -toteutuksen asennusohjeet täältä englanniksiAvautuu uuteen ikkunaan..

Huolehdi tietoturvasta. Lue Dockerin parhaat käytännöt tietoturvasta huolehtimiseen (englanniksi)Avautuu uuteen ikkunaan.. Tarjoamme myös laajan liityntäpalvelimen tietoturvaoppaan (englanniksi)Avautuu uuteen ikkunaan., jossa käydään läpi tärkeimmät tietoturvakäytännöt.

Kuberneteksen tietoturvaohjeet liityntäpalvelinta varten löydät täältä (englanniksi)Avautuu uuteen ikkunaan..

Liityntäpalvelimen määrittely tehdään samalla tavalla kuin muissakin Palveluväylän liityntäpalvelinvaihtoehdoissa. Lue liityntäpalvelimen määrittelystä.

Saatavilla olevat Docker-imaget

Sidecar -fi -image

• Tarkoitettu sekä palveluntarjoajien että hyödyntäjien käyttöön Palveluväylässä
• Sisältää kaikki ominaisuudet, ja siksi se soveltuu paremmin palveluntarjoajien käyttöön kuin Sidecar slim.

Sidecar slim -fi -image

• Tarkoitettu ainoastaan Palveluväylän palveluiden hyödyntämiseen
• Ei sisällä monitorointiominaisuuksia tai sanomien lokitusta, joten Sidecar slim on hieman Sidecar -fi -imagea pienempi
• Ei tue aikaleimapalvelun (TSA) konfiguroimista, mutta liityntäpalvelin toimii normaalisti ilman aikaleimapalvelua

Klusteroinnin ja kuormantasauksen toteuttamiseen on olemassa omat imaget sekä Sidecar -fi että Sidecar slim -fi -versioille

• Sidecar -fi ja Sidecar slim -fi primary
• Sidecar -fi ja Sidecar slim -fi secondary

Kaikki imaget ovat ladattavissa maksutta NIIS:in Docker HubistaAvautuu uuteen ikkunaan.. Käytä aina vain -fi päätteisiä imageita, sillä ne ovat mukautettu Palveluväylän käyttöön.

Palveluväylään sopivat Docker-imaget

Voit käyttää useita eri versioita Docker-imageista organisaatiosi tarpeista riippuen. Jokaisessa versiossa on valmiina mukautettu joukko X-road-liityntäpalvelinohjelmiston moduuleita. Imagessa on versiosta riippuen vain X-roadin perusmoduulit tai myös täydentäviä moduuleita.

Löydät kaikkien imageiden kuvaukset Githubista:

• Sidecarin base imagetAvautuu uuteen ikkunaan.
• Kuormantasauksessa käytettävät imagetAvautuu uuteen ikkunaan.

Kunkin imagen käyttötarkoitukset ovat kuvattuna tiivistetysti alla olevassa listassa.

Base imaget

Sidecar slim -fi – niis/xroad-security-server-sidecar: -slim-fi

• Tarkoitettu ainoastaan Palveluväylän palveluita hyödyntävien organisaatioiden käyttöön.
• Sisältää ainoastaan liityntäpalvelimen toimintaan tarvittavat minimipaketit ja konfiguraation.
• Monitorointi- ja lokitusominaisuudet eivät sisälly tähän imageen.
• Aikaleimapalvelua ei voi konfiguroida Sidecar slimillä

Sidecar -fi – niis/xroad-security-server-sidecar: -fi

• Tarkoitettu sekä palveluntarjoajien että hyödyntäjien käyttöön Palveluväylässä
• Käyttää base imagena Sidecar slimiä, mutta sisältää sen ominaisuuksien lisäksi lokitus- ja monitorointipaketit (sekä operational monitoring että environmental monitoring)

Kubernetes-kuormantasaukseen tarvittavat imaget

Klusteroinnin ja kuormanjaon (load balancing) toteuttamiseen on olemassa omat imaget sekä Sidecar -fi että Sidecar slim -fi -versioille. Imaget mahdollistavat ensisijaisen podin (primary pod) ja toissijaisten podien (secondary pod) käyttämisen.

Sidecar slim primary -fi – niis/xroad-security-server-sidecar: -slim-primary-fi

• Tarkoitettu Kubernetes kuormantasauksessa tarvittavaan Primary Pod käyttöönottoon
• Vain Palveluväylän palveluita hyödyntävien organisaatioiden käyttöön

Sidecar slim secondary -fi – niis/xroad-security-server-sidecar: -slim-secondary-fi

• Tarkoitettu Kubernetes kuormantasauksessa tarvittavaan Secondary Pod käyttöönottoon
• Vain Palveluväylän palveluita hyödyntävien organisaatioiden käyttöön

Sidecar primary -fi – niis/xroad-security-server-sidecar: -primary-fi

• Tarkoitettu Kubernetes kuormantasauksessa tarvittavaan Primary Pod käyttöönottoon
• Sopii sekä palveluntarjoajien että palveluita hyödyntävien organisaatioiden käyttöön
• Sisältää sanomien lokituksen ja monitoroinnin (operational monitoring)

Sidecar secondary -fi – niis/xroad-security-server-sidecar: -secondary-fi

• Tarkoitettu Kubernetes kuormantasauksessa tarvittavaan Primary Pod käyttöönottoon
• Sopii sekä palveluntarjoajien että palveluita hyödyntävien organisaatioiden käyttöön
• Sisältää sanomien lokituksen ja monitoroinnin (operational monitoring)

Kontitetun liityntäpalvelimen ylläpito

Lue kontitetun liityntäpalvelimen ylläpidosta (englanniksi) Avautuu uuteen ikkunaan.GitHubista.

Muista huolehtia versiopäivityksistä myös käyttäessäsi kontitettua liityntäpalvelinta. Lisää teknisestä ylläpidosta.