Skip to content

Create high level documentation for our infrastructure

The project could benefit from visual high level documentation (flowcharts) giving insight in the different processes that run on our infrastructure. This will make it easier to:

  • onboard new people
  • analyse problems where multiple parts of the infra interact
  • identify points of improvement within the infra

BPMN seems like a good candidate, ideally (at least in part) auto-generated from inline comments in puppet to ensure the documentation stays up-to-date.

For this first iteration:

  • set up the framework to write & maintain this documentation, so that our sysadmins can automatically generate locally a useful visualization out of it
  • private output, don’t bother about public/private separation
  • document the CI setup

Related issues

Original created by @groente on 15096 (Redmine)

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information