Liityntäpalvelimen konfigurointi X-Road toolkitillä

Tässä artikkelissa kuvataan miten liityntäpalvelin konfiguroidaan X-Road toolkitillä. Perustietoa X-Road toolkitistä voit lukea erillisestä tukiartikkelista.

X-Road toolkitin käytön edellytykset

• Alustapalvelimella, jolle liityntäpalvelinohjelmisto asennetaan, on valmiina RHEL-käyttöjärjestelmä (7,8) tai Ubuntu-käyttöjärjestelmä 20.04 LTS tai 22.04 LTS.
• Alustapalvelimelle on asennettualustapalvelimeen (RHEL, Ubuntu) pohjautuvan liityntäpalvelimen asennuspaketit.
• Käytössä on Python-versio 3.6 tai uudempi.
• Tarvittavat portit on avattu palvelimeltasi ennen liityntäpalvelimen määrittelyä. Lue palomuuriavauksista käyttöönoton ohjeista kohdasta 2.
• Liityntäpalvelimella on ohjeiden mukainen nimi

Lue lisää käyttöönoton edellytyksistä Githubista (englanniksi)Avautuu uuteen ikkunaan..

1. Liityntäpalvelimen rekisteröiminen

1. Ota selaimella yhteyttä hallintakäyttöliittymään.

Hallintakäyttöliittymä löytyy osoitteesta https://{hostname}:4000, jossa {hostname} on asennetun liityntäpalvelimen nimi.

2. Kirjaudu liityntäpalvelimen hallintakäyttöliittymään.

3. Tuo järjestelmään konfiguraatioankkuri, jonka sait Palveluväylän ylläpidolta. Valitse Upload, etsi konfiguraatioankkuri ja valitse Import.

4. Vahvista konfiguraatioankkurin tuominen järjestelmään valitsemalla Confirm.

• Member Code: oman organisaatiosi Y-tunnus
• Member Name: oman organisaatiosi nimi (järjestelmän pitäisi täydentää se automaattisesti)

Jos automaattinen täydennys ei toimi, tarkista, että liityntäpalvelimesi pystyy ottamaan yhteyttä keskuspalvelimille portissa TCP/80. Yleensä syynä virheeseen on se, että palvelimeltasi ei ole sallittu ulospäin tehtävää yhteydenottoa keskuspalvelimelle.

• Security Server Code: liityntäpalvelimen yksilöivä tunnus, tyypillisesti palvelimen nimen host-osa

5. Syötä liityntäpalvelimen asentajan päättämä PIN-koodi (salasana), jonka pituus on vähintään 10 merkkiä. PIN-koodissa pitää olla merkkejä vähintään kolmesta seuraavasta luokasta: pienet kirjaimet, isot kirjaimet, numerot ja erikoismerkit. Säilytä PIN-koodi turvallisessa paikassa.

Jos kaikki sujui asianmukaisesti lisätyn jäsenen tulisi näkyä Saved-tilassa. 

2. Asenna X-Road toolkit

Löydät ohjeet Toolkitin asentamiseen Githubista (englanniksi)Avautuu uuteen ikkunaan..

3. Määrittele toolkitin haluttu toiminta ja tiedot YAML-konfiguraatioon

Toolkitin haluttu toiminta ja tiedot määritellään YAML-konfiguraatioon. Määriteltäviä tietoja ovat esimerkiksi:

• liityntäpalvelimen tiedot, kuten sen FQDN-nimi sekä
• liityntäpalvelimen omistajan tiedot, kuten organisaation tyyppi. 

Lue lisää YAML-konfiguraatiotiedoston muokkaamisesta Githubista (englanniksi)Avautuu uuteen ikkunaan..

4. Aja määritellyt toimenpiteet

Toolkitin konfiguraatioon määritellyt toimenpiteet voidaan ajaa seuraavien ohjeiden mukaan:

1. Aja koko konfiguraatio kerralla xrdsst apply -komennolla. Ajo loppuu ilmoitukseen siitä, että varmenteet täytyy allekirjoittaa.

2. Lataa varmennepyynnöt xrdsst cert download-csrs -komennolla ja lähetä ne allekirjoitettavaksi osoitteeseen palveluvayla@palveluvayla.fi.

3. Kun olet saanut allekirjoitetut varmenteet Palveluväylän tuelta, lisää konfiguraatiotiedostoon polku allekirjoitettuihin varmenteisiin.

4. Jatka tämän jälkeen koko konfiguraation ajamista xrdsst apply -komennolla. 

Osia konfiguraatiosta voidaan ajaa yksitellen alikomennoilla. Yksittäiset komennot löytyvät NIISin ohjeista Githubista (englanniksi)Avautuu uuteen ikkunaan..

Virhetilanteet

Jos liityntäpalvelimen määrittelyn aikana ilmenee virheitä, konfigurointi pysähtyy virheilmoitukseen. Virheilmoituksessa kerrotaan, missä virhe ilmeni ja miten sen voi korjata. Jos virheilmoituksesta ei ole apua tai et pysty korjaamaan virhettä, ota yhteyttä Palveluväylän tukeen palveluvayla@palveluvayla.fi.  

Huom! Jos määrittelet kontitetun Sidecar Slim liityntäpalvelimen X-Road Toolkitilla, saat konfiguroinnissa virheilmoituksen siitä, että aikaleimapalvelun konfiguroiminen ei onnistunut. Tämä johtuu siitä, että Sidecar Slim ei sisällä lokitusta eikä aikaleimapalvelua, jolloin niitä ei voi myöskään määritellä. Tämän virheen voi ohittaa ja liityntäpalvelimen määrittely onnistuu ja liityntäpalvelin toimii virheilmoituksesta huolimatta. 

Lue lisää virhetilanteista Githubista (englanniksi)Avautuu uuteen ikkunaan..

Kun olet konfiguroinut liityntäpalvelimen, voit siirtyä alijärjestelmän lisäämiseen. Seuraa Uuden alijärjestelmän liittäminen liityntäpalvelimeen ja sen poistaminen -tukiartikkelin ohjeistusta.