Architecture Decision Records

Architecture Decision Records (ADRs or simply decision records) are a collection of records for "architecturally significant" decisions. A decision record is a short markdown file in a specific light-weight format.

This folder contains all the decisions we have recorded in Dapr, including Dapr runtime, Dapr CLI as well as Dapr SDKs in different languages.

Dapr decision record organization and index

All decisions are categorized in the following folders:

• Architecture - Decisions on general architecture, code structure, coding conventions and common practices.

  • ARC-001: Refactor for modularity and testability
  • ARC-002: Multitenancy
  • ARC-003: gRPC and Protobuf message coding convention
  • ARC-004: HTTP API server

• API - Decisions on Dapr runtime API designs.

  • API-001: State store API design
  • API-002: Actor API design
  • API-003: Messaging API names
  • API-004: Binding Manifests
  • API-005: State store behavior
  • API-006: Universal namespace (customer ask)
  • API-007: Tracing Endpoint
  • API-008: Multi State store API design
  • API-009: Bi-Directional Bindings
  • API-010: Appcallback Versioning for HTTP
  • API-011: State Store APIs Parity
  • API-012: Content Type

• CLI - Decisions on Dapr CLI architecture and behaviors.

  • CLI-001: CLI and runtime versioning
  • CLI-002: Self-hosted init and uninstall behaviors

• SDKs - Decisions on Dapr SDKs.

  • SDK-001: SDK releases
  • SDK-002: Java JDK versions

• Engineering - Decisions on Engineering practices, including CI/CD, testing and releases.

  • ENG-001: Image Tagging
  • ENG-002: Dapr Release
  • ENG-003: Test Infrastructure
  • ENG-004: Signing

Creating new decision records

A new decision record should be a .md file named as

<category prefix>-<sequence number in category>-<descriptive title>.md

A decision record should contain the following fields:

• Status - can be "proposed", "accepted", "implemented", or "rejected".
• Context - the context of the design discussion.
• Decision - Description of the decision.
• Consequences - what impacts this decision may create.
• Implementation - when a decision is implemented, the corresponding doc should be updated with the following information (when applicable):
  • Release version
  • Associated test cases