Skip to content

Commit 84a93a7

Browse files
authored
Merge pull request #263 from deploystackio/feat/background-jobs-satellite
Feat/background jobs satellite
2 parents 85e3286 + 11d88ed commit 84a93a7

File tree

11 files changed

+2421
-54
lines changed

11 files changed

+2421
-54
lines changed

docs/development/backend/events.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ description: Type-safe event system for decoupled communication between core sys
77

88
The Global Event Bus enables decoupled communication between core systems and plugins through a type-safe event system. Core systems emit events when important actions occur, and plugins can react without direct coupling to business logic.
99

10+
**Note**: This documentation covers the **internal backend event bus** for plugin communication. If you're looking for the **satellite events system** (incoming events from satellites), see [Satellite Events](/development/backend/satellite-events).
11+
1012
## Overview
1113

1214
Key features:

docs/development/backend/index.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,14 @@ The development server starts at `http://localhost:3000` with API documentation
112112
>
113113
Database-backed job processing system with persistent storage, automatic retries, and rate limiting for long-running background tasks.
114114
</Card>
115+
116+
<Card
117+
icon={<Terminal />}
118+
href="/deploystack/development/backend/satellite-events"
119+
title="Satellite Events"
120+
>
121+
Real-time event processing from satellites with convention-based handlers routing to business tables for operational visibility.
122+
</Card>
115123
</Cards>
116124

117125
## Project Structure

docs/development/backend/satellite-communication.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,26 @@ Satellites use **outbound-only HTTPS polling** to communicate with the backend,
7171
└─────────────────┘ Command Response └─────────────────┘
7272
```
7373

74+
### Communication Channels
75+
76+
The system uses three distinct communication patterns:
77+
78+
**Command Polling (Backend → Satellite)**:
79+
- Backend creates commands, satellites poll and execute
80+
- Adaptive intervals: 2-60 seconds based on priority
81+
- Used for: MCP server configuration, process management
82+
83+
**Heartbeat (Satellite → Backend, Periodic)**:
84+
- Satellites report status every 30 seconds
85+
- Contains: System metrics, process counts, resource usage
86+
- Used for: Health monitoring, capacity planning
87+
88+
**Events (Satellite → Backend, Immediate)**:
89+
- Satellites emit events when actions occur, batched every 3 seconds
90+
- Contains: Point-in-time occurrences with precise timestamps
91+
- Used for: Real-time UI updates, audit trails, user notifications
92+
- See [Satellite Events](/development/backend/satellite-events) for detailed implementation
93+
7494
### Dual Deployment Models
7595

7696
**Global Satellites**: Cloud-hosted by DeployStack team
@@ -474,6 +494,7 @@ For detailed API endpoints, request/response formats, and authentication pattern
474494

475495
For detailed satellite architecture and implementation:
476496

497+
- [Satellite Events](/development/backend/satellite-events) - Real-time event processing system
477498
- [API Security](/development/backend/api-security) - Security patterns and authorization
478499
- [Database Management](/development/backend/database) - Schema and data management
479500
- [OAuth2 Server](/development/backend/oauth2-server) - OAuth2 implementation details

0 commit comments

Comments
 (0)