PodFailurePolicyRule

io.k8s.api.batch.v1.PodFailurePolicyRule source ↗

PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.

actionstring requiredSpecifies the action taken on a pod failure when the requirements are satisfied. Possible values are:
  • FailJob: indicates that the pod's job is marked as Failed and all
running pods are terminated.
  • FailIndex: indicates that the pod's index is marked as Failed and will
not be restarted.
  • Ignore: indicates that the counter towards the .backoffLimit is not
incremented and a replacement pod is created.
  • Count: indicates that the pod is handled in the default way - the
counter towards the .backoffLimit is incremented. Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.
onExitCodesPodFailurePolicyOnExitCodesRequirementRepresents the requirement on the container exit codes.
containerNamestringRestricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template.
operatorstring requiredRepresents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are:
  • In: the requirement is satisfied if at least one container exit code
(might be multiple if there are multiple containers not restricted by the 'containerName' field) is in the set of specified values.
  • NotIn: the requirement is satisfied if at least one container exit code
(might be multiple if there are multiple containers not restricted by the 'containerName' field) is not in the set of specified values. Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.
values[]integer (int32) requiredSpecifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value '0' cannot be used for the In operator. At least one element is required. At most 255 elements are allowed.
onPodConditions[]PodFailurePolicyOnPodConditionsPatternRepresents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed.
statusstring requiredSpecifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True.
typestring requiredSpecifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type.