Share via

AgentPoolUpgradeSettings Class

  • Reference
Package:
com.azure.resourcemanager.containerservice.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-containerservice:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.containerservice.models.AgentPoolUpgradeSettings

Implements

JsonSerializable<AgentPoolUpgradeSettings>

public final class AgentPoolUpgradeSettings
implements JsonSerializable<AgentPoolUpgradeSettings>

Settings for upgrading an agentpool.

Constructor Summary

Constructor Description
AgentPoolUpgradeSettings()

Creates an instance of AgentPoolUpgradeSettings class.

Method Summary

Modifier and Type Method and Description
Integer drainTimeoutInMinutes()

Get the drainTimeoutInMinutes property: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node.
static AgentPoolUpgradeSettings fromJson(JsonReader jsonReader)

Reads an instance of AgentPoolUpgradeSettings from the JsonReader.
String maxSurge()

Get the maxSurge property: This can either be set to an integer (e.g.
Integer nodeSoakDurationInMinutes()

Get the nodeSoakDurationInMinutes property: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
AgentPoolUpgradeSettings withDrainTimeoutInMinutes(Integer drainTimeoutInMinutes)

Set the drainTimeoutInMinutes property: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node.
AgentPoolUpgradeSettings withMaxSurge(String maxSurge)

Set the maxSurge property: This can either be set to an integer (e.g.
AgentPoolUpgradeSettings withNodeSoakDurationInMinutes(Integer nodeSoakDurationInMinutes)

Set the nodeSoakDurationInMinutes property: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AgentPoolUpgradeSettings

public AgentPoolUpgradeSettings()

Creates an instance of AgentPoolUpgradeSettings class.

Method Details

drainTimeoutInMinutes

public Integer drainTimeoutInMinutes()

Get the drainTimeoutInMinutes property: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.

Returns:

the drainTimeoutInMinutes value.

fromJson

public static AgentPoolUpgradeSettings fromJson(JsonReader jsonReader)

Reads an instance of AgentPoolUpgradeSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AgentPoolUpgradeSettings if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the AgentPoolUpgradeSettings.

maxSurge

public String maxSurge()

Get the maxSurge property: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster\#customize-node-surge-upgrade.

Returns:

the maxSurge value.

nodeSoakDurationInMinutes

public Integer nodeSoakDurationInMinutes()

Get the nodeSoakDurationInMinutes property: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.

Returns:

the nodeSoakDurationInMinutes value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withDrainTimeoutInMinutes

public AgentPoolUpgradeSettings withDrainTimeoutInMinutes(Integer drainTimeoutInMinutes)

Set the drainTimeoutInMinutes property: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.

Parameters:

drainTimeoutInMinutes - the drainTimeoutInMinutes value to set.

Returns:

the AgentPoolUpgradeSettings object itself.

withMaxSurge

public AgentPoolUpgradeSettings withMaxSurge(String maxSurge)

Set the maxSurge property: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster\#customize-node-surge-upgrade.

Parameters:

maxSurge - the maxSurge value to set.

Returns:

the AgentPoolUpgradeSettings object itself.

withNodeSoakDurationInMinutes

public AgentPoolUpgradeSettings withNodeSoakDurationInMinutes(Integer nodeSoakDurationInMinutes)

Set the nodeSoakDurationInMinutes property: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.

Parameters:

nodeSoakDurationInMinutes - the nodeSoakDurationInMinutes value to set.

Returns:

the AgentPoolUpgradeSettings object itself.

Applies to