Feature #15096

Create high level documentation for our infrastructure

Added by groente 2017-12-23 11:51:14 . Updated 2019-08-09 15:23:09 .

Status:
Confirmed
Priority:
Normal
Assignee:
groente
Category:
Infrastructure
Target version:
Start date:
2017-12-23
Due date:
% Done:

0%

Feature Branch:
Type of work:
Sysadmin
Blueprint:

Starter:
Affected tool:
Deliverable for:

Description

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

Subtasks

Related issues

Blocks Tails - Feature #13284: Core work: Sysadmin (Adapt our infrastructure) Confirmed 2017-06-30
Blocks Tails - Feature #15097: Risk analysis on our infrastructure Confirmed 2017-12-23

History

#1 Updated by intrigeri 2017-12-23 16:47:22

  • Subject changed from High level documentation to High level documentation for our infrastructure

#2 Updated by intrigeri 2017-12-23 16:49:37

  • Description updated

#3 Updated by Anonymous 2018-01-15 08:14:58

  • Subject changed from High level documentation for our infrastructure to Create high level documentation for our infrastructure
  • Status changed from New to Confirmed

#4 Updated by intrigeri 2018-04-08 13:09:42

  • blocks Feature #13284: Core work: Sysadmin (Adapt our infrastructure) added

#5 Updated by intrigeri 2018-04-08 13:11:01

#6 Updated by CyrilBrulebois 2018-12-16 14:07:10

  • Target version changed from Tails_3.11 to Tails_3.12

#7 Updated by anonym 2019-01-30 11:59:23

  • Target version changed from Tails_3.12 to Tails_3.13

#8 Updated by CyrilBrulebois 2019-03-20 14:34:08

  • Target version changed from Tails_3.13 to Tails_3.14

#9 Updated by CyrilBrulebois 2019-05-23 21:23:25

  • Target version changed from Tails_3.14 to Tails_3.15

#10 Updated by CyrilBrulebois 2019-07-10 10:34:04

  • Target version changed from Tails_3.15 to Tails_3.16

#11 Updated by intrigeri 2019-08-09 15:23:09

  • Target version deleted (Tails_3.16)

(As per today’s sysadmin team meeting.)