Suomi.fi-palveluväylä ja palvelunäkymät 25.1.2017
Suomi.fi-palveluväylä Antti Luoma, käyttöönoton tekninen tuki
Agenda Palveluväylä Liityntäpalvelimen ylläpito Käyttöönotto
Suomi.fi-palveluväylä Perustuu Viron X-Roadin ns. X-tee ratkaisuun jota nyt yhteistyössä kehitetään Tarjoaa keskitetyt palvelut sanomaliikenteen mahdollistamiseksi liityntäpalvelimien välillä Palveluihin sisältyy muun muassa: º Osoitteiden hallinta ja reititys º Käyttöoikeuksien hallinta º Salaus º Aikaleimat º Lokitus º Virheiden käsittely º Tuki asennusvaiheessa sekä ongelmatilanteissa Vastaavina organisaatioina toimivat VRK ja CSC
Suomi.fi-palveluväylä 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ä Tuotantoympäristö (FI) º Tuotantoympäristö, varsinainen Suomi.fi-palveluväylä º Suomalaiset organisaatiot, yritykset ja yhteisöt, joilla on Y-tunnus, voivat liittyä
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 Käytetään liityntäpalvelinten välisten yhteyksien salaamiseen º Jokaisella organisaatiolla on oma allekirjoitusvarmenne Käytetään liityntäpalvelimen kautta lähetettävien sanomien allekirjoitukseen
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. º XML SOAP-sanomiin sisällytettävä tarkat Suomi.fi-palveluväylän määrittelemät otsikko- ja hyötytietokentät º Tarjoaja luo rajapintakuvaukset (WSDL) liitettävistä palveluista, joka linkitetään liityntäpalvelimelle Käytännössä tarkoittaa jonkinlaisen sovitinratkaisun luomista ja käyttämistä liityntäpalvelimen ja oman tietojärjestelmän välille Sanomaesimerkki myöhemmin Palvelunäkymien esimerkissä
Sovitinpalvelu Lisätietoa: esuomi.fi X-road tiedonsiirtoprotokolla
Sovitinpalvelun toteutusvaihtoehdot
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 2 2 1 3
Levytila, tekstilogit Liityntäpalvelinprosesseista syntyvät lokit kirjoitetaan oletuksena /var/log/xroad/alle º Lokeihin kirjoitettavaa dataa voidaan säätää eritasoiseksi esim. DEBUG, INFO, OFF jne. Prosesseista lisätietoa: esuomi.fi Liityntäpalvelimen valvonta
Liityntäpalvelimen prosessit
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 local.ini tiedostoon, joka ylikirjoittaa oletusasetukset
Ylläpitäjät HUOM! 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) 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
Suorituskyky https://esuomi.fi/palveluntarjoajille/palvelulupaukset/ 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
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? Tarjottavien tietovarantojen ylläpito - Palveluväylän käyttö - VRK:n myöntävät varmenteet 0 - Sovitinpalvelun rakennus ja ylläpito - Substanssijärjestelmään vaadittavat muutostyöt? - Palvelinvuokra yms. - Liityntäpalvelimen asennus- ja ylläpitotyö - Lokien arkistointi
Ennen liittymistä Perehtyminen runsaaseen aineistoon: º esuomi.fi/palveluvayla º Youtubesta Kansallinen palveluarkkitehtuuri -kanava: liityntäpalvelimen asennus ja konfigurointiohjeet Tarkempi tekninen dokumentaatio (ja lähdekoodit) º https://github.com/vrk-kpa/xroad-public/tree/master/src/doc 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 Liitä lomakkeen mukaan autentikointi- ja allekirjoitusvarmennehakemukset 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. Käyttöönottoprosessin läpimeno uusilla liittyjillä voi olla jopa kaksi kuukautta!
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
Yhteydenpito käyttöönoton aikana: palveluvayla@palveluvayla.fi Palveluväylän tekninen tuki: ext.antti.luoma@vrk.fi / kapatekninentuki@vrk.fi Muut kysymykset: kapa-asiakaspalvelu@vrk.fi
Suomi.fi-palvelunäkymät Anne-Mari Silvast, palvelunäkymiin liittymisen tekninen tuki
Palvelunäkymät agenda Näkymät yleiskatsaus Edellytykset liittymiselle Liittymisen vaiheet tekninen katsaus
Palvelunäkymät ja rekisterit
Palvelunäkymät ja rekisterit
Palvelunäkymät ja rekisterit
Tiedonkulku väylän yli rekisterin ja näkymien välillä
Esimerkkikysely
Edellytykset palvelunäkymiin liittymiselle 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 palvelunäkymille. Esimerkkidata toimitettu palvelunäkymille, myös poikkeustilanteiden osalta (esim. jos tietoa ei löydy, mitä silloin näytetään?) Logo ja kuvailutekstit toimitettu näkymille. Linkit ja lisätietotekstit toimitettu näkymille. Testihetujen käyttö mahdollistettu (näkymät toimitttaa liittyjälle testihetun, jolla kyselyt lähtevät). Tietojen näyttäminen näkymissä mietitty ja kommunikoitu näkymille: 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. Palvelunäkymien luvitus / ACL 3. Palomuuriavaukset sekä rekisterin, että palvelunäkymien päässä aluille. Liittyjän toimitettava näkymille iposoitteet, joihin avaukset tehdään eri väylissä. Näkymistä puolestaan toimitetaan rekistereille näkymien iposoitteet, joista liikenne tulee sallia. 4. Yhteyden testaus 5. Yhteyden testaus metakutsulla 6. Yhteyden testaus varsinaisella 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ä
Oikeuksien lisääminen liityntäpalvelimella 1. Kirjaudu LP:n hallintakonsoliin, etsi oikea subsystem ja klikkaa i
Oikeuksien lisääminen liityntäpalvelimella 2. Valitse Services, 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)
Näkymien 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 kapatekinentuki@vrk.fi