Struct RepositoryHealthProbeSpec 

pub struct RepositoryHealthProbeSpec {
    pub enabled: Option<bool>,
    pub interval: Option<String>,
    pub failure_threshold: Option<i64>,
    pub on_failure: Option<ProbeOnFailure>,
}

Backend health probe, shared by Repository and ClusterRepository. On by default.

Once a repository reaches Ready, the operator trusts that pinned status and — for object-store / volume-backed backends — never re-checks the backend on its steady-state heartbeat. If the kopia repository is wiped or becomes unreachable, nothing notices until a backup runs and fails. The probe re-connects the backend every interval and surfaces the result as the BackendReachable condition + a Warning event.

What happens past failureThreshold consecutive failures depends on onFailure: with the default Degrade, the repository moves to Degraded and backups, maintenance, and replication are paused until a re-connect succeeds (the repository circuit breaker); with Alert, the repository stays Ready and only the condition + event + metric fire.

Never destructive. A wiped repository and a transient outage look alike, and silently recreating an empty repository over a real one destroys restorability — so the probe never auto-recreates. Acting on a RepositoryVanished alert (a deliberate re-create) is a human decision.

Fields

enabled: Option<bool>

Whether the probe runs (default true). false disables probing — and with it the circuit breaker, since the probe is its only sensor: a wiped or unreachable backend then goes unnoticed until the next backup fails.

interval: Option<String>

How often to re-probe the backend (Go-style duration like 30m or 1h; minimum 30s, default 30m). Inert when enabled: false.

failure_threshold: Option<i64>

How many consecutive failing probes to require before the failure is acted on (default 3): the loud BackendReachable=False condition + event fire, and — under onFailure: Degrade — the repository moves to Degraded. Debounces a single transient blip from alarming, tripping the breaker, or nudging a destructive manual recreate. Any success resets it.

on_failure: Option<ProbeOnFailure>

What sustained probe failure (past failureThreshold) does to the repository (default Degrade). Degrade moves it to Degraded, pausing backups and replication until a re-connect succeeds — recovery is automatic. Maintenance also pauses when the backend is confirmed unreachable or the repository vanished, but keeps running when the degradation is a probe deadline kill (ProbeDeadlineExceeded — index compaction is often the cure). Alert keeps the repository Ready and only raises the condition + Warning event + metric (the pre-breaker behavior); backups keep running against the failing backend.

Implementations

impl RepositoryHealthProbeSpec

pub fn enabled(health: Option<&RepositoryHealthSpec>) -> bool

Whether the backend health probe runs (spec.health.probe.enabled).

This resolver is the load-bearing default (#345), not the CRD schema default: — a nested schema default only materializes when its parent object is present, and most specs omit spec.health/probe entirely. Absent spec/probe/field ⇒ DEFAULT_HEALTH_PROBE_ENABLED (true); an explicit Some(v) ⇒ v. Every caller resolves through this single seam, so enabled: false is the one way to opt out.

pub fn effective_on_failure( health: Option<&RepositoryHealthSpec>, ) -> ProbeOnFailure

The effective onFailure policy: spec.health.probe.onFailure when set, else ProbeOnFailure::Degrade — the circuit breaker is the default, matching the schema default: (which only materializes when the probe object is present; this resolver covers the absent-parent case).

pub fn effective_interval(health: Option<&RepositoryHealthSpec>) -> Duration

The effective probe cadence used when the probe is enabled: interval when set and parseable, else DEFAULT_HEALTH_PROBE_INTERVAL. (The webhook rejects an unparseable value, so the fallback only covers objects admitted before the validator existed.)

pub fn effective_failure_threshold(health: Option<&RepositoryHealthSpec>) -> i64

The effective consecutive-failure threshold before the loud condition is raised: failureThreshold when set (clamped to at least 1), else DEFAULT_HEALTH_PROBE_FAILURE_THRESHOLD.

Trait Implementations

impl Clone for RepositoryHealthProbeSpec

fn clone(&self) -> RepositoryHealthProbeSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RepositoryHealthProbeSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RepositoryHealthProbeSpec

fn default() -> RepositoryHealthProbeSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RepositoryHealthProbeSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RepositoryHealthProbeSpec

impl JsonSchema for RepositoryHealthProbeSpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RepositoryHealthProbeSpec

fn eq(&self, other: &RepositoryHealthProbeSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RepositoryHealthProbeSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RepositoryHealthProbeSpec