Hva er tjenestekatalog?
Tjenestekatalog er en oversikt over tjenester som Studieadministrasjon leverer.
Vi har levert tjenester til Studieadministrasjon i over 30 år. I løpet av denne tiden har vi rukket å bygge ganske mange ting som tjener sluttbrukerne våre på en eller annen måte. Disse tjenestene har blitt utviklet på forskjellige tidspunkt av forskjellige personer under forskjellige forutsetninger.
For å gjøre det enklere å bruke informasjonen vi legger inn i tjenestekatalogen så definerer vi følgende regler:
Tjenester legges til i katalogen ved at man oppretter en egen katalog per tjeneste. Denne katalogen må inneholde en README.md-fil som skal skrives i Gitlab Flavored Markdown (GLFM). Filen må ha en innledningsblokk i YAML hvor de følgende påkrevde feltene er definert:
| Felt | Forklaring | Eksempel |
|---|---|---|
| identifikator | Unikt internt navn på tjenesten. Bare små bokstaver. | epn |
| livssyklus | Hvor i livssyklusen tjenesten befinner seg. | Vidareutviklast ikkje |
| repo | Url til kildekoden. | https://gitlab.sikt.no/fs/epn/epn-app |
| avhengigheter | Liste med tjenestekoder som tjenesten har direkte avhengigheter til. | fs-plattform |
I tillegg er det ønskelig at man setter de følgende ikke-påkrevde feltene der dette gir mening:
| Felt | Forklaring | Eksempel |
|---|---|---|
| seksjon? | Liste med seksjoner tjenesten tilhører. | Studieadministrasjon |
| intern? | Avklarer om tjenesten har eksterne eller kun interne brukere | True |
Etter innledningsblokken følger brødtekst som beskriver tjenesten. Dersom autorativ dokumentasjon for tjenesten finnes andre steder så må man lenke videre til dette stedet.
Livssyklusstatus
Alle tjenester må ha en livssyklusstatus.
Se Livssyklus for dokumentasjon av hva vi legger i de forskjellige livssyklusstatusene i Studieadministrasjon.
I kontekst av tjenestekatalogen er det dermed bare følgende verdier som er lovlige.
- Innsikt
- Design
- Implementasjon
- Eksperimentell
- Beta
- Stabil
- Ingen videreutvikling
- Erstattes
- Avvikles
- Avviklet