Ocean AKS

Create Migration

Migrate to ocean workloads that run on unmanaged nodes by specifying nodePoolNames or nodeNames. Performing this request will start the migration immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a migration. In order to check the status of a migration, you can use the GET migration API.

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

Request

Base URL
https://api.spotinst.io
URL
https://api.spotinst.io/ocean/azure/np/cluster/{oceanClusterId}/migration
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 migration. 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 migration. The comment is limited to 256 chars and optional.

respectPdbboolean

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

respectRestrictScaleDownboolean

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

shouldTerminateNodesboolean

If the parameter is set to true we will terminate the node after the migration has finished successfully. If the parameter is set to false we will leave the nodes. example: true

shouldEvictStandalonePodsboolean

If the parameter is set to true we will evict all standalone pods during the migration.

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 migration 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.

nodeNamesstring[]

List of node names to be migrated. Each identifier is a string. nodeNames can be null, and cannot be used together with nodePoolNames.

Example request

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

Changes

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