68 lines
1.8 KiB
Markdown
68 lines
1.8 KiB
Markdown
# Horus Documentation
|
|
|
|
**Hierarchical Orchestration Runtime for Universal Scripts**
|
|
|
|
Horus is a distributed job execution system with three layers: Coordinator, Supervisor, and Runner.
|
|
|
|
## Quick Links
|
|
|
|
- **[Getting Started](./getting-started.md)** - Install and run your first job
|
|
- **[Architecture](./architecture.md)** - System design and components
|
|
- **[Etymology](./ethymology.md)** - The meaning behind the name
|
|
|
|
## Components
|
|
|
|
### Coordinator
|
|
Workflow orchestration engine for DAG-based execution.
|
|
|
|
- [Overview](./coordinator/coordinator.md)
|
|
|
|
### Supervisor
|
|
Job dispatcher with authentication and routing.
|
|
|
|
- [Overview](./supervisor/supervisor.md)
|
|
- [Authentication](./supervisor/auth.md)
|
|
- [OpenRPC API](./supervisor/openrpc.json)
|
|
|
|
### Runners
|
|
Job executors for different workload types.
|
|
|
|
- [Runner Overview](./runner/runners.md)
|
|
- [Hero Runner](./runner/hero.md) - Heroscript execution
|
|
- [SAL Runner](./runner/sal.md) - System operations
|
|
- [Osiris Runner](./runner/osiris.md) - Database operations
|
|
|
|
## Core Concepts
|
|
|
|
### Jobs
|
|
Units of work executed by runners. Each job contains:
|
|
- Target runner ID
|
|
- Payload (script/command)
|
|
- Cryptographic signature
|
|
- Optional timeout and environment variables
|
|
|
|
### Workflows
|
|
Multi-step DAGs executed by the Coordinator. Steps can:
|
|
- Run in parallel or sequence
|
|
- Pass data between steps
|
|
- Target different runners
|
|
- Handle errors and retries
|
|
|
|
### Signatures
|
|
All jobs must be cryptographically signed:
|
|
- Ensures job authenticity
|
|
- Prevents tampering
|
|
- Enables authorization
|
|
|
|
## Use Cases
|
|
|
|
- **Automation**: Execute system tasks and scripts
|
|
- **Data Pipelines**: Multi-step ETL workflows
|
|
- **CI/CD**: Build, test, and deployment pipelines
|
|
- **Infrastructure**: Manage cloud resources and containers
|
|
- **Integration**: Connect systems via scripted workflows
|
|
|
|
## Repository
|
|
|
|
[git.ourworld.tf/herocode/horus](https://git.ourworld.tf/herocode/horus)
|