How academysoftwarefoundation/opencue works
OpenCue is a render-farm management system. Artists and operators submit and manage jobs through client tools; Cuebot tracks jobs, layers, frames, and dependencies, then dispatches eligible work to render machines and records their reports. The README documents queue-based resource allocation, multi-facility deployment, tagging, and automated booking. The graph also includes the REST/web and monitoring capabilities visible in the repository tree. Some internal components are unsampled, so their relationships are shown only where the README or excerpts support them.
Main entry points: DispatchSupportService.java Dispatch and Booking · servant Cuebot API · JobManagerService.java Job Management · api.py Python API
Components 19
Clients and APIs
- Job Submission
cuesubmit/cuesubmit/ui/Widgets.py - Python API
pycue/opencue/api.py - Admin CLI
cueman/cueman/main.py - Desktop GUI
cuegui/cuegui/Main.py - REST Gateway
rest_gateway/opencue_gateway/main.go - Web UI
cueweb/app
Cuebot Control
- Cuebot API
cuebot/src/main/java/com/imageworks/spcue/servant - Job Management
cuebot/src/main/java/com/imageworks/spcue/service/JobManagerService.java - Dependency Management
cuebot/src/main/java/com/imageworks/spcue/service/DependManagerService.java - Dispatch and Booking
cuebot/src/main/java/com/imageworks/spcue/dispatcher/DispatchSupportService.java - Job and Frame Model
cuebot/src/main/java/com/imageworks/spcue
Render Execution
- Render Agent
rqd/rqd/rqdservicers.py - Rust Render Agent
rust/crates/rqd/src/frame/manager.rs - Render Machines
State and Monitoring
- Farm Database
- Persistence Access
cuebot/src/main/java/com/imageworks/spcue/dao - Metrics and Events
cuebot/src/main/java/com/imageworks/spcue/monitoring - Monitoring Stack
Other components
- Artists and Operators
Connections 26
- Artists and Operators → Job Submission: submit jobs
- Artists and Operators → Admin CLI: manage farm
- Artists and Operators → Desktop GUI: manage farm
- Artists and Operators → Web UI: view farm
- Job Submission → Python API: uses API
- Admin CLI → Python API: calls
cueman/cueman/main.py - Desktop GUI → Python API: uses API
- Web UI → REST Gateway: requests
- Python API → Cuebot API: sends requests
- REST Gateway → Cuebot API: routes requests
- Cuebot API → Job Management: routes management
- Job Management → Dependency Management: creates dependencies
cuebot/src/main/java/com/imageworks/spcue/service/JobManagerService.java - Job Management → Persistence Access: reads and writes
cuebot/src/main/java/com/imageworks/spcue/service/JobManagerService.java - Dependency Management → Persistence Access: reads and writes
cuebot/src/main/java/com/imageworks/spcue/service/DependManagerService.java - Dependency Management → Metrics and Events: publishes events
cuebot/src/main/java/com/imageworks/spcue/service/DependManagerService.java - Cuebot API → Dispatch and Booking: dispatches work
- Dispatch and Booking → Persistence Access: reads and updates
cuebot/src/main/java/com/imageworks/spcue/dispatcher/DispatchSupportService.java - Persistence Access → Farm Database: persists state
- Dispatch and Booking → Render Agent: launches frames
- Render Agent → Render Machines: runs frames
- Dispatch and Booking → Rust Render Agent: launches frames
- Render Agent → Dispatch and Booking: reports status
- Rust Render Agent → Dispatch and Booking: reports status
- Dispatch and Booking → Metrics and Events: records usage
cuebot/src/main/java/com/imageworks/spcue/dispatcher/DispatchSupportService.java - Metrics and Events → Monitoring Stack: exports telemetry
- Job and Frame Model → Job Management: models job state
cuebot/src/main/java/com/imageworks/spcue/service/JobManagerService.java