SPspot
Ocean AKS

Initiate Roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying vngIds, nodePoolNames or nodeNames. Performing this request will start the roll immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API.

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

Request

  • Base URL
    https://api.spotinst.io
  • URL
    https://api.spotinst.io/ocean/azure/np/cluster/{oceanClusterId}/roll
  • 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)

Request body

batchSizePercentageinteger

Value as a percent to set the size of a batch in a roll. Valid values are 0-100. In case of null as value, the default value in the backend will be 20%.

commentstring

Add a comment description for the roll. The comment is limited to 256 chars and optional.

respectPdbboolean

During the roll, if the parameter is set to true we honor PDB during the nodes replacement.

respectRestrictScaleDownboolean

During the roll, if the parameter is set to true we honor Restrict Scale Down label during the nodes replacement.

batchMinHealthyPercentageinteger

Indicates the threshold of minimum healthy nodes in single batch. If the amount of healthy nodes in single batch is under the threshold, the roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.

Example request

{
  "batchSizePercentage": 25,
  "comment": "This is why I deployed my cluster.",
  "respectRestrictScaleDown": true,
  "batchMinHealthyPercentage": 100
}

Changes

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