Docs

This is a listing of technical documentation materials related to various DAUF components.

Confluence documentation

• System architecture described in KTH’s Confluence

Slides providing overviews

• Overview slides for Operations and maintenance
• Documentation for performance optimization practices and tools
• Documentation for development workflow for ABM - using GitHub Flow
• Documentation for styling in ABM

Components used in ABM

• Documentation for kontarion-bundle - how to operate and use the full application bundle (Note that this is behind login in KTHs local git instance ‘Gita’)
• Documentation for kontarion source code at GitHub - how to operate and use the image bundling the ABM application and its dependencies
• Documentation for kontarion binaries at Docker Hub
• Documentation for bibliomatrix R package at GitHub - how to operate and develop the R package that contains the ABM application, REST API and embedded public data
• Documentation for ktheme R package at GitHub - how to use KTH’s graphical profile assets from R (for plotting or generating web content with the KTH style)
• Documentation for ABM load testing tools - how to load test the ABM components
• Documentation for kthapi R package at GitHub - data access from KTH APIs using R (Profiles, Directory)
• Documentation for kthcorpus R package at GitHub - data curation tools for the KTH publication corpus (Publications, Authors)
• Documentation for bibliotools R package at GitHub - various authenticated apps, APIs and tools, including the KTH Publication Analysis app (hosted in a private repo)

Diagrams

Schematics for:

• ABM application (for public and internal KTH users)
• Authentication flow for applications with external Vinnova / BibCap users

DAUF

Open/Edit this diagram

ABM

Open/Edit this diagram

Vinnova/BibCap

Open/Edit this diagram

KTH OIDC integrations

The following services are currently configured for integration against load balancer and using KTH OIDC auth:

• “dauf-prod” - Integrated w LB and KTH OIDC NB: needs VPN

Confluence Documentation links

The ABM services are documented here:

• Systems configuration (confluence, authenticated)

Webhooks for Vinnova / BibCap apps/APIs

The KTH Library have some non-KTH users (Vinnova / BibCap) which require authed external access to apps and APIs. For this purpose, CI/CD utilises webhooks to redeploys BibCap apps and APIs from private repos on git push.

Webhooks info:

• lives at https://bibliometrics.lib.kth.se/hooks/
• settings for webhook are configured at at https://github.com/kth-library/bibliotools/settings/hooks

Dataflows for HR + DiVA Team tools/services

• SFTP acccess for HR
• Confluence link documenting HR data flow

Source code and CI/CD (using GHAs and ghcr.io registry)

Source code for tools/apps/APIs are open source at GitHub

For built packages, GitHub Action triggers CI for running tests and checks on commit/push/merge. Often this results in container images stored in the GitHub Container Registry. See listing here

Some of the build logs can be found for example here:

• Build logs for bibliomatrix
• Build logs for kontarion

Status pages

Status pages are available here:

• Status page for DAUF services uptimerobot used
• Status page for various KTH services