Skip to content

Commit d972a17

Browse files
docs: explain Schedune purpose and current state (#32)
Signed-off-by: InderdeepBajwa <InderdeepBajwa@users.noreply.github.com>
1 parent ad4ab0a commit d972a17

2 files changed

Lines changed: 43 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
**Schedune is an alpha-stage control plane and node agent for explainable scheduling, launch validation, managed runtime lifecycle, restart recovery, and orphan visibility across heterogeneous ARM and x86 infrastructure.**
44

5+
**Main Purpose:** Schedune tells infrastructure teams which machine can safely run a workload, proves why, validates runtime readiness before launch, then tracks what happened afterward.
6+
7+
**Who it is for:** Platform and infrastructure teams operating or evaluating mixed ARM, x86, private-cloud, and edge fleets. It is not designed for solo app developers deploying a single application.
8+
9+
**Example Scenario:** Your fleet consists of ARM nodes, x86 nodes, and edge boxes. A workload intent requests VM isolation, CPU, RAM, and architecture constraints. Schedune rejects incompatible nodes (e.g., due to missing KVM, stale telemetry, insufficient memory, or policy mismatch), validates the runtime path before launch, and tracks PID, readiness, events, and recovery state afterward.
10+
511
**Status:** v0.1.0-alpha / Experimental (Single-node technical preview)
612
**Community:** [Join the Schedune Discord](https://discord.gg/mdr8tyCQvc)
713
**Control Plane:** Go
@@ -16,6 +22,21 @@ Unlike generic orchestrators or traditional hypervisors, Schedune is built speci
1622

1723
![Schedune Architecture Diagram](docs/assets/how-schedune-works.png)
1824

25+
## Where Schedune is today (Alpha)
26+
27+
Currently, the lower-half control plane is working. This includes:
28+
- Typed node truth, intake, and projection
29+
- Eligibility explainability (proving why a node was rejected)
30+
- Launch validation and dry-runs
31+
- Initial runtime execution paths (KVM/QEMU, Cloud Hypervisor)
32+
- State, trace, and events tracking
33+
- Restart recovery and orphan process visibility
34+
- Fixture demos for testing on non-Linux hosts
35+
36+
**ARM Compatibility Note:** Today, the workload architecture and intent is supplied by the user or examples. Future value will come from image/container/import evidence, but this is not yet implemented.
37+
38+
Schedune **is not yet** capable of full workload compatibility discovery/import, live migration, High Availability (HA), full storage/networking, or guest-internal app health.
39+
1940
## What Schedune does today
2041

2142
- **Node capability ingestion:** Agent inspects and emits versioned node truth.

docs/index.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,34 @@
22

33
Schedune is a production-grade, explainable control plane (Go) and node agent (Rust) for scheduling and managing VMs and MicroVMs across heterogeneous ARM and x86 infrastructure.
44

5+
**Main Purpose:** Schedune tells infrastructure teams which machine can safely run a workload, proves why, validates runtime readiness before launch, then tracks what happened afterward.
6+
7+
**Who it is for:** Platform and infrastructure teams operating or evaluating mixed ARM, x86, private-cloud, and edge fleets. It is not designed for solo app developers deploying a single application.
8+
9+
**Example Scenario:** Your fleet consists of ARM nodes, x86 nodes, and edge boxes. A workload intent requests VM isolation, CPU, RAM, and architecture constraints. Schedune rejects incompatible nodes (e.g., due to missing KVM, stale telemetry, insufficient memory, or policy mismatch), validates the runtime path before launch, and tracks PID, readiness, events, and recovery state afterward.
10+
511
**Status:** v0.1.0-alpha
612

13+
## Where Schedune is today
14+
15+
Schedune is currently in Alpha. The lower-half control plane is working, which includes:
16+
- Typed node truth, intake, and projection
17+
- Eligibility explainability
18+
- Launch validation and dry-run
19+
- Initial runtime execution paths
20+
- State, trace, and event tracking
21+
- Recovery and orphan visibility
22+
- Fixture demos
23+
24+
**ARM Compatibility Note:** Today, the workload architecture and intent is supplied by the user or examples. Future value will come from image/container/import evidence, but this is not yet implemented.
25+
26+
Schedune **is not yet** capable of full workload compatibility discovery/import, live migration, High Availability (HA), full storage/networking, or guest-internal app health.
27+
728
## Features
829

930
- **Strict separation of concerns:** Agent emits immutable truth; Control plane evaluates eligibility, schedules, and validates launch before execution.
1031
- **Explainability first:** Uses structured, typed reason codes instead of opaque strings.
1132
- **Lifecycle management:** Rigorous state machine with append-only traces, robust restart recovery (rehydration), and real `/proc`-backed orphan sweeping.
1233
- **Supported Runtimes:** KVM/QEMU (Execution), Cloud Hypervisor (Execution), Firecracker (Validation/Dry-run only).
1334

14-
*Note: Schedune is currently in Alpha. Expect rapid changes as the product shape stabilizes.*
35+
*Note: Expect rapid changes as the product shape stabilizes.*

0 commit comments

Comments
 (0)