MachineHealthCheck [machine.openshift.io/v1beta1]

Description

MachineHealthCheck is the Schema for the machinehealthchecks API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

Type

`object`

Specification

Property	Type	Description
apiVersion	string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata	ObjectMeta	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec	object	Specification of machine health check policy
status	object	Most recently observed status of MachineHealthCheck resource

.spec

Description

Specification of machine health check policy

Type

`object`

Property	Type	Description
maxUnhealthy	integer-or-string	Any farther remediation is only allowed if at most "MaxUnhealthy" machines selected by "selector" are not healthy. Expects either a postive integer value or a percentage value. Percentage values must be positive whole numbers and are capped at 100%. Both 0 and 0% are valid and will block all remediation. Defaults to 100% if not set.
nodeStartupTimeout	string	Machines older than this duration without a node will be considered to have failed and will be remediated. To prevent Machines without Nodes from being removed, disable startup checks by setting this value explicitly to "0". Expects an unsigned duration string of decimal numbers each with optional fraction and a unit suffix, eg "300ms", "1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
remediationTemplate	object	remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Machine API Operator.
selector	object	Label selector to match machines whose health will be exercised. Note: An empty selector will match all machines.
unhealthyConditions	array	unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.
unhealthyConditions[]	object	UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.

.spec.remediationTemplate

Description

remediationTemplate is a reference to a remediation template provided by an infrastructure provider. This field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Machine API Operator.

Type

`object`

Property	Type	Description
apiVersion	string	API version of the referent.
fieldPath	string	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kind	string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace	string	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersion	string	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uid	string	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.selector

Description

Label selector to match machines whose health will be exercised. Note: An empty selector will match all machines.

Type

`object`

Property	Type	Description
matchExpressions	array	matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions[]	object	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
matchLabels	object (string)	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.selector.matchExpressions

Description

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type

`array`

.spec.selector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

`object`

Required

• key
• operator

Property	Type	Description
key	string	key is the label key that the selector applies to.
operator	string	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values	array (string)	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.unhealthyConditions

Description

unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.

Type

`array`

.spec.unhealthyConditions[]

Description

UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.

Type

`object`

Property	Type	Description
status	string
timeout	string	Expects an unsigned duration string of decimal numbers each with optional fraction and a unit suffix, eg "300ms", "1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
type	string

.status

Description

Most recently observed status of MachineHealthCheck resource

Type

`object`

Property	Type	Description
conditions	array	conditions defines the current state of the MachineHealthCheck
conditions[]	object	Condition defines an observation of a Machine API resource operational state.
currentHealthy	integer	total number of machines counted by this machine health check
expectedMachines	integer	total number of machines counted by this machine health check
remediationsAllowed	integer	remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied

.status.conditions

Description

conditions defines the current state of the MachineHealthCheck

Type

`array`

.status.conditions[]

Description

Condition defines an observation of a Machine API resource operational state.

Type

`object`

Required

• lastTransitionTime
• status
• type

Property	Type	Description
lastTransitionTime	string	Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	string	A human readable message indicating details about the transition. This field may be empty.
reason	string	The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.
severity	string	severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.
status	string	status of the condition, one of True, False, Unknown.
type	string	type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

API endpoints

The following API endpoints are available:

• /apis/machine.openshift.io/v1beta1/machinehealthchecks
  • GET: list objects of kind MachineHealthCheck
• /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks
  • DELETE: delete collection of MachineHealthCheck
  • GET: list objects of kind MachineHealthCheck
  • POST: create a MachineHealthCheck
• /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}
  • DELETE: delete a MachineHealthCheck
  • GET: read the specified MachineHealthCheck
  • PATCH: partially update the specified MachineHealthCheck
  • PUT: replace the specified MachineHealthCheck
• /apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}/status
  • GET: read status of the specified MachineHealthCheck
  • PATCH: partially update status of the specified MachineHealthCheck
  • PUT: replace status of the specified MachineHealthCheck

/apis/machine.openshift.io/v1beta1/machinehealthchecks

HTTP method

`GET`

Description

list objects of kind MachineHealthCheck

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheckList schema
401 - Unauthorized	Empty

/apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks

HTTP method

`DELETE`

Description

delete collection of MachineHealthCheck

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind MachineHealthCheck

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheckList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a MachineHealthCheck

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	MachineHealthCheck schema

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheck schema
201 - Created	MachineHealthCheck schema
202 - Accepted	MachineHealthCheck schema
401 - Unauthorized	Empty

/apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the MachineHealthCheck

HTTP method

`DELETE`

Description

delete a MachineHealthCheck

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified MachineHealthCheck

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheck schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified MachineHealthCheck

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheck schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified MachineHealthCheck

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	MachineHealthCheck schema

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheck schema
201 - Created	MachineHealthCheck schema
401 - Unauthorized	Empty

/apis/machine.openshift.io/v1beta1/namespaces/{namespace}/machinehealthchecks/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the MachineHealthCheck

HTTP method

`GET`

Description

read status of the specified MachineHealthCheck

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheck schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified MachineHealthCheck

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheck schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified MachineHealthCheck

Query parameters

Parameter	Type	Description
dryRun	string	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidation	string	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
body	MachineHealthCheck schema

HTTP responses

HTTP code	Reponse body
200 - OK	MachineHealthCheck schema
201 - Created	MachineHealthCheck schema
401 - Unauthorized	Empty