Solution
Systems documentation and architecture
Mapping of applications, servers and network traffic. Documentation of APIs, configurations and deployment, diagnostic and restoration runbooks for technical teams.
Architecture and implementation
Technical mapping
Architecture models of applications, data and their dependencies.
Software documentation
Documentation of interfaces, configurations and implementation decisions.
Operations documentation
Operating procedures and systems administration guides.
Design decisions
Documentation built around the operated services, dependencies, configurations and procedures. Diagrams describe exchanges; procedures explain how to observe, change and restore each component.
Illustrative implementation
A service record can connect deployment, data, logs and routine operations with verifiable commands and configuration references.
Engineering outputsSystem map, technical inventory, procedures and configuration references
A compute platform runs Python and R analyses of genomic sample batches in containers. Each run retains references to input files, the Git commit, container image and parameters so results can be compared and the pipeline rerun on another dataset.
Apache Airflow
Docker
GitHub
Kubernetes
Linux
PostgreSQL
Pure Storage
Python
R
Terraform
Components and flows
- PostgreSQL catalogue for datasets, parameters and provenance; shared storage for files and results
- Docker images built from identified GitHub versions, then executed through Airflow and Kubernetes
- Python and R processing, result publishing and execution records
Development and integration
- Architecture models and diagrams
- API and data documentation
- Configurations and operating procedures
- Technical knowledge bases
Systems involved
- Code repositories and documentation tools
- Applications and infrastructure
- Databases and identity systems
Service lineServers and hosting →
Discuss your project
A discussion of your project’s design, development and production deployment.