Suomi.fi-palveluväylä ja -verkkopalvelu Käyttöönottoa tukeva koulutus 1.3.2017
Suomi.fi-palveluväylä Sähköisten palveluiden yhtenäistäjä ja tiedon välittäjä
Agenda Suomi.fi-palveluväylä Liityntäpalvelimen ylläpito Näin liityt palveluväylään Liityntäkatalogi Mikä maksaa?
Suomi.fi-palveluväylä Tarjoamme vakioidun tavan tietojen siirtoon organisaatioiden välillä ja mahdollistamme turvallisten palvelukokonaisuuksien rakentamisen. Suomi.fi-palveluväylä Liityntäkatalogi Ympäristö Tiedonsiirto
Suomi.fi-palveluväylä Tiedonvälityskokonaisuus, joka toimii viestiväylänä siihen liitettyjen palveluiden ja tietovarantojen välillä Palveluväylään voidaan kytkeä sekä julkisen, että yksityisen sektorin palveluita. Palveluväylän kautta tarjottavat tiedot voivat olla sopimuksenvaraisia hyödyntäjän ja tarjoajan välillä tai vapaasti käytettävissä (avointa dataa)
Suomi.fi-palveluväylä Perustuu Viron X-Roadin ns. X-tee 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 Virheiden käsittely Tuki asennusvaiheessa sekä ongelmatilanteissa Toimittajana Väestörekisterikeskus. Ympäristöjen hallinnointi yhdessä CSC:n kanssa KaPA-ohjelman loppuessa, 2018 vuoden alusta alkaen, palveluväylän tuottaminen siirtyy VRK:lle lakisääteiseksi tehtäväksi
Suomi.fi-palveluväylä vs. kansallinen palveluväylä vs. X-Road Perustietovarannot Valtion palvelut Kuntien palvelut Yritysten palvelut VY-verkko Integraatioalusta (esim. VIA) Integraatioalusta KY-verkko 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
Suomi.fi-palveluväylä ympäristökomponentit Ei yhtä yksittäistä palveluväyläkomponenttia vaan on ns. hajautettu järjestelmä Liityntäkatalogi Koostuu liityntäpalvelinten joukosta + keskuspalveluista Sanomaliikenne vain liityntäpalvelinten välistä
Palveluväylän ympäristöt Kehitysympäristö (FI-DEV) Niin sanottu kokeiluympäristö, "liity ja kokeile Käyttöä varten ei tarvita varmenteita Kuka tahansa voi liittyä (myös yksityiset henkilöt) Testiympäristö (FI-TEST) Testiympäristö, johon pitää ensin liittyä ennen kuin voi liittyä tuotantoympäristöön Suomalaiset organisaatiot, yritykset ja yhteisöt, joilla on Y-tunnus, voivat liittyä Vastaa teknisesti tuotantoympäristöä Tuotantoympäristö (FI) Tuotantoympäristö, varsinainen Suomi.fi-palveluväylä Suomalaiset organisaatiot, yritykset ja yhteisöt, joilla on Y-tunnus, voivat liittyä
Viestiprotokolla Liitettävän tietojärjestelmän on kyettävä lähettämään ja vastaanottamaan viestisanomia Suomi.fi-palveluväylä -protokollan edellyttämässä muodossa. Palvelun tarjoaja luo rajapintakuvaukset (WSDL) liitettävistä palveluista, joka linkitetään liityntäpalvelimelle Liityntäpalvelimella hallitaan palvelurajapinnan luvittamista - kuka voi kutsua Käytännössä tarkoittaa jonkinlaisen sovitinratkaisun luomista ja käyttämistä liityntäpalvelimen ja oman tietojärjestelmän välille
Kutsu- ja vastaussanomat
Sovitinpalvelu
Sovitinpalvelun toteutusvaihtoehdot
Liityntäpalvelin Liityntäpiste palveluväyläympäristöön Kokoonpano vakioitu Asennuspaketit Ubuntu 14.04 LTS ja RHEL7 alustoille Saatavilla tarkat asennusohjeet eri ympäristöille ja alustoille Voi olla organisaatiokohtainen tai monen organisaation yhteinen Jokaisella liityntäpalvelimella on oma autentikointivarmenne o Käytetään liityntäpalvelinten välisten yhteyksien salaamiseen Jokaisella organisaatiolla on oma allekirjoitusvarmenne o Käytetään liityntäpalvelimen kautta lähetettävien sanomien allekirjoitukseen
Liityntäpalvelimen ylläpitotoimintoja Hallintakäyttöliittymästä: Konfiguraatioankkuri PIN-koodin syöttäminen Varmenteet Varmuuskopiointi ja palauttaminen Diagnostiikka Palveluiden lisääminen Muilla tavoin: Palomuuriavaukset Prosessien valvonta Konfiguraatioparametrit Levytilan vapauttaminen
Levytila, messagelog Kaikki sanomat otsikkotiedot sekä niiden tiivisteet ja allekirjoitukset tallentuvat paikalliseen tietokantaan jälkikäteistä todennusta varten. Myös hyötytieto voidaan konfiguroida lokitettavaksi, mutta se on oletuksena pois päältä Kannasta niitä puretaan ziptiedostoihin ajastetusti (/var/lib/xroad hakemistoon) Zip-tiedostot täyttävät levyn ellei niitä siirretä muualle 1) 2) 3)
Levytila, tekstilogit Liityntäpalvelinprosesseista syntyvät lokit kirjoitetaan oletuksena /var/log/xroad/alle Lokeihin kirjoitettavaa dataa voidaan säätää eritasoiseksi o esim. DEBUG, INFO, OFF jne.
Liityntäpalvelimen prosessit Prosessi (service) xroad-confclient xroad-jetty xroad-proxy xroad-signer nginx Kuvaus Global conf konfiguraatiotietojen hausta keskuspalvelimelta vastaava asiakassovellus (client) Hallintakäyttöliittymän sovelluspalvelin Liityntäpalvelinten välisestä sanomaliikenteestä vastaava komponentti Avainten hallintaan ja mm. sanomien allekirjoitusten, sekä allekirjoitusten verifioinnista vastaava komponentti www-palvelin
Liityntäpalvelimen portit
Konfiguraatioparametrit Konfiguraatioparametrien oletusarvoiset parametrit löytyvät hakemistosta /etc/xroad/conf.d Säätömahdollisuuksia löytyy muun muassa: Tallennushakemistojen määrittelyyn Sanomalokien säilytysaikaan Aikaleimojen määrään Viestipaketointien aikavälin määrittely (CRON) Paikalliset muutokset tehdään aina local.ini tiedostoon, joka korvaa oletusasetukset Muussa tapauksessa seuraava päivitys tulee korvaamaan tehdyt muutokset
Ylläpitäjät HUOM! 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-3 kpl/vuosi Liityntäpalvelimen valvonta on suositeltavaa, jotta järjestelmä pysyy stabiilina ja käyttökunnossa Levytilan valvonta on tärkeää Kannattaa kiinnittää huomiota jo uuden järjestelmän pystytyksessä Levytila täyttyy, jos arkistoituja tietoja ei siirretä talteen (tai poisteta)
Suorituskyky Parhaimmillaan siirrettäessä pieniä sanomia (alle 100kt) Myös suuremmat sanomat (esim. 500kt) Huomioi suorituskyky / 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 10-100kt, 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 https://esuomi.fi/suorituskykyinen-suomi-fi-palveluvayla/
Ennen liittymistä Perehtyminen runsaaseen aineistoon: esuomi.fi/palveluvayla Youtube-videolla liityntäpalvelimen asennus ja konfigurointiohjeet Lähdekoodit ja teknisempi dokumentaatio: https://github.com/ria-ee/x-road Tutustu Suomi.fi-palveluväylän käyttöehtoihin ja käyttöönoton ohjeisiin: https://esuomi.fi/palveluntarjoajille/palveluvayla/liittyminen/
Toimi näin liittyäksesi 1. Lähetä rekisteröintipyyntö esuomi.fi:stä löytyvällä lomakkeella i. Liitä lomakkeen mukaan autentikointi- ja allekirjoitusvarmennehakemukset ii. Hakemukset voidaan lähettää myös erikseen palveluvayla@palveluvayla.fi -osoitteeseen. 2. Asenna liityntäpalvelimen ohjelmistot asennusohjeiden mukaisesti. 3. Palveluväylä-ympäristöön liittyminen on valmis, kun alijärjestelmä on rekisteröity (vihreä tila). Palvelun liittäminen ja testaaminen voidaan aloittaa.
Sovitinpalvelu / järjestelmäintegraatio Palveluväyläohjelmiston asennus
Liityntäkatalogi https://liityntakatalogi.suomi.fi/ Hakemisto kansallisen palveluväylän liitynnöistä ja palveluista 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 tarjolle tuotantoympäristöön.
Liityntäkatalogi hallinnollinen kuvaus
Liityntäkatalogi- Tekninen kuvaus rajapinnasta
Liittyjän vastuut Vastaa omien tietojensa ja palveluidensa ylläpidosta Päättää kenelle jakaa tietojaan Vastaa siitä, että kytkettävät palvelut täyttävät määritellyt tekniset rajapintavaatimukset Asentaa ja ylläpitää oman liityntäpalvelimensa Lokien säilytyksestä ja arkistoinnista asianmukaisesti lainsäädännön tai muun vaatimuksen edellyttämän määräajan.
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
Rahoitusmahdollisuudet Vain julkiselle sektorille Rahoitusta voi hakea Kansalliseen palveluarkkitehtuuriin liittyviin toteutusprojekteihin 31.5.2017 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: http://vm.fi/palveluarkkitehtuuri-tukea-liittymiseen
Ohjeet ja lisätietoa osoitteesta: Kysymyksissä ja ongelmatilanteissa sinua palvelevat: kapa-asiakaspalvelu@vrk.fi ja kapatekninentuki@vrk.fi Tai suoraan: ext.antti.luoma@vrk.fi
Suomi.fi-verkkopalvelu Kansalaisen ja yrityksen ikkuna julkisiin palveluihin
Verkkopalvelu agenda Yleiskatsaus Edellytykset liittymiselle Liittymisen vaiheet tekninen katsaus
Verkkopalvelu ja rekisterit
Verkkopalvelu ja rekisterit
Verkkopalvelu ja rekisterit
Tiedonkulku väylän yli rekisterin ja verkkopalvelun välillä
Esimerkkikysely
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ä.
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.
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).
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ää.
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 xroad-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ä
Oikeuksien lisääminen liityntäpalvelimella 1. Kirjaudu LP:n hallintakonsoliin, etsi oikea subsystem ja klikkaa i
Oikeuksien lisääminen liityntäpalvelimella 2. Valitse Service Clients, etsi sen palvelun wsdl, jolle haluat oikeuksia lisätä ja valitse Access Rights
Oikeuksien lisääminen liityntäpalvelimella 3. Lisätäksesi oikeuksia, valitse Add Subjects
Oikeuksien lisääminen liityntäpalvelimella 4. Etsi oikea subsystem (eri väylissä olevat näkymien subsystemit saat palvelunäkymien tekniseltä tuelta)
Verkkopalvelun tekstit ja ulkoasu Tarvitaan Lyhytkuvaus rekisterin nostolle Logo Rekisteritietojen vieressä näytettävät tekstit Voidaan toimittaa myös handlebars-template.
Käyttöönoton kysymykset / tekninen tuki: Käyttöönoton tekninen tukihenkilö Anne-Mari Silvast Ext.anne-mari.silvast@vrk.fi kapatekninentuki@vrk.fi