Expand description
Common types used across RCH components.
Structs§
- Affinity
Config - Cache affinity settings for project-to-worker pinning.
- Alerts
Config - Worker health alerting configuration.
- ApiConfig
- Daemon status API over TCP (
[api]). - Build
Cancellation Metadata - Structured cancellation metadata attached to cancelled build records.
- Build
Cancellation Worker Health - Worker health snapshot captured when a cancellation completes.
- Build
Heartbeat Request - Request to update liveness/progress for an active build.
- Build
Record - Record of a completed build.
- Build
Record Input - Input payload for recording a completed build.
- Build
Stats - Aggregate terminal-command statistics for build history.
- Circuit
Breaker Config - Circuit breaker configuration.
- Circuit
Stats - Circuit breaker statistics for tracking state transitions.
- Command
Timing Breakdown - Timing breakdown for a single command pipeline.
- Compilation
Config - Compilation
Metrics - Comprehensive metrics for a single compilation.
- Compilation
Timer - Timer for tracking compilation phases.
- Compilation
Timing Breakdown - Breakdown of timing for each compilation phase.
- Dashboard
Config - Where the fleet dashboard is served (
[dashboard]). - Doctor
Config - Doctor reliability subsystem configuration.
- Doctor
Webhook Endpoint - A single webhook destination for verdict transitions.
- Doctor
Webhooks Config - Webhook notification surface for reliability verdict transitions.
- Environment
Config - Environment variable passthrough configuration.
- Execution
Config - Execution allowlist configuration for remote builds (bd-785w).
- Fairness
Config - Fairness settings for the fair_fastest selection strategy.
- Fleet
Config - Fleet operation configuration.
- General
Config - Jobs
Config - Job-mode configuration (
[jobs]). - Layer0
Config - Layer 0 configuration pack knobs (bd-bqu38).
- Metrics
Aggregator - Aggregator for compilation metrics with statistics.
- Output
Config - Hook output configuration.
- Path
Topology Config - Path topology configuration.
- RchConfig
- RCH configuration.
- Release
Request - Request to release reserved worker slots.
- Retry
Config - Configuration for retry behavior on transient errors.
- Saved
Time Stats - Saved time statistics from remote builds.
- Selected
Worker - Details about a selected worker for remote compilation.
- Selection
Config - Configuration for the worker selection algorithm.
- Selection
Diagnostics - Machine-readable worker selector diagnostics for a selection request.
- Selection
Request - Worker selection request sent from hook to daemon.
- Selection
Response - Worker selection response from daemon to hook.
- Selection
Weight Config - Weight configuration for the balanced selection strategy.
- Self
Healing Config - Self-healing behaviors for the hook and daemon.
- Self
Test Config - Self-test scheduling and behavior configuration.
- Transfer
Config - Webhook
Config - Webhook configuration for alert dispatch.
- Worker
Capabilities - Runtime capabilities detected on a worker.
- Worker
Config - Configuration for a remote worker.
- Worker
Id - Unique identifier for a worker in the fleet.
- Worker
Selection Diagnostic - Per-worker selector facts captured at worker-selection time.
- Worker
Tool Probe - One operator-declared tool probe as it appears in
workers.toml.
Enums§
- BoxRole
- Box-level role (bd-wywsj): what this MACHINE is for, so “never build locally” is configuration rather than a per-call env var.
- Build
Heartbeat Phase - Build execution phase for daemon heartbeat tracking.
- Build
Location - Location where a build was executed.
- Circuit
State - Circuit breaker state for a worker.
- Color
Mode - Color mode for remote command output.
- Command
Priority - Per-command priority hint for worker selection.
- Doctor
Webhook Format - Built-in webhook payload formats.
- Output
Visibility - Visibility level for hook output.
- Remote
Build Jobs - How rch derives the
CARGO_BUILD_JOBSit injects into a remote build. - Required
Runtime - Required runtime for command execution.
- Selection
Reason - Reason for worker selection result.
- Selection
Strategy - Worker selection strategy determining how workers are chosen for jobs.
- Self
Healing LogLevel - Log level for self-healing diagnostic output.
- Self
Test Failure Action - Action to take when a scheduled self-test fails.
- Self
Test Workers - Which workers to include in self-test runs.
- Worker
Selection Diagnostic Decision - Final selector decision for a worker considered during routing.
- Worker
Status - Status of a worker in the fleet.
Constants§
- BUILTIN_
EXECUTION_ BASES - Default allowlist of commands that can be executed remotely. Aligned with the classifier’s supported CompilationKind values. Command bases of every compilation kind rch knows how to offload.
- LAYE
R0_ PACK_ VERSION - Version of the Layer 0 configuration pack schema (bd-bqu38 / M-1 §149).
- OS_
TAG_ PREFIX - Tag prefix reserved for the operator-declared host OS.
- SELECTION_
RESPONSE_ PROTOCOL_ VERSION - Wire protocol version for daemon
/select-workerresponses.
Functions§
- declared_
os - The host OS an operator declared for a worker, from its tags.
- default_
remote_ base - Default remote base path for project transfers.
- default_
socket_ path - os_tag
- Build the reserved tag for a declared OS.
- validate_
remote_ base - Validate and normalize a remote base path. Returns an error if the path is not absolute or contains traversal sequences.
- x86_
64_ microarch_ level_ from_ flags - Classify an x86-64 microarchitecture level (1..=4) from a
/proc/cpuinfoflagsline (bd-6qchz).