/workload-eviction/v1/clusters/{clusterId}/config

patch

https://api.cast.ai/workload-eviction/v1/clusters/{clusterId}/config

Updates basic evictor configuration for the target cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clusterId

string

required

The ID of the cluster.

Body Params

Config defines the basic evictor component settings.
This was previously nested in Policies.NodeDownscaler.Evictor in V1.

enabled

boolean

Enable/disable the Evictor policy. This will either install or uninstall the Evictor component in your cluster.
Default: false

dryRun

boolean

Defaults to false

Enable/disable dry-run. This property allows you to prevent the Evictor from carrying any operations out and
preview the actions it would take.
Default: false

aggressiveMode

boolean

Defaults to false

Enable/disable aggressive mode. By default, Evictor does not target nodes that are running unreplicated pods.
This mode will make the Evictor start considering application with just a single replica.
Default: false

scopedMode

boolean

Defaults to false

Enable/disable scoped mode. By default, Evictor targets all nodes in the cluster. This mode will constrain in to
just the nodes which were created by CAST AI.
Default: false

cycleInterval

string

Defaults to 60s

Configure the interval duration between Evictor operations. This property can be used to lower or raise the
frequency of the Evictor's find-and-drain operations.
Default: 1 minute

nodeGracePeriodMinutes

int32

Defaults to 5

Configure the node grace period which controls the duration which must pass after a node has been created before
Evictor starts considering that node.
Default: 5 minutes

podEvictionFailureBackOffInterval

string

Defaults to 5s

Configure the pod eviction failure back off interval. If pod eviction fails then Evictor will attempt
to evict it again after the amount of time specified here.
Default: 5 seconds

ignorePodDisruptionBudgets

boolean

Defaults to false

If enabled then Evictor will attempt to evict pods that have pod disruption budgets configured.
Default: false

softTainting

boolean

Defaults to false

If enabled, Evictor will use soft tainting (PreferNoSchedule) instead of hard cordoning after eviction.
Default: false

emitNodeRelatedPodEvents

boolean

If enabled, Evictor emits Kubernetes events on pods when they are evicted
as part of a node drain.
Default: false

drainTimeout

string

Maximum time the evictor waits for a node to fully drain before giving up.
Default: 10 minutes

drainRollbackTimeout

string

How long the evictor waits before rolling back a cordon when a drain attempt fails.
Default: 1 minute

windows

boolean

If enabled, Evictor will evict pods and nodes running Windows workloads.
Default: false

forceDisableLiveMigration

boolean

If enabled, disables LIVE pod migration even when the cluster capability is detected.
Default: false

forceDisableWoop

boolean

If enabled, disables WOOP scheduling recommendations even when the cluster capability is detected.
Default: false

forceDisablePodMutations

boolean

If enabled, disables PodMutation CR application during scheduling simulation
even when the cluster capability is detected.
Default: false

forceDisableKarpenterMode

boolean

If enabled, disables Karpenter-aware scheduling simulation even when Karpenter is detected.
Default: false

maxTargetNodesPerCycle

int32

Upper bound on nodes drained in a single cycle.
Default: 0 (no limit)

minTargetNodesPerCycle

int32

Lower bound on nodes considered per cycle.
Default: 0

targetNodePercentage

int32

Percentage of eligible nodes to consider per cycle, applied after min/max bounds.
Default: 0

pricingAwarenessEnabled

boolean

If enabled, the evictor factors node cost into drain candidate selection,
preferring to drain more expensive nodes first.
Default: false

pricingModel

object

PricingModel overrides the cost coefficients used for pricing-aware candidate selection.

arm64Supported

boolean

If enabled, indicates arm64 nodes are present so the scheduling simulation
includes them as valid bin-packing targets.
Default: false

Responses

200OK

defaultDefault error response