How lunarway/shuttle works
Main Components
a. Core Components:
• CLI Interface Layer
• Plan Management System
• Execution Engine
• Template Engine
• Telemetry System
b. External Components:
• Git Repositories (Plan Sources)
• Project Directories
• Docker Runtime
• Go Runtime
┌─────────────────────────────────────────────────────────┐
• CLI Interface │
• ┤
• Core Services │
• ┬───────────────┬────────────┬───────────┤
• Plan Manager │ Executor │ Template │ Telemetry │
• Framework │ Engine │ System │
• ┴───────────────┴────────────┴───────────┤
• Executors │
• ┬───────────────┬────────────────────────┤
• Shell │ Docker │ Golang │
• Executor │ Executor │ Executor │
• ┴───────────────┴────────────────────────┘
Component Details
a. CLI Interface:
• Command handlers (run, plan, get, has, etc.)
• Configuration parsing
• User interaction components
b. Plan Manager:
• Plan loading and caching
• Git integration
• Plan validation
• Variable management
c. Executor Framework:
• Task execution pipeline
• Script handling
• Action coordination
d. Template Engine:
• Template processing
• Function registry
• Variable substitution
e. Telemetry System:
• Logging
• Metrics collection
• Upload mechanism
External Interactions
Connections to:
• Git repositories (for plan fetching)
• Local filesystem (for project files)
• Docker daemon (for container operations)
• Go runtime (for action execution)
Important Implementation Details
Highlight:
• Plan inheritance and overriding
• Script execution paths
• Template processing pipeline
• Golang action compilation and execution
• Telemetry data flow
Notes
Annotations for:
• Caching mechanisms
• Security boundaries
• Configuration points
• Extension points
• The modular executor system
• Plan management flexibility
• Template processing capabilities
• Integration with external tools
Keep the abstraction level focused on the architectural components while showing enough detail to understand the system's operation and extension points.
This design captures Shuttle's core functionality as a build and deploy tool orchestrator while showing its flexibility in handling different project types and execution environments.