API reference

Python

• brokkr: Ergonomic Python wrapper around brokkr-broker-client.
• brokkr.client: High-level Brokkr client wrapping the generated low-level client.
• brokkr.errors: Typed error wrapper for the Brokkr SDK.

Rust

• brokkr-agent
• brokkr-agent::broker: Broker communication module for agent-broker interaction.
• brokkr-agent::broker_sdk: Adapter that constructs the brokkr-client ergonomic wrapper from the agent’s Settings.
• brokkr-agent::broker_ws: Agent side of the internal broker↔agent WebSocket channel.
• brokkr-agent::cli
• brokkr-agent::cli::commands
• brokkr-agent::deployment_health: Deployment Health Checker Module
• brokkr-agent::diagnostics: Diagnostics handler for on-demand diagnostic collection.
• brokkr-agent::health
• brokkr-agent::k8s::api
• brokkr-agent::k8s::objects
• brokkr-agent::kube_events: Tail Kubernetes Event objects for resources this agent manages and forward them to the broker as WsMessage::K8sEvent frames.
• brokkr-agent::metrics
• brokkr-agent::pod_logs: Stream container logs for Brokkr-managed pods to the broker as WsMessage::PodLogLine frames.
• brokkr-agent::utils
• brokkr-agent::webhooks: Webhook delivery module for agent-side webhook processing.
• brokkr-agent::work_orders
• brokkr-agent::work_orders::broker: Broker communication for work order operations.
• brokkr-agent::work_orders::build: Build handler for Shipwright Build integration.
• brokkr-broker
• brokkr-broker::api
• brokkr-broker::api::assets: Static web-UI serving + SPA fallback for the operator console (BROKKR-I-0031, BROKKR-T-0253; mirrors Skadi’s skadi-api).
• brokkr-broker::api::v1: API v1 module for the Brokkr broker.
• brokkr-broker::api::v1::admin: Admin API endpoints for the Brokkr broker.
• brokkr-broker::api::v1::agent_events: Handles API routes and logic for agent events.
• brokkr-broker::api::v1::agents: Agent management API endpoints.
• brokkr-broker::api::v1::auth: Authentication module for the Brokkr API v1.
• brokkr-broker::api::v1::deployment_objects: Deployment Objects API module for Brokkr.
• brokkr-broker::api::v1::diagnostics: Diagnostics API endpoints.
• brokkr-broker::api::v1::error: Canonical error model for the v1 API.
• brokkr-broker::api::v1::fleet: Fleet legibility API endpoints (BROKKR-I-0027).
• brokkr-broker::api::v1::generators: Generators API module for Brokkr.
• brokkr-broker::api::v1::health: Deployment health API endpoints.
• brokkr-broker::api::v1::middleware: Authentication middleware for the Brokkr API v1.
• brokkr-broker::api::v1::openapi
• brokkr-broker::api::v1::paks: Tenant listing for the operator console’s scope selector (BROKKR-T-0269).
• brokkr-broker::api::v1::stacks
• brokkr-broker::api::v1::templates: API endpoints for stack template management.
• brokkr-broker::api::v1::webhooks: Webhooks API module for Brokkr.
• brokkr-broker::api::v1::work_orders: Handles API routes and logic for work orders.
• brokkr-broker::bin: Brokkr Broker CLI application
• brokkr-broker::cli
• brokkr-broker::cli::commands
• brokkr-broker::dal
• brokkr-broker::dal::agent_annotations: Data Access Layer for Agent Annotation operations.
• brokkr-broker::dal::agent_events: Data Access Layer for AgentEvent operations.
• brokkr-broker::dal::agent_generator_registrations
• brokkr-broker::dal::agent_k8s_events: DAL for the short-lived agent_k8s_events telemetry table.
• brokkr-broker::dal::agent_labels: Data Access Layer for AgentLabel operations.
• brokkr-broker::dal::agent_pod_logs: DAL for the short-lived agent_pod_logs telemetry table.
• brokkr-broker::dal::agent_targets: Data Access Layer for AgentTarget operations.
• brokkr-broker::dal::agents
• brokkr-broker::dal::audit_logs: Data Access Layer for AuditLog operations.
• brokkr-broker::dal::deployment_health: Data Access Layer for DeploymentHealth operations.
• brokkr-broker::dal::deployment_objects: Data Access Layer for DeploymentObject operations.
• brokkr-broker::dal::diagnostic_requests: Data Access Layer for DiagnosticRequest operations.
• brokkr-broker::dal::diagnostic_results: Data Access Layer for DiagnosticResult operations.
• brokkr-broker::dal::generators
• brokkr-broker::dal::rendered_deployment_objects: Data Access Layer for Rendered Deployment Object operations.
• brokkr-broker::dal::stack_annotations: Data Access Layer for Stack Annotation operations.
• brokkr-broker::dal::stack_labels: Data Access Layer for Stack Label operations.
• brokkr-broker::dal::stacks: Data Access Layer for Stack operations.
• brokkr-broker::dal::template_annotations: Data Access Layer for Template Annotation operations.
• brokkr-broker::dal::template_labels: Data Access Layer for Template Label operations.
• brokkr-broker::dal::template_targets: Data Access Layer for TemplateTarget operations.
• brokkr-broker::dal::templates: Data Access Layer for Stack Template operations.
• brokkr-broker::dal::webhook_deliveries: Data Access Layer for WebhookDelivery operations.
• brokkr-broker::dal::webhook_subscriptions: Data Access Layer for WebhookSubscription operations.
• brokkr-broker::dal::work_orders: Data Access Layer for WorkOrder operations.
• brokkr-broker::db: Database connection pool management using diesel and r2d2.
• brokkr-broker::metrics
• brokkr-broker::utils: Utility functions and structures for the Brokkr broker.
• brokkr-broker::utils::audit: Async Audit Logger for Brokkr.
• brokkr-broker::utils::background_tasks: Background tasks for the Brokkr Broker.
• brokkr-broker::utils::config_watcher: Configuration file watcher for hot-reload support.
• brokkr-broker::utils::encryption: Encryption utilities for protecting sensitive data at rest.
• brokkr-broker::utils::event_bus: Event emission utilities for webhook notifications.
• brokkr-broker::utils::matching: Template-to-stack matching utilities.
• brokkr-broker::utils::pak: Prefixed API Key (PAK) management utilities.
• brokkr-broker::utils::templating: Tera template rendering and JSON Schema validation utilities.
• brokkr-broker::utils::ui_pak: Ephemeral read-only UI PAK (BROKKR-T-0267).
• brokkr-broker::ws: Internal broker↔agent WebSocket channel.
• brokkr-broker::ws::broadcaster: In-memory per-stack fan-out of agent telemetry frames.
• brokkr-broker::ws::eviction: Continuous retention enforcement for the agent telemetry tables (agent_k8s_events, agent_pod_logs).
• brokkr-broker::ws::fleet_subscribe: Consumer-facing WS subscription endpoint for the live fleet stream (BROKKR-I-0028).
• brokkr-broker::ws::handler: Axum handler for the internal /internal/ws/agent upgrade endpoint.
• brokkr-broker::ws::push: Broker-side push helpers for the internal WebSocket channel.
• brokkr-broker::ws::registry: Per-agent WebSocket connection registry.
• brokkr-broker::ws::subscribe: Read-only WS subscription endpoint for live agent telemetry tail.
• brokkr-models
• brokkr-models::models::agent_annotations
• brokkr-models::models::agent_events
• brokkr-models::models::agent_generator_registrations
• brokkr-models::models::agent_k8s_events: Persisted kube Events for objects an agent manages.
• brokkr-models::models::agent_labels
• brokkr-models::models::agent_pod_logs: Persisted pod log lines for managed workloads.
• brokkr-models::models::agent_targets
• brokkr-models::models::agents
• brokkr-models::models::audit_logs: Audit log models for tracking administrative and security-sensitive operations.
• brokkr-models::models::deployment_health
• brokkr-models::models::deployment_objects
• brokkr-models::models::diagnostic_requests: Diagnostic Request model for on-demand diagnostic requests.
• brokkr-models::models::diagnostic_results: Diagnostic Result model for storing collected diagnostic data.
• brokkr-models::models::generator
• brokkr-models::models::rendered_deployment_objects
• brokkr-models::models::stack_annotations
• brokkr-models::models::stack_labels
• brokkr-models::models::stack_templates
• brokkr-models::models::stacks
• brokkr-models::models::template_annotations
• brokkr-models::models::template_labels
• brokkr-models::models::template_targets
• brokkr-models::models::webhooks: Webhook models for event notifications.
• brokkr-models::models::work_order_annotations
• brokkr-models::models::work_order_labels
• brokkr-models::models::work_orders
• brokkr-utils
• brokkr-utils::config
• brokkr-utils::logging
• brokkr-utils::telemetry