Home
Unified API for orchestrating and provisioning compute capacity
Welcome to the Open Resource Broker documentation. ORB lets you define what compute capacity you need in a template, request it, track it, and return it — through a CLI, REST API, Python SDK, or MCP server.
Getting Started¶
- Quick Start Guide — get up and running in minutes
- Installation Guide — detailed installation instructions
- Configuration Guide — system configuration options
Architecture & Design¶
- System Overview — high-level architecture overview
- Clean Architecture — architectural principles and patterns
- System Diagrams — visual architecture representations
Developer Resources¶
- Developer Guide — development-focused guidance
- SDK Quickstart — programmatic access via Python SDK
- SDK API Reference — parameter mapping across all interfaces
- API Reference — REST API documentation
- Testing Guide — testing strategies and examples
Examples¶
- SDK Usage — full SDK lifecycle: templates, requests, batch, middleware, discovery
- Provider Strategy — custom providers, load balancing, fallback, composition
- Config: Single Provider — minimal single-provider config
- Config: Multi Provider — multi-provider setup
- Config: Production — production-ready config
Deployment & Operations¶
- Deployment Guide — complete deployment documentation
- HostFactory Integration — IBM Spectrum Symphony integration
- Operational Tools — monitoring and maintenance tools
Features¶
- AWS Provider — EC2 Instances, Auto Scaling Groups, Spot Fleet, EC2 Fleet
- CLI — primary interface for all operations
- REST API — HTTP endpoints for service integration
- Python SDK — async-first programmatic access
- MCP Server — AI assistant integration
- Clean Architecture — Domain-Driven Design with CQRS patterns
- Extensible — Strategy/Registry pattern for adding providers and schedulers
License¶
This project is licensed under the Apache License 2.0 — see the LICENSE file for details.