Suomi.fi-palveluväylä ja -verkkopalvelu

Transkriptio

1 Suomi.fi-palveluväylä ja -verkkopalvelu Käyttöönottoa tukeva koulutus

2 Suomi.fi-palveluväylä Sähköisten palveluiden yhtenäistäjä ja tiedon välittäjä

3 Agenda Yleisesti Suomi.fi-palveluväylästä Ympäristöt Liityntäpalvelin Tiedonsiirtoprotokolla Sovitinpalvelu Liityntäpalvelimen operointi ja ylläpito Näin liityt palveluväylään Liityntäkatalogi Liittyjän vastuut Mikä maksaa? Rahoitusmahdollisuuksista (julkinen sektori)

4 Suomi.fi-palveluväylä Tiedonvälityskokonaisuus, joka toimii viestiväylänä siihen liitettyjen palveluiden ja tietovarantojen välillä Käyttövelvollisuus koskee julkista-, käyttöoikeus yksityistä sektoria. Palveluväylän kautta tarjottavat tiedot joko sopimuksenvaraisia hyödyntäjän ja tarjoajan välillä, tai vapaasti kaikkien liittyneiden käytettävissä.

5 Suomi.fi-palveluväylä Perustuu Viron X-Road ratkaisuun Kehitystyö jatkuu tiiviissä yhteistyössä virolaisten kanssa Tarjoaa keskitetyt palvelut sanomaliikenteen mahdollistamiseksi liityntäpalvelimien välillä Osoitteiden hallinta ja reititys Käyttöoikeuksien hallinta Salaus Aikaleimat Lokitus Federointi Viron ympäristöön Tuki asennusvaiheessa sekä ongelmatilanteissa Toimittajana Väestörekisterikeskus. Ympäristöjen hallinnointi tapahtuu yhdessä CSC:n kanssa Suomi.fi-palveluväylän kehitys- ja ylläpito siirtyy VRK:lle lakisääteiseksi tehtäväksi

6 Suomi.fi-palveluväylä Perustietovarannot Valtion palvelut Kuntien palvelut Yritysten palvelut VY-verkko KY-verkko Integraatioalusta (esim. VIA) Integraatioalusta Suomi.fi-palveluväylä Internet Suomi.fi-verkkopalvelu Kansalainen Yritys Viranomainen Palvelutietovaranto (PTV) Tunnistus Valtuudet Suomi.fi-palveluhallinta Liityntäkatalogi Palveluväylän hallinta Kansallinen palveluarkkitehtuuri Tietoturva, raportointi, lokipalvelu

7 Suomi.fi-palveluväylä ympäristökomponentit Hajautettu järjestelmä Keskusinfra (VRK/CSC): Keskuspalvelin Varmennepalvelu + OCSP Aikaleimapalvelu Liityntäkatalogi Ja joukosta liityntäpalvelimia (liittyneet organisaatiot)

8 Palveluväylän ympäristöt Kehitysympäristö (FI-DEV) Niin sanottu kokeiluympäristö, "liity ja kokeile Käyttöä varten ei tarvita varmennehakemuksia Kuka tahansa voi liittyä (myös yksityiset henkilöt) Testiympäristö (FI-TEST) Vastaa teknisesti tuotantoympäristöä Testiympäristö, johon pitää ensin liittyä ennen kuin voi liittyä tuotantoympäristöön Organisaatiot, yritykset ja yhteisöt, joilla on Y-tunnus, voivat liittyä Tuotantoympäristö (FI) Tuotantoympäristö, varsinainen Suomi.fi-palveluväylä Organisaatiot, joilla on Y-tunnus, voivat liittyä

9 Ympäristöjen vertailu

10 Liityntäpalvelin Liityntäpiste palveluväyläympäristöön Asennuspaketit Ubuntu LTS ja RHEL7 alustoille Saatavilla tarkat asennusohjeet eri ympäristöille ja alustoille Yhteistyö kumppanitoimijan kanssa mahdollista - kaikki ei välttämättä tarvitse omaa liityntäpalvelinta Liityntäpalvelimen operointi ja ylläpitotyö voidaan toki ulkoistaa Valtion toimijoille Valtori Kuntatoimijoilla esim. maakunnalliset ICT-yhtiöt. Kuntaliitossa aktiivisia toimijoita Muut mahdolliset (yksityiset) toimijat

11 Termit Member Suomi.fi-palveluväylään liittynyt organisaatio ja samalla liityntäpalvelimen omistajaorganisaatio Subsystem Alijärjestelmä Tapa jakaa liityntäpalvelimen palveluita ja käyttöoikeuksia pienempiin hallinnoitaviin kokonaisuuksiin Suomessa pakollinen viestit lähtevät ja saapuvat aina alijärjestelmälle/-ltä Palvelun tarjoaja lisää palvelunsa aina liityntäpalvelimensa alijärjestelmälle Client Yleinen termi liityntäpalvelimelle kytketylle toimijalle Consumer-client lähettää kutsuja muualla oleviin palveluihin Provider-client tarjoaa palveluja muille Service Palveluväylään liitetty SOAP-palvelu

12 Viestinvälitys

13 Viestiprotokolla Liitettävän tietojärjestelmän on kyettävä lähettämään ja vastaanottamaan sanomia Suomi.fi-palveluväylä -protokollan edellyttämässä SOAP-muodossa. Viesteihin sisällytettävä: otsikko- ja tunnistetietokentät, sekä palvelun määrittelemä hyötytieto-osa (body). Palvelun tarjoaja luotava rajapintakuvaus (WSDL), joka liitetään liityntäpalvelimelle hallintaliittymään. Hallintakäyttöliittymästä hallitaan palvelun luvitukset

14 Kutsu- ja vastaussanomat Kutsusanoma Vastaussanoma

15 Sovitinpalvelu

16 Sovitinpalvelun toteutusvaihtoehdot Sovitinpalvelun toteutusesimerkkejä, kuten REST Gateway:

17 Suorituskyky Parhaimmillaan siirrettäessä pieniä sanomia (alle 100kt) Myös suuremmat sanomat (esim. 500kt) Huomioitava reaaliaikaisuus Suositeltava maksimimäärä yhtäaikaisille kutsujille (yhtä liityntäpalvelinta käyttäessä) Jos sanomakoko 10kt tai alle, yhtäaikaisia kutsuja voi olla n. 100 kpl Jos sanomakoko kt, yhtäaikaisia kutsuja voi olla n. 50 kpl Jos sanomakoko 100kt - 500kt, yhtäaikaisia kutsuja voi olla maksimissaan 35 SOAP-protokolla mahdollistaa suurten (max 400Mt) liitetiedostojen välittämisen Tärkeä huomioida palvelinkapasiteetti

18 Ylläpito ja operointi

19 Operointia ja ylläpitotehtäviä Ohjelmiston asennukset Alijärjestelmien ja palveluiden lisäämiset Avainten ja varmenteiden hallinta Yhteyksien avaamiset liityntäpalvelimelle ja palvelulle Palomuuriavaukset ACL Yhteyksien testaamiset Prosessien valvonta / virhetilanteiden käsittelyä Versiopäivitykset Varmuuskopioinnit ja palauttamiset Arkistoitujen viestilokien / tekstilokien hallinta Muunnokset palvelinkokoonpanossa Lisäkapasiteettia Ulkoisen kuormantasaajan käyttöönotto Konfiguraatioparametrien säätäminen

20 Varmenteet Palveluväylään liitetyllä liityntäpalvelimella tulee olla voimassa olevat varmenteet, jotta se on toimintakuntoinen Jokaisella liityntäpalvelimella on oma autentikointivarmenne todentaa palvelimen käytetään liityntäpalvelinten välisten yhteyksien salaamiseen Jokaisella organisaatiolla on oma allekirjoitusvarmenne todentaa viestin lähettäjän Käytetään liityntäpalvelimen kautta lähetettävien sanomien allekirjoitukseen Voimassaoloaika kaksi vuotta (FI-TEST ja FI)

21 Levytila, messagelog Kaikki sanomat otsikkotiedot sekä niiden tiivisteet ja allekirjoitukset tallentuvat paikalliseen tietokantaan jälkikäteistä todennusta varten (1) Myös hyötytieto voidaan konfiguroida lokitettavaksi, mutta se on oletuksena pois päältä Kannasta niitä puretaan ziptiedostoihin ajastetusti (2) (/var/lib/xroad hakemistoon) Zip-tiedostot täyttävät levyn ellei niitä siirretä muualle (3) tai poista Tätä varten voi käyttää esim. ajastettuja skriptejä 1) 2) 3)

22 Levytila, tekstilokit Liityntäpalvelimen prosessien lokit kirjoitetaan oletuksena /var/log/xroad/ hakemiston alle Lokeihin kirjoitettavaa dataa voidaan säätää eritasoiseksi o esim. DEBUG, INFO, OFF jne. Lokeja kertyy yksi per päivä (100MB kokoraja)

23 Liityntäpalvelimen prosessit Palvelu Tarkoitus Lokisijainti xroad-confclient Keskuskonfiguraatio haut keskuspalvelimelta /var/log/xroad/configuration_client.log xroad-jetty (Ubuntu) xroad-jetty9 (RHEL) Hallintakäyttöliittymä /var/log/xroad/jetty/jetty.log xroad-proxy Sanomaliikenne /var/log/xroad/proxy.log xroad-signer Avainten ja varmenteiden hallinta, allekirjoitusten verifiointi /var/log/xroad/signer.log nginx Edustapalvelin /var/log/nginx/ postgresql Tietokantapalvelin /var/log/postgresql/

24 Liityntäpalvelimen levytila Levytilaa tarvitsevat pääasiassa: Tekstilokit (/var/log/xroad/, ei siivota automaattisesti) Tietokanta (messagelog, oletuksena automaattisesti siivotaan yli 30 päivää vanhat) Arkistoidut sanomalokit (/var/lib/xroad/, ei siivota automaattisesti) SOAP-viestin liitetiedostot (sanoman käsittelyn ajan)

25 Konfiguraatioparametrit Viestilokien oletusarvoiset konfiguraatioparametrien löytyy täältä: /etc/xroad/conf.d/message-log.ini Paikalliset omat muokkaukset tehdään aina local.ini tiedostoon, joka korvaa oletusasetukset Muussa tapauksessa seuraava päivitys tulee korvaamaan tehdyt muutokset Kaikki säädettävissä olevat parametrit kuvattu dokumentissa: ug-syspar_x-road_v6_system_parameters.md (Github: ria-ee / X-Road), esim: archive-interval 0 0 0/6 1/1 *? * CRON lauseke, joka määrittää kuinka usein aikaleimattuja viestejä arkistoidaan archive-path /var/lib/xroad Polku, mihin arkistoidut tiedostot tallennetaan keep-records-for 30 Montako päivää aikaleimattuja ja arkistoituja sanomia pidetään tietokannassa

26 Liityntäpalvelimen portit

27 Palvelinkapasiteetti Suosituksia / laskelmia minimi palvelinkokoonpanoille erilaisissa kuormituksissa: Riippuu lopulta käytettävästä palvelusta ja sen käyttäjämääristä millaista alustakapasiteetti kannattaa valita Kysely- ja vastaussanomakoot Käyttäjien (kyselyiden) määrä

28 HA-tuki X-Roadissa on sisäänrakennettuna yksinkertainen korkean saatavuuden mekanismi Jos sama palvelu* on rekisteröity usealle liityntäpalvelimelle, käytetään sitä liityntäpalvelinta joka vastaa nopeiten (*) Sama palvelu = sama organisaatio & alijärjestelmä & palvelu

29 Tuki ulkoiselle kuormantasaajalle (tulossa) Klusteriin kuuluu n kappaletta nodeja Kaikki palvelevat aktiivisesti asiakkaita (ei hot standby) Ulkomaailma näkee nämä yhtenä nodena Yksi node on konfiguraation suhteen master, muut slaveja Väylässä on siis virallisesti yksi liityntäpalvelin, ja epäviralliset slave nodet teeskentelevät olevansa se

30 Yhteenvetona Käyttäjämäärät ratkaisevia mm. levytilan ja alustakoneen valinnassa Suositeltavaa on, että liityntäpalvelimet olisivat kahdennettuja, jotta vikatilanteessa vara-liityntäpalvelin voidaan ottaa käyttöön Päivityksiä tulee jatkuvasti, niiden asentaminen hyvin suositeltavaa OS tason päivitykset (turvapäivitykset, batchit, uudet versiot jne.) Liityntäpalvelimista julkaistaan uusia versioita 2-4 kpl/vuosi Liityntäpalvelimen valvonta, erityisesti levytilan seuranta tärkeää Kannattaa kiinnittää huomiota jo uuden järjestelmän pystytyksessä Levytila täyttyy, jos arkistoituja tietoja ei siirretä talteen (tai poisteta)

31 Liittyjän vastuut Suomi.fi-palveluväylään kytkettyjen taustajärjestelmien ylläpito Kytkettävät palvelut täyttävät määritellyt tekniset rajapintavaatimukset Sovitinpalvelun toteutus Asentaa ja konfiguroida liityntäpalvelin Ylläpitää liityntäpalvelin käyttökuntoisena Sopia kahdenvälisistä tiedonvaihdoista ja niihin liittyvistä sopimuksista (esim. maksu- / SLA-sopimukset) Lokien säilytys lain asettamien vaatimusten mukaisesti

32 Käyttöönotto

33 Ennen liittymistä Perehtyminen runsaaseen aineistoon, mm. käyttöehtoihin ja käyttöönoton ohjeisiin Youtube-videolla liityntäpalvelimen asennus ja konfigurointiohjeet Lähdekoodit ja teknisempi dokumentaatio Esimerkki siitä miten palveluväylän kautta hoidetut palvelukutsut toimivat

34 Toimi näin liittyäksesi 1. Lähetä rekisteröintipyyntö esuomi.fi:stä löytyvällä lomakkeella o Liitä lomakkeen mukaan autentikointi- ja allekirjoitusvarmennehakemukset (FI-TEST / FI) 2. Saat kuittauksen palveluväylän ylläpidolta voit aloittaa liityntäpalvelimen ohjelmiston asennukset. 3. Palveluväylä-ympäristöön liittyminen on valmis, kun alijärjestelmä on rekisteröity (vihreä tila). Palvelun liittäminen ja testaaminen voidaan aloittaa. 4. Viimeiseksi täytä tarjottavan palvelun hallinnolliset tiedot liityntäkatalogiin (FI-ympäristö)

35 Liityntäkatalogi Hakemisto Suomi.fi-palveluväylän liitynnöistä ja tuotantoympäristössä tarjottavista palveluista ja lista liittyneistä organisaatioista Tarkoituksena on helpottaa eri palveluntarjoajien palveluväyläympäristöön lisättyjen palveluiden löytämistä Palvelun tarjoava organisaatio täyttää puuttuvat tiedot, kun palvelu on saatu tuotua tuotantoympäristöön.

36 Liityntäkatalogi - hallinnollinen kuvaus

37 Liityntäkatalogi - Tekninen kuvaus rajapinnasta

38 Mikä maksaa liittymisessä ja liittymisen jälkeen? Kehittäjät / Ylläpitäjät Liityntäpalvelimet esim. kuormantasaukseen Data JSON / XML / SOAP yms. SOAP Internet Data Tietojärjestelmä Sovitinpalvelu Liityntäpalvelin Lokien arkistointipalvelin Suomi.fi-palveluväylän käyttö ja ylläpito sis. Väestörekisterikeskuksen myöntämät varmenteet 0

39 Rahoitusmahdollisuudet Vain julkiselle sektorille Rahoitusta voi hakea Kansalliseen palveluarkkitehtuuriin liittyviin toteutusprojekteihin saakka seuraaviin asioihin: Keskeisten tietovarantojen liittäminen Palveluväylään Laajasti käytettyjen järjestelmien rajapintojen toteuttaminen Palveluväylään Palveluväyläintegraatioiden toteuttaminen Asiakastietojen tuominen Suomi.fi-verkkopalveluun Valtuudet-palvelun liittäminen omaan järjestelmään Palvelutietovarannon käyttöönotto Vetuma-tunnistuksesta Suomi.fi-tunnistukseen siirtyminen Palveluarkkitehtuuria tukevien toiminnallisuuksien toteuttaminen (pääsääntöisesti osana jotakin Väestörekisterikeskuksen palveluarkkitehtuurihanketta) Lisätietoa:

40 Ohjeet ja lisätietoa osoitteesta: Kysymyksissä ja ongelmatilanteissa sinua palvelevat: ja Tai suoraan:

41 Suomi.fi-verkkopalvelu Kansalaisen ja yrityksen ikkuna julkisiin palveluihin

42 Verkkopalvelu agenda Yleiskatsaus - mitä ovat rekisterit? Edellytykset liittymiselle Liittymisen vaiheet tekninen katsaus

43 Verkkopalvelu ja rekisterit

44 Verkkopalvelu ja rekisterit

45 Verkkopalvelu ja rekisterit

46 Verkkopalvelu ja rekisterit

47 Tietojen syöttö

48 Tietojen syöttö

49 Tiedonkulku väylän yli rekisterin ja verkkopalvelun välillä

50 Esimerkkikysely

51 Kieliversioinnista Verkkopalveluun tehdään parhaillaan kieliversiointia Rekisterien kuvaukset sekä lisätietolinkit syötetään eri kielillä verkkopalvelun admin-käyttöliittymässä verkkopalvelun puolesta. Varsinainen data on kuitenkin käännettävä rekisterin päässä Kyselyssä lähetetään käyttäjän kielestä saatu kenttä, jossa kieli on indikoitu (samoin, kuin lähetetään kenttä, jossa käyttäjän hetu) Vastauksena tulee saada rekisteriltä data tätä kenttää vastaavalla kielellä.

52 Edellytykset verkkopalveluun liittymiselle (1/3) Liityntäpalvelin asennettu, yhteys FI-DEV-väylään kunnossa. Oma taustajärjestelmä kunnossa. Adapteripalvelu toteutettu ja yhteys liityntäpalvelimeen testattu väylän yli pystytään tekemään kyselyjä hetulla, johon vastauksena saadaan yhdessä vastaussanomassa tiedot, jotka halutaan esittää näkymissä. Kysely ja vastaussanomien esimerkit toimitettu verkkopalvelulle.

53 Edellytykset verkkopalveluun liittymiselle (2/3) Esimerkkidata toimitettu verkkopalveluun, myös poikkeustilanteiden osalta (esim. jos tietoa ei löydy, mitä silloin näytetään?) Logo ja kuvailutekstit toimitettu verkkopalvelulle. Linkit ja lisätietotekstit toimitettu verkkopalvelulle. Testihetujen käyttö mahdollistettu (verkkopalvelu toimittaa liittyjälle testihetun, jolla kyselyt lähtevät).

54 Edellytykset verkkopalveluun liittymiselle (3/3) Tietojen näyttäminen verkkopalvelussa mietitty ja kommunikoitu verkkopalvelulle: mitä kenttiä näytetään, mitä näytetään, jos tietoa ei löydy, sivutus. Handlebarstemplate toimitettu tai muuten kuvailtu, mitä halutaan näyttää.

55 Liittymisprosessi tekninen katsaus 1 Liityntäpalvelimen asennus ja liittyminen (FI-DEV ja FI-TEST) 2. Verkkopalvelun luvitus / ACL 3. Palomuuriavaukset sekä rekisterin, että verkkopalvelun päässä aluille. Liittyjän toimitettava näkymille iposoitteet, joihin avaukset tehdään eri väylissä. verkkopalvelusta puolestaan toimitetaan rekistereille verkkopalvelun ip-osoitteet, joista liikenne tulee sallia. 4. Yhteyden testaus 5. Yhteyden testaus metakutsulla 6. Yhteyden testaus varsinaisella suomi.fi palveluväylän kyselyllä 7. Käyttöliittymän templaten määritys ja käyttöliittymän testaus 8. Tekstien katselmointi 9. Kohdat 1-8 FI-TEST-väylässä 10. Kohdat 1-8 FI-väylässä

56 Oikeuksien lisääminen liityntäpalvelimella 1. Kirjaudu LP:n hallintakonsoliin, etsi oikea subsystem ja klikkaa i

57 Oikeuksien lisääminen liityntäpalvelimella 2. Valitse Service Clients, etsi sen palvelun wsdl, jolle haluat oikeuksia lisätä ja valitse Access Rights

58 Oikeuksien lisääminen liityntäpalvelimella 3. Lisätäksesi oikeuksia, valitse Add Subjects

59 Oikeuksien lisääminen liityntäpalvelimella 4. Etsi oikea subsystem (eri väylissä olevat näkymien subsystemit saat palvelunäkymien tekniseltä tuelta)

60 Verkkopalvelun tekstit ja ulkoasu Tarvitaan Lyhytkuvaus rekisterin nostolle Logo Rekisteritietojen vieressä näytettävät tekstit Voidaan toimittaa myös handlebars-template.

61 Käyttöönoton kysymykset / tekninen tuki: Käyttöönoton tekninen tukihenkilö Anne-Mari Silvast Ext.anne-mari.silvast@vrk.fi kapatekninentuki@vrk.fi