EvictionStatus

io.k8s.api.lifecycle.v1alpha1.EvictionStatus source ↗

EvictionStatus represents the last observed status of the eviction request.

conditions[]Conditionconditions contain information about the eviction request.Eviction specific conditions are: TargetEvicted or Failed (managed by evictionrequest-controller). - Failed means that the eviction request is no longer being processed by any eviction responder. This can happen if the request is canceled or if no responder managed to evict the target (e.g. terminate or delete a pod).
  • TargetEvicted means that the target has been evicted (e.g. a pod has been terminated or deleted).
The maximum length of the conditions list is 100.
lastTransitionTimeTime requiredlastTransitionTime is the 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.
messagestring requiredmessage is a human readable message indicating details about the transition. This may be an empty string.
observedGenerationinteger (int64)observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reasonstring requiredreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
statusstring requiredstatus of the condition, one of True, False, Unknown.
typestring requiredtype of condition in CamelCase or in foo.example.com/CamelCase.
observedGenerationinteger (int64)observedGeneration is Eviction's .metadata.generation observed by the evictionrequest-controller. The observed generation value cannot be negative and can only be incremented. The minimum value is 1. This field is managed by evictionrequest-controller.
requesters[]Requesterrequesters allow you to identify the entities, that requested the eviction of the target. If all the requesters withdraw their eviction intent, the eviction will be canceled.The maximum length of the requesters list is 100. If this limit is exceeded, requesters with Withdrawn intent should be dropped first.
intentstring requiredintent specifies the action that should be taken for the specified target.
  • Eviction means that the requester is interested in the eviction of the target. - Withdrawn means that the requester is no longer interested in the eviction of the target.
If all requesters' intents are withdrawn, the eviction will be canceled. Cancellation consequences:
  • Inactive responders will never run.
  • Active responders are expected to cancel the eviction.
  • Completed or Interrupted responders should not take any action.
namestring requiredname allows you to identify the entity, that requested the eviction of the target.It must be a valid domain-prefixed key (such as "acme.io/foo"). This field must be unique for each requester. This field is required.
responders[]ResponderStatusresponders represents the eviction process status of each declared responder.The responder list should be the same length and have the same .name fields as .status.targetResponders. Only responders with .name that have Active state in .targetResponders[].state should be updated and can be mutated. First initialization of the list is allowed.Each ResponderStatus is initialized by evictionrequest-controller and then managed by the designated responder.
completionTimeTimecompletionTime tracks the time at which the Responder stopped processing the eviction request. Completion means that the responders has either fully or partially completed the eviction process, which may have resulted in target eviction (e.g. pod termination). It should reflect the present time when set. This field becomes immutable once set.
expectedCompletionTimeTimeexpectedCompletionTime is the time at which the eviction process step is expected to end for the responder. The time cannot be set to the past. May be omitted if no estimate can be made.
heartbeatTimeTimeheartbeatTime is the last time at which the eviction process was reported to be in progress by the responder. It should reflect the present time when set. Responders should avoid heartbeats more frequent than 20 seconds to avoid overloading the control-plane.
messagestringmessage provides human-readable details about the state of the responder and the eviction process. Maximum length is 4000 characters.
namestring requiredname allows you to identify the responder reacting to the Eviction.It must be a valid domain-prefixed key (such as "acme.io/foo"). This field is initialized by Kubernetes and must be unique for each responder. This field is required.
startTimeTimestartTime tracks the time at which this responder was designated as active and should start processing the eviction request. It should reflect the present time when set. This field is initialized by Kubernetes when this responder becomes active. This field becomes immutable once set.
targetResponders[]TargetRespondertargetResponders reference responders that should eventually respond to this eviction to help with the graceful eviction of a target. These responders are selected sequentially, according to their specified priority by setting the Active state to the TargetResponder .state field. The maximum number of active responders allowed is 1. Eventually each responder can end up in an Interrupted, Canceled or, Completed state. Responders should observe these states in order to navigate their lifecycle.If the target is a pod, the field is populated from Pod's .spec.evictionResponders. Default responders may be added to the list according to the target.Default responders: - imperative-eviction.k8s.io/evictor responder with a priority of 100 is added to the list if the target is a pod. It will call the imperative Eviction API (pods/<name>/eviction subresource). This call may not succeed due to PodDisruptionBudgets, which may block the pod termination. It will update the responder message and try again with a backoff.The maximum length of the responders list is 11. The length and keys of the list cannot change once set. This field is managed by evictionrequest-controller.
namestring requiredname allows you to identify the responder reacting to the Eviction.It must be a valid domain-prefixed key (such as "acme.io/foo"). This field must be unique for each responder. This field is required.
priorityinteger (int32) requiredpriority for this responder. Higher priorities are selected first by the evictionrequest-controller. If there are responders with the same priority, the responder whose domain name comes first in the alphabetical higher domain order, will be picked. This means that the top domain labels are compared alphabetically first, followed by the lower domain labels. The key is compared last.The responder that is the managing controller of the pod should set the value of this field to 10000 to allow both for preemption or fallback registration by other responders.The minimum value is 0 and the maximum value is 100000. The interval 0-999 is reserved for responders with *.k8s.io suffix. This field is required and immutable.
statestring requiredstate specifies a state that is assigned by the evictionrequest-controller. Responders should observe this state in order to navigate their lifecycle. - Inactive means that the responder should not yet process this eviction request. - Active means that the responder is either running or expected to start soon. Also, startTime has been set in the ResponderStatus by the evictionrequest-controller.An active responder should currently interact with the eviction process by updating .status.responders, where .name is the active responder name. ResponderStatus fields should be periodically updated to indicate the progress or completion of the eviction process. If .status.responders[].heartbeatTime field is not updated within the heartbeat deadline defined by the Eviction API (currently 20 minutes), the eviction is passed over to the next responder with a lower priority. Only one responder can be active at a time.
  • Interrupted means that the responder has failed to start or failed to update
heartbeatTime in ResponderStatus in a timely manner.
  • Canceled means that the responder has been canceled. In other words, there is no
EvictionRequest with the same target and Eviction intent in .spec.intent.
  • Completed means that the responder has successfully completed and set completionTime
in ResponderStatus.Please refer to the ResponderStatus in .status.responders for more details on each responder.