Class V1alpha1TargetResponder

TargetResponder allows you to specify the responder reacting to the Eviction. Responders should observe and communicate through the Eviction API (see .state) to help with the graceful eviction of a target (e.g. termination of a pod).

Inheritance
object
V1alpha1TargetResponder
Implements
Inherited Members
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1alpha1TargetResponder : IEquatable<V1alpha1TargetResponder>

Constructors

V1alpha1TargetResponder()

Declaration
public V1alpha1TargetResponder()

V1alpha1TargetResponder(V1alpha1TargetResponder)

Declaration
protected V1alpha1TargetResponder(V1alpha1TargetResponder original)
Parameters
Type Name Description
V1alpha1TargetResponder original

Properties

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type

Name

name 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.

Declaration
[JsonPropertyName("name")]
public string Name { get; set; }
Property Value
Type Description
string

Priority

priority 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.

Declaration
[JsonPropertyName("priority")]
public int Priority { get; set; }
Property Value
Type Description
int

State

state 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.

Declaration
[JsonPropertyName("state")]
public string State { get; set; }
Property Value
Type Description
string

Methods

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

Equals(V1alpha1TargetResponder?)

Declaration
public virtual bool Equals(V1alpha1TargetResponder? other)
Parameters
Type Name Description
V1alpha1TargetResponder other
Returns
Type Description
bool

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

operator ==(V1alpha1TargetResponder?, V1alpha1TargetResponder?)

Declaration
public static bool operator ==(V1alpha1TargetResponder? left, V1alpha1TargetResponder? right)
Parameters
Type Name Description
V1alpha1TargetResponder left
V1alpha1TargetResponder right
Returns
Type Description
bool

operator !=(V1alpha1TargetResponder?, V1alpha1TargetResponder?)

Declaration
public static bool operator !=(V1alpha1TargetResponder? left, V1alpha1TargetResponder? right)
Parameters
Type Name Description
V1alpha1TargetResponder left
V1alpha1TargetResponder right
Returns
Type Description
bool

Implements