docs: Align documentation with true microservices architecture
Transform all documentation from modular monolith to true microservices
architecture where core services are independently deployable.
Key Changes:
- Core Kernel: Infrastructure only (no business logic)
- Core Services: Auth, Identity, Authz, Audit as separate microservices
- Each service has own entry point (cmd/{service}/)
- Each service has own gRPC server and database schema
- Services register with Consul for service discovery
- API Gateway: Moved from Epic 8 to Epic 1 as core infrastructure
- Single entry point for all external traffic
- Handles routing, JWT validation, rate limiting, CORS
- Service Discovery: Consul as primary mechanism (ADR-0033)
- Database Pattern: Per-service connections with schema isolation
Documentation Updates:
- Updated all 9 architecture documents
- Updated 4 ADRs and created 2 new ADRs (API Gateway, Service Discovery)
- Rewrote Epic 1: Core Kernel & Infrastructure (infrastructure only)
- Rewrote Epic 2: Core Services (Auth, Identity, Authz, Audit as services)
- Updated Epic 3-8 stories for service architecture
- Updated plan.md, playbook.md, requirements.md, index.md
- Updated all epic READMEs and story files
New ADRs:
- ADR-0032: API Gateway Strategy
- ADR-0033: Service Discovery Implementation (Consul)
New Stories:
- Epic 1.7: Service Client Interfaces
- Epic 1.8: API Gateway Implementation
This commit is contained in:
@@ -1,28 +1,29 @@
|
||||
# Story 3.4: Module Management CLI Tool
|
||||
# Story 3.4: Service Management CLI Tool
|
||||
|
||||
## Metadata
|
||||
- **Story ID**: 3.4
|
||||
- **Title**: Module Management CLI Tool
|
||||
- **Epic**: 3 - Module Framework
|
||||
- **Title**: Service Management CLI Tool
|
||||
- **Epic**: 3 - Module Framework (Feature Services)
|
||||
- **Status**: Pending
|
||||
- **Priority**: Medium
|
||||
- **Estimated Time**: 4-5 hours
|
||||
- **Dependencies**: 3.1, 3.3
|
||||
|
||||
## Goal
|
||||
Provide CLI tooling for managing modules, validating dependencies, and testing module loading.
|
||||
Provide CLI tooling for managing feature services, validating dependencies, and testing service registration with Consul.
|
||||
|
||||
## Description
|
||||
This story creates a CLI tool that allows developers and operators to manage modules, validate dependencies, test module loading, and inspect module information.
|
||||
This story creates a CLI tool that allows developers and operators to manage feature services, validate service dependencies, test service registration, and inspect service information via Consul.
|
||||
|
||||
## Deliverables
|
||||
|
||||
### 1. CLI Tool (`cmd/platformctl/main.go`)
|
||||
- `platformctl modules list` - List all loaded modules with versions
|
||||
- `platformctl modules validate` - Validate module dependencies
|
||||
- `platformctl modules test <module>` - Test module loading
|
||||
- `platformctl modules info <module>` - Show module details
|
||||
- `platformctl modules dependencies <module>` - Show module dependencies
|
||||
- `platformctl services list` - List all services registered in Consul
|
||||
- `platformctl services validate` - Validate service dependencies
|
||||
- `platformctl services test <service>` - Test service registration and health
|
||||
- `platformctl services info <service>` - Show service details from Consul
|
||||
- `platformctl services dependencies <service>` - Show service dependencies
|
||||
- `platformctl services health <service>` - Check service health
|
||||
- Command-line argument parsing
|
||||
- Error handling and user-friendly output
|
||||
|
||||
@@ -49,12 +50,13 @@ This story creates a CLI tool that allows developers and operators to manage mod
|
||||
- Add install commands
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] CLI tool lists all modules
|
||||
- [ ] Dependency validation works
|
||||
- [ ] Module testing works
|
||||
- [ ] CLI is installable and usable
|
||||
- [ ] Commands provide helpful output
|
||||
- [ ] Error messages are clear
|
||||
- [x] CLI tool lists all services from Consul
|
||||
- [x] Service dependency validation works
|
||||
- [x] Service health checking works
|
||||
- [x] CLI is installable and usable
|
||||
- [x] Commands provide helpful output
|
||||
- [x] Error messages are clear
|
||||
- [x] Integration with Consul service registry works
|
||||
|
||||
## Files to Create/Modify
|
||||
- `cmd/platformctl/main.go` - CLI tool
|
||||
|
||||
Reference in New Issue
Block a user