Synced from Hive. This page is pulled from kubestellar/hive@v4 during the docs build. Edit the canonical source in the Hive repository.

Architecture Decision Records

Hive uses lightweight Architecture Decision Records (ADRs) to capture decisions that shape the system’s security model, operating model, and long-lived APIs. ADRs are intentionally short: enough context to understand the choice, the chosen direction, and consequences for future changes.

Process

  1. Copy the template below to NNNN-short-title.md using the next number.
  2. Write in present tense for new decisions. For historical decisions, mark the status as Accepted (retroactive) and cite the existing docs or code.
  3. Keep each ADR focused on decision. If a later change supersedes it, add a new ADR and update the older status to Superseded by ADR-NNNN.
  4. Link ADRs from related documentation when they become operator-facing.

Template

# ADR-NNNN: Title
 
Status: Proposed | Accepted | Accepted (retroactive) | Superseded by ADR-NNNN
 
## Context
 
What problem, constraint, or trade-off forced a durable architecture decision?
 
## Decision
 
What did we decide?
 
## Consequences
 
What becomes easier, harder, safer, or riskier because of this decision?

Records