Schemaobject

io.k8s.api.core.v1.ResourceHealth

ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.

Source: specs/api__v1_openapi.json
Revision: 9a79c3bd90f7
Active snapshot: 2a9112600697

health string

optional

Health of the resource. can be one of: - Healthy: operates as normal - Unhealthy: reported unhealthy. We consider this a temporary health issue since we do not have a mechanism today to distinguish temporary and permanent issues. - Unknown: The status cannot be determined. For example, Device Plugin got unregistered and hasn't been re-registered since. In future we may want to introduce the PermanentlyUnhealthy Status.

message string

optional

Message provides human-readable context for Health (e.g. "ECC error count exceeded threshold"). This field is populated by the kubelet when ResourceHealthStatusMessage is enabled if the DRA plugin returns a message, and is null otherwise.

resourceID string

required

ResourceID is the unique identifier of the resource. See the ResourceID type for more information.

Root JSON Schema

{"description":"ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.","properties":{"health":{"description":"Health of the resource. can be one of:\n - Healthy: operates as normal\n - Unhealthy: reported unhealthy. We consider this a temporary health issue\n              since we do not have a mechanism today to distinguish\n              temporary and permanent issues.\n - Unknown: The status cannot be determined.\n            For example, Device Plugin got unregistered and hasn't been re-registered since.\n\nIn future we may want to introduce the PermanentlyUnhealthy Status.","type":"string"},"message":{"description":"Message provides human-readable context for Health (e.g. \"ECC error count exceeded threshold\"). This field is populated by the kubelet when ResourceHealthStatusMessage is enabled if the DRA plugin returns a message, and is null otherwise.","type":"string"},"resourceID":{"default":"","description":"ResourceID is the unique identifier of the resource. See the ResourceID type for more information.","type":"string"}},"required":["resourceID"],"type":"object"}