Architecture Decision Records
Architecture Decision Records (ADRs) document significant architectural choices made during OctoLLM development.
ADR Index
-
- Python vs Rust for services
- LLM provider selection
- Database and caching choices
-
ADR-002: Communication Patterns
- REST vs gRPC
- Message bus selection
- Inter-service communication
-
- Global semantic memory design
- Local episodic memory
- Vector store selection
-
- Capability-based isolation
- Secrets management
- Authentication/authorization
-
- Kubernetes vs Docker Swarm
- Cloud vs on-premise
- Scaling strategy
-
ADR-006: Cloud Provider Selection
- AWS vs GCP vs Azure
- Cost considerations
- Service availability
-
ADR-007: Unraid Local Deployment
- Local development setup
- Container orchestration
- Resource management
ADR Template
When creating new ADRs, use the following template:
# ADR-XXX: Title
**Status**: Proposed | Accepted | Deprecated | Superseded
**Date**: YYYY-MM-DD
**Deciders**: Names
**Consulted**: Names
## Context
What is the issue we're facing?
## Decision
What did we decide?
## Consequences
What are the trade-offs?
### Positive
- Benefit 1
- Benefit 2
### Negative
- Drawback 1
- Drawback 2
## Alternatives Considered
1. Alternative 1
- Pros
- Cons
- Why rejected
2. Alternative 2
- Pros
- Cons
- Why rejected