Azure Kubernetes Service · Schema

AgentPoolUpgradeSettings

Settings for upgrading an agentpool.

AzureCloudContainersDevOpsKubernetesOrchestration

Properties

Name Type Description
maxSurge string The maximum number or percentage of nodes that are surged during upgrade. 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 o
drainTimeoutInMinutes integer The amount of time (in minutes) to wait on eviction of pods and graceful termination per node.
nodeSoakDurationInMinutes integer The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to the next node.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-kubernetes-service-agentpoolupgradesettings-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AgentPoolUpgradeSettings",
  "title": "AgentPoolUpgradeSettings",
  "type": "object",
  "description": "Settings for upgrading an agentpool.",
  "properties": {
    "maxSurge": {
      "type": "string",
      "description": "The maximum number or percentage of nodes that are surged during upgrade. 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.",
      "example": "example_value"
    },
    "drainTimeoutInMinutes": {
      "type": "integer",
      "format": "int32",
      "minimum": 1,
      "maximum": 1440,
      "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node.",
      "example": 10
    },
    "nodeSoakDurationInMinutes": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "maximum": 30,
      "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to the next node.",
      "example": 10
    }
  }
}