Ocean AKS

Initiate Auto upgrade

Update the Ocean AKS cluster's VNGs with the latest version of the control plane's version after upgrading by specifying the scope. Performing this request will update the VNGs with a new version if available and run a cluster roll if set. If the response is successful, the old and new versions will be included in the response along with the updated VNGs. If a cluster roll is set in the request, the first response for a successful request will indicate the start of a roll. In order to check the status of the roll, you can use the GET Roll API.

post/ocean/azure/np/cluster/{oceanClusterId}/autoUpgrade

Request

Base URL
https://api.spotinst.io
URL
https://api.spotinst.io/ocean/azure/np/cluster/{oceanClusterId}/autoUpgrade
Auth
HTTP bearer

Parameters

#/paths/~1azure~1costs/get/parameters/0 (unresolved $ref)

#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1 (unresolved $ref)

#/paths/~1ocean~1azure~1np~1cluster~1aks~1import/post/parameters/1 (unresolved $ref)

#/paths/~1ocean~1azure~1np~1cluster~1aks~1import/post/parameters/2 (unresolved $ref)

Request body

Example request

{
  "upgradeConfig": {
    "applyRoll": true,
    "rollParameters": {
      "batchSizePercentage": 20,
      "comment": "Auto-upgrade the control plane to the latest patch version.",
      "respectPdb": true,
      "respectRestrictScaleDown": true,
      "batchMinHealthyPercentage": 80
    },
    "upgradeSystemNodePools": true,
    "systemNodePools": [
      "userpool",
      "systemNp1"
    ]
  }
}

Changes

No recorded changes to this operation across all 12 revisions of this API.