23 lines
966 B
Markdown
23 lines
966 B
Markdown
|
|
# YakPanel Control Plane API (Laravel)
|
||
|
|
|
||
|
|
This folder defines the 2026 Laravel control plane boundary.
|
||
|
|
|
||
|
|
## Purpose
|
||
|
|
- API gateway for UI and third-party integrations.
|
||
|
|
- Tenant/RBAC enforcement before any execution request.
|
||
|
|
- Workflow orchestration and audit trail for system operations.
|
||
|
|
|
||
|
|
## Initial modules
|
||
|
|
- `app/Modules/Server`: inventory and server lifecycle metadata.
|
||
|
|
- `app/Modules/Agents`: enrollment tokens, agent sessions, heartbeat updates.
|
||
|
|
- `app/Modules/Jobs`: command orchestration and execution state tracking.
|
||
|
|
- `app/Modules/Auth`: login/refresh/me/logout boundaries.
|
||
|
|
- `app/Modules/Tenant`: tenant lifecycle and membership boundaries.
|
||
|
|
- `app/Modules/Rbac`: role/permission/scope checks.
|
||
|
|
- `routes/api_v1`: versioned route groups.
|
||
|
|
|
||
|
|
## Integration contract
|
||
|
|
- Never execute privileged shell operations directly in Laravel.
|
||
|
|
- Dispatch immutable command envelopes to Go execution plane.
|
||
|
|
- Persist all requests as jobs for visibility and replay-safe recovery.
|