Guidelines for adding a new service » History » Version 1
Timothée Floure, 02/22/2020 11:52 AM
First draft.
| 1 | 1 | Timothée Floure | h1. Guidelines for adding a new service |
|---|---|---|---|
| 2 | |||
| 3 | {{TOC}} |
||
| 4 | |||
| 5 | h2. Status |
||
| 6 | |||
| 7 | This document is *a DRAFT*. |
||
| 8 | |||
| 9 | h2. Workflow |
||
| 10 | |||
| 11 | h3. Deployment pipeline |
||
| 12 | |||
| 13 | CDIST-based, dot-cdist. Upstream if possible. |
||
| 14 | |||
| 15 | h3. Documentation |
||
| 16 | |||
| 17 | * Register in service list |
||
| 18 | * Add documentation pages: |
||
| 19 | ** End-user (if any) |
||
| 20 | ** Common operations (if any) |
||
| 21 | ** Infrastructure |
||
| 22 | * Do not forget to links the pages together! |
||
| 23 | |||
| 24 | h3. Monitoring |
||
| 25 | |||
| 26 | * Plug into consul cluster. |
||
| 27 | * Configure node exporter. |
||
| 28 | * Export service-specific metrics, build Grafana dashboard if useful. |
||
| 29 | * Define and subscribe to alerts regarding the service. |
||
| 30 | |||
| 31 | h3. Security |
||
| 32 | |||
| 33 | * All nodes *should* be firewalled. |
||
| 34 | * Write a "what could go wrong" section in the infrastructure page of the service. |
||
| 35 | |||
| 36 | Please refer to the [[Infrastructure security guidelines and tools]] for details. |