Health Records

A HealthRecord contains health information for a particular resource. When a Health Record is created or updated for a given Resource, Kratix will update the referenced resource status to reflect the data in the HealthRecord. It has the following format:

apiVersion: platform.kratix.io/v1alpha1
kind: HealthRecord
metadata:
  name: healthrecord-example
  namespace: default # must match the resource request namespace
data:
  promiseRef:
    name: promise-name
  # A reference to the Resource Request the Health Check should be performed against
  resourceRef:
    name: request-name
    namespace: default
  # The condition of the Health Check
  # Can be unknown, ready, unhealthy, healthy or degraded
  state: ready
  # The timestamp of the last time the Health Check was executed
  lastRun: 1531958400
  # Optional: any additional details
  details:
    example: data
  # Optional: the promise version stamped on the HealthDefinition that produced the record
  promiseVersion: v2.0.0

Kratix ignores a record that is not in the same namespace as the resource it references: it does not appear in the resource's status, and it does not change state or the HealthChecksSucceeded condition.

Any record in the resource's namespace counts towards status.healthStatus.state, regardless of the presence of a promiseVersion field.

Only records whose promiseVersion equals status.healthStatus.expectedPromiseVersion count towards the resource's HealthChecksSucceeded condition.

Check the Surfacing health information guide for more information about how to use this CRD.