MachineHealthCheck

Scope: Namespaced
Version: v1beta1

MachineHealthCheck is the Schema for the machinehealthchecks API.

  • 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
    object
  • spec
    object

    Specification of machine health check policy

    • spec.clusterName
      string

      Required value

      ClusterName is the name of the Cluster this object belongs to.

    • spec.maxUnhealthy
      integer or string

      Any further remediation is only allowed if at most “MaxUnhealthy” machines selected by “selector” are not healthy.

    • spec.nodeStartupTimeout
      string

      Machines older than this duration without a node will be considered to have failed and will be remediated. If not set, this value is defaulted to 10 minutes. If you wish to disable this feature, set the value explicitly to 0.

    • spec.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 Cluster API.

      • spec.remediationTemplate.apiVersion
        string

        API version of the referent.

      • spec.remediationTemplate.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. TODO: this design is not final and this field is subject to change in the future.

      • spec.remediationTemplate.kind
        string

        Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      • spec.remediationTemplate.name
        string

        Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

      • spec.remediationTemplate.namespace
        string

        Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

      • spec.remediationTemplate.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

      • spec.remediationTemplate.uid
        string

        UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

    • spec.selector
      object

      Required value

      Label selector to match machines whose health will be exercised

      • spec.selector.matchExpressions
        array of objects

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

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

        • spec.selector.matchExpressions.key
          string

          Required value

          key is the label key that the selector applies to.

        • spec.selector.matchExpressions.operator
          string

          Required value

          operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

        • spec.selector.matchExpressions.values
          array of strings

          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.selector.matchLabels
        object

        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.unhealthyConditions
      array of objects

      Required value

      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.

      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.unhealthyConditions.status
        string

        Required value

      • spec.unhealthyConditions.timeout
        string

        Required value

      • spec.unhealthyConditions.type
        string

        Required value

    • spec.unhealthyRange
      string

      Any further remediation is only allowed if the number of machines selected by “selector” as not healthy is within the range of “UnhealthyRange”. Takes precedence over MaxUnhealthy. Eg. “[3-5]” - This means that remediation will be allowed only when: (a) there are at least 3 unhealthy machines (and) (b) there are at most 5 unhealthy machines

      Pattern: ^\[[0-9]+-[0-9]+\]$