Architecture
Understanding Sail's architecture and design principles.
Overview
Sail consists of three main components working together:
┌─────────────────┐
│ Web UI │ React Admin Interface
│ (React 18) │
└────────┬────────┘
│ REST API
↓
┌─────────────────┐
│ Sail API │ Management & gRPC
│ (ASP.NET Core) │
└────────┬────────┘
│
↓
┌─────────────────┐ Change ┌─────────────────┐
│ MongoDB │◄──Streams─────│ Sail Compass │
└─────────────────┘ └────────┬────────┘
│ gRPC
↓
┌─────────────────┐
│ Sail Proxy │
│ (YARP Gateway) │
└─────────────────┘Components
Sail Management API
Control plane providing REST API and gRPC services for configuration management.
- • Routes and cluster configuration
- • Certificate management
- • Policy configuration (CORS, rate limiting, auth)
MongoDB Storage
Persistent storage with Change Streams for real-time updates.
- • Stores all configuration
- • Emits change events
- • Enables instant synchronization
Sail Compass
Configuration watcher embedded in Sail.Proxy.
- • Watches MongoDB Change Streams
- • Updates YARP configuration in real-time
- • Manages dynamic policies
Sail Proxy
Data plane handling actual client requests.
- • Built on YARP reverse proxy
- • TLS termination and routing
- • Authentication, rate limiting, CORS
Web UI
React-based admin interface.
- • Visual configuration management
- • Real-time status monitoring
- • Policy editors
Design Principles
Zero-Downtime Configuration
All changes take effect immediately via MongoDB Change Streams without restarting the gateway.
Separation of Concerns
Control plane (management) and data plane (proxy) are completely separate, enabling independent scaling.
Cloud-Native Ready
Stateless proxy instances can scale horizontally, sharing configuration via MongoDB.