Hyppää pääsisältöön

Perusopas

Työkalujen asennus

Pitkäaikaissäilytyspalveluiden (PAS-palveluiden) tarjoamista ohjelmakirjastoista ja työkaluista osa pakataan ja jaetaan julkisen RPM (Red Hat Package Manager) -asennuslähteen kautta hyödyntäville organisaatioille. RPM-asennuslähteessä olevat paketit ovat yhteensopivia AlmaLinux 9 (x86_64) käyttöjärjestelmän kanssa ja ne on pakattu RPM-muotoon.

Kaikki julkisesti saatavilla olevat ohjelmistoprojektit löytyvät git-versionhallintapalvelu GitHubista. Tämän dokumentin ohjeilla työkalujen asennus tapahtuu RPM-jakelun avulla, jolloin GitHubissa olevia asennusohjeita ei enää tule seurata. GitHubissa olevat työkalujen käyttöohjeet ovat kuitenkin edelleen relevantteja.

Huomaa, että PAS-palvelun käyttötavastasi riippuen tarvitset vain joitakin näistä työkaluista, jos lainkaan. Parhaiten ensimmäisen käyttöönoton prosessissa edetään keskustelemalla ensin PAS-palvelun kanssa.

RPM-asennuslähteessä olevat paketit

Alla oleva pakettien lista päivitetään tarpeen mukaan.

Paketointikirjasto

python3-dpres-siptools-ng - Tällä kirjastolla voidaan muodostaa kansallisten PAS-määrittelyiden mukaisia siirtopaketteja. Kirjaston tavoitteena on helpottaa hyödyntävien organisaatioiden tuotantojärjestelmien integraatiota PAS-palveluun. Kirjasto muodostaa annetuista kuvailevista metatiedoista ja tiedostoista eheän siirtopaketin. Kirjasto esimerkiksi luo annettujen tietojen perusteella METS-dokumentin, joka sisältää teknisiä ja hallinnollisia metatietoja sekä tiedosto-osion ja aineiston rakennekartan. Kirjasto allekirjoittaa METS-dokumentin ja paketoi tämän, allekirjoituksen sekä tiedostot siirtopakettiin lähetettäväksi PAS-palveluun. Tutkimusaineistojen kohdalla kirjasto on käytössä taustalla Fairdata PAS-hallintaliittymässä, jota käytettäessä organisaatio ei erikseen tarvitse omaa kirjastoa.


Kirjasto METS-dokumenttien luontiin

python3-dpres-mets-builder – Kirjaston avulla voi luoda kansallisten PAS-määrittelyiden mukaisia METS-dokumentteja. Kirjastoa käytetään osana Paketointikirjastoa, mutta sitä voi myös käyttää suoraan räätälöityihin tarpeisiin. Kirjastoa voi käyttää Paketointikirjaston rinnalla.


Tiedostojen analysointityökalu

python3-file-scraper-full - Tämä ohjelmisto tunnistaa tiedostojen tiedostomuotoja, kerää niistä metatietoja ja tarkistaa, että tiedostot ovat rakenteeltaan eheitä ja määrittelyiden mukaisia. Myös graafinen Validoi tiedostosi -palvelu käyttää tätä työkalua suoraan.


Työkalu PAS-palvelujen rajapintojen käyttöön

dpres-access-rest-api-client – Työkalu aineistojen hallinnointiin ja jakeluun kansallisten PAS-määrittelyiden rajapintojen avulla. Työkalu on käyttäjäystävällisempi tapa hyödyntää PAS-palvelujen rajapintoja, automatisoiden useita rajapintakutsuja.


Tietopakettien validointikirjasto

python3-dpres-ipt - Sisältää työkaluja kansallisten PAS-määrittelyiden mukaisesti muodostettujen siirto- ja jakelupakettien validointiin.


Tietopakettien päivittämistyökalu

python3-dpres-specification-migrator - Tätä työkalua käytetään olemassa olevan tietopaketin (joka on aiemmin luotu kansallisten PAS-määrittelyiden mukaiseksi) METS-dokumentin päivittämiseksi kansallisten PAS-määrittelyiden uudempaan versioon.


Tietopakettien allekirjoittamistyökalu

python3-dpres-signature - Tätä työkalua käytetään tietopakettien allekirjoituksien luomiseen ja olemassa olevien allekirjoituksien tarkistamiseen. Paketointityökalu hyödyntää tätä työkalua siirtopakettien allekirjoituksien luomisessa.


Työkalu Metax-metatietovarannon käyttöön

python3-metax-access - Komentorivityökalu aineistojen hallinnointiin Metax-metatietovarannon rajapintojen kautta. työkalua tarvitaan vain Fairdata PAS-palvelussa silloin, jos aineistokuvailua ei tehdä Qvain-kuvailutyökalun avulla vaan metatiedot siirretään suoraan Metax-metatietovarantoon Metax API:n kautta.


Työkalu pienimuotoisesti räätälöityyn paketointiin

python3-dpres-sip-compiler - Tätä työkalua käytetään siirtopakettien puoliautomaattiseen muodostamiseen. Työkalu soveltuu pienimuotoisesti räätälöityyn paketointiin. Työkaluun voi kehittää organisaatiokohtaisia adaptereita. Tutkimusaineistoille työkalua ei käytetä, jos paketointi tehdään Fairdata PAS-hallintaliittymän avulla, jossa paketointi ja siirto PAS-palveluun tapahtuu palveluna. Työkalua ei myöskään käytetä, jos käytetään suoraan Paketointikirjastoa. Työkalu hyödyntää toistaiseksi vanhaa poistumassa olevaa Paketointityökalua.


Paketointityökalu (poistumassa)

python3-dpres-siptools - Tämä työkalu, jonka avulla voidaan muodostaa kansallisten PAS-määrittelyiden mukaisia siirtopaketteja, on korvattu uudella Paketointikirjastolla. Työkalu on edelleen käytettävissä, mutta sitä ei päivitetä enää. Suosittelemme siirtymään uuden Paketointikirjaston käyttöön aineiston paketoinnissa.

Asentaminen

Edellä mainitut paketit voidaan asentaa AlmaLinux 9:llä osoitteesta pas-jakelu.csc.fi seuraavasti:

RPM-asennuslähteen asentaminen (nämä komennot ajetaan vain kerran)

  1. Tuo RPM-asennuslähteen lataamiseen tarvittava julkinen avain koneellesi komennolla:

    sudo rpm --import https://pas-jakelu.csc.fi/RPM-GPG-KEY-pas-support-el9 
  2. Asenna RPM-asennuslähteen lataamiseen tarvittava 'dnf config-manager', joka löytyy dnf core plugins -paketista, komennolla:

    sudo dnf install dnf-plugins-core 
  3. Lataa sitten RPM-asennuslähde komennolla:

    sudo dnf config-manager --add-repo=https://pas-jakelu.csc.fi/pas-jakelu-csc-fi.repo
  4. Lataa kolmannen osapuolten työkalujen vaatimat asennuslähteet (epel ja rpmfusion) komennoilla:

    sudo dnf config-manager --set-enabled crb
    sudo dnf install epel-release
    sudo dnf install --nogpgcheck https://mirrors.rpmfusion.org/free/el/rpmfusion-free-release-9.noarch.rpm

Yllä olevat neljä vaihetta suoritetaan vain ensimmäisellä kerralla, sillä RPM-asennuslähteen lataamista ei tarvitse toistaa.

RPM-pakettien asentaminen

Kun RPM-asennuslähde on ladattuna koneelle, sieltä löytyvät RPM-paketit voi asentaa komennolla:

sudo dnf install PAKETINNIMI 

PAKETINNIMI tulee korvata asennettavan paketin nimellä esim. python3-file-scraper-full. Jos paketti on jo asennettuna, sen voi päivittää uusimpaan versioon komennolla

sudo dnf update PAKETINNIMI 

Linux-ympäristön kaikki asennetut paketit saa päivitettyä komennolla

sudo dnf update 

Lisäksi on mahdollista hyödyntää Linux-ohjelmistoja, jotka päivittävät RPM-paketit automaattisesti.