Skip to main content

Crate cockpitctl_types

Crate cockpitctl_types 

Source
Expand description

DTOs and stable primitives for cockpitctl.

This crate is intentionally boring:

  • pure data structures
  • stable IDs and enums
  • deterministic ordering helpers

It must not depend on filesystem, clap, or network.

Structs§

ArtifactPointer
Pointer to an artifact produced by a sensor.
BuildfixActuatorConfig
External command configuration for buildfix actuation.
BuildfixActuatorResult
Structured response returned by a buildfix actuator command on stdout.
BuildfixApplyRequest
Structured request sent to a buildfix actuator command on stdin.
BuildfixApplySummary
Buildfix auto-apply evidence surfaced in cockpit.report.v1 data.
BuildfixPlan
A buildfix plan: a set of fixes to apply.
BuildfixPolicy
Buildfix auto-apply policy in cockpit.toml.
BuildfixSummary
Summary of buildfix plans for cockpit surfacing.
Capability
CiInfo
CockpitConfig
CockpitPromoteHints
Promotion hints for cockpit (data._cockpit).
CockpitReport
The director output: cockpit.report.v1.
CountDeltas
Delta counts for findings.
Finding
FindingRef
Reference to a finding that a fix addresses.
FindingSortKey
A stable key used for sorting findings deterministically.
Fix
A single fix in a buildfix plan.
FixSummary
Summary of a single fix for cockpit surfacing.
GitInfo
Highlight
HookConfig
Configuration for a post-processing hook.
HostInfo
Location
MatchedFinding
A matched finding for a fix.
Policy
PolicySensorSnapshot
PolicySignatureEvidence
Signed evidence for the policy snapshot used to compute a cockpit verdict.
PolicySigningConfig
Policy snapshot signing config in cockpit.toml.
PolicySnapshot
Preconditions
Preconditions that must hold before applying a fix.
PromoteCard
A card promoted to the cockpit summary from a sensor.
RunInfo
SensorPolicy
A per-sensor policy in cockpit.toml.
SensorReport
The shared receipt envelope for sensors.
SensorSummary
A single sensor row in the cockpit aggregate report.
SuggestedArtifact
A suggested artifact from a sensor via promotion.
SuggestedHighlight
A suggested highlight from a sensor via promotion.
ToolInfo
TrendDelta
Full trend delta between a baseline and current report.
TrendFinding
A finding that changed between baseline and current.
Verdict
VerdictChange
Change in the overall verdict between baseline and current.
VerdictCounts

Enums§

BuildfixApplyStatus
Result status of buildfix auto-apply.
CapabilityStatus
HookWhen
When a hook should run.
MissingPolicy
Missing receipt behavior (policy).
PolicyOutcome
Policy outcome for a sensor after evaluation.
PolicySignatureAlgorithm
Signature algorithm used for policy snapshot evidence.
Presence
Presence state for a sensor in the cockpit report.
SafetyLevel
Safety level for a fix.
SchemaValidation
Schema validation mode for sensor receipts.
Severity
TrendChange
Category of change for a trending finding.
VerdictStatus

Constants§

BUILDFIX_APPLY_REQUEST_SCHEMA_ID
Schema identifier for buildfix apply requests sent to actuator commands.
BUILDFIX_PLAN_V1_SCHEMA_JSON
Embedded JSON Schema for buildfix.plan.v1.
COCKPIT_PROMOTE_V1_SCHEMA_JSON
Embedded JSON Schema for cockpit.promote.v1.
COCKPIT_REPORT_V1_SCHEMA_JSON
Embedded JSON Schema for cockpit.report.v1.
POLICY_SIGNATURE_SCHEMA_ID
Schema identifier for policy signature evidence.
SENSOR_REPORT_V1_SCHEMA_JSON
Embedded JSON Schema for sensor.report.v1.

Functions§

is_valid_sensor_id
Validate a sensor ID for safe path usage.
safety_level_rank
Rank a safety level for deterministic ordering and gating. Lower is safer.
severity_rank
verdict_status_rank

Type Aliases§

SchemaId
A schema identifier string, e.g. builddiag.report.v1.