Existing Documentation
The following documentations / documents on system installation, deployment, system maintenance and updates already exist and have been made available to system administrators:
- FOLIO Install on github
- Okapi Guide and Reference (will this be discussed in SysOps SIG ? - created by core team)
okapi-curl-env
is a lightweight curl wrapper
- Stripes Core / Documentation roadmap (will this be discussed in SysOps SIG ? - created by core frontend team)
- Helm charts: https://github.com/folio-org/folio-helm , https://gitlab.lrz.de/bib-public/folio-helm
- folio-ansible: VM, Vagrant and Ansible Playbook documentation (will this be discussed in SysOps ? )
- dev.folio.org: Guides - Documentation for the various components of FOLIO (written for developers) (will this be discussed inSysOps SIG ? - maintained by DevOps)
- Docker containers in repository folioci
- PostgreSQL
- Run
VACUUM ANALYZE
andREINDEX <indexname>
on a regular basis (taken from OAI-PMH Best Practices#SlowPerformance and 2020-07-06 Reporting SIG Meeting notes) - Run
VACUUM FULL
on the affected tables before starting a long running migration of a module to a new version (taken from MODINVSTOR-844 Investigate and choose a strategy for publicationPeriod Migration).
- Run
Documentation in the SysOps SIG Wiki pages:
- Deployment Environments (general overview), Architectural diagram
- Notes for Conceptual Architectural Diagram (does this belong to the technical documentation ?)
- Deployment Environments in SIG members' institutes - Deployment at Cornell, hbz, TAMU and VZG (does this belong to the technical documentation ?)
- In-place upgrades and Folio-to-Folio release data-migration
- Performance testing and metrics in SIG members' institutes (does this belong to the technical documentation ?)