Early-stage, for-fun project. Expect things to be incomplete and to change.
betriebshandbuch-docs

Architecture ​

Roles ​

  • Developers describe how the application works: its architecture, use cases, data, and management operations.
  • Managers adds business context: business criticality, service levels, and contacts.
  • Operators run the application and feed back what they learn.

Operating Manual ​

The operating manual is the single source of truth and consists of several Kubernetes Resources releases within the applications Helm Chart. It captures everything an operator needs to run the application: its architecture, use cases, data, service levels, management operations, alerts, contacts, and more.

Kubernetes Resources ​

Alongside the model live the application's real Kubernetes resources: the Deployments, the VMServiceScrapes, the Grafana dashboards, the Alertmanager routes, and so on. These are what actually run and monitor the application. bhb does not replace them but links those resources to the model.

Using the Model ​

Operators exploit the operating manual to run applications:

  • Discover what is deployed through the status and the tracked Kubernetes resources.
  • Understand the system with the top-down view of the architecture and the left-to-right view of the use cases.
  • Handle incidents with the failure catalog, dashboards, alerts, and escalation chains.

However, the manual is also exectuable. For example, alerts can trigger management operations.