Architecture
Platform Architecture
This document provides an overview of how the autom8y platform is structured and how its components interact.
High-Level Overview
flowchart LR
subgraph Autom8yPlatform["autom8y Platform"]
autom8["autom8 (workflows)"]
autom8_db["autom8_db (analytics)"]
charter["charter (secrets)"]
autom8_core["autom8-core (primitives)"]
autom8_asana["autom8_asana (integrations)"]
autom8 <--> autom8_db
autom8_db <--> charter
autom8 --> autom8_core
autom8 --> autom8_asana
end
Service Descriptions
autom8 (Core Monolith)
The primary orchestration service. It:
- Defines and executes workflows
- Manages integrations with external systems
- Provides the CLI interface
- Coordinates with other services
autom8-core
Shared Python primitives used across the ecosystem:
- Common data structures
- Utility functions
- Base classes for integrations
- Shared type definitions
This package is a dependency of other services and rarely used directly.
autom8_db
Analytics engine implementing CQRS patterns:
- Read-optimized queries for reporting
- Event sourcing for audit trails
- Data aggregation pipelines
- Query builders for common patterns
autom8_asana
Integration SDK for Asana:
- Type-safe API client
- Common task patterns
- Project templates
- Webhook handling
charter
Secrets management CLI:
- Bridges AWS Secrets Manager with shell environments
- Secure credential injection
- Environment variable management
- Zero-trust secret handling
Communication Patterns
Service Dependencies
flowchart TB autom8["autom8"] -->|"required"| autom8_core["autom8-core"] autom8 -.->|"optional"| charter["charter"] autom8 -.->|"optional"| autom8_db["autom8_db"] autom8 -.->|"optional"| autom8_asana["autom8_asana"]
Data Flow
-
Workflow Execution
- CLI invokes autom8
- autom8 loads workflow definition
- Secrets retrieved via charter (if needed)
- Steps execute sequentially or in parallel
- Results logged and optionally stored in autom8_db
-
Analytics Queries
- Application requests data
- autom8_db routes to appropriate read model
- Results returned with consistent schema
Infrastructure
Deployment Options
The platform supports multiple deployment models:
| Model | Use Case |
|---|---|
| Local | Development and testing |
| Container | Production deployment |
| Serverless | Event-driven workflows |
Cloud Resources
When deployed to AWS, the platform uses:
- Secrets Manager: Credential storage (via charter)
- CloudWatch: Logging and metrics
- S3: Artifact storage
- Lambda: Serverless workflow triggers
Next Steps
- Review API Standards for building integrations
- Understand Domain Routing for the web infrastructure
- Explore individual service repositories on GitHub