Project

General

Profile

Actions

Guidelines for adding a new service

Status

This document is a DRAFT.

Workflow

Deployment pipeline

CDIST-based, dot-cdist. Upstream if possible.

Documentation

  • Register in service list
  • Add documentation pages:
    • End-user (if any)
    • Common operations (if any)
    • Infrastructure
  • Do not forget to links the pages together!

Monitoring

  • Plug into consul cluster.
  • Configure node exporter.
  • Export service-specific metrics, build Grafana dashboard if useful.
  • Define and subscribe to alerts regarding the service.

Security

  • All nodes should be firewalled.
  • Write a "what could go wrong" section in the infrastructure page of the service.

Please refer to the Infrastructure security guidelines and tools for details.

Backups

Any service that maintain user-data/a state must be maintain at least one off-site backup scheme. Stateless CDIST-managed services do not need backups.

Updated by Timothée Floure about 1 month ago · 2 revisions