Initiate Roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceNames. Performing this request will start the roll immediately, and the roll will take place according to defined batches. <br /> <br /> Note that the first response for a successful request will notify about the start of a roll. In order to check the status of a roll, you can use the GET Cluster Roll API using the roll identifier.

post/ocean/gcp/k8s/cluster/{oceanId}/roll

Parameters

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

#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/get/parameters/1 — unresolved $ref

Request body

object required

Example request

{
  "roll": {
    "batchSizePercentage": 20,
    "comment": "This is why I deployed my cluster.",
    "respectPdb": true,
    "batchMinHealthyPercentage": 100
  }
}

Response

Cluster Roll Response

rollIdstring

oceanIdstring

scope'Cluster' | 'Vngs' | 'Vng' | 'Instances' | 'Instance'

status'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'STOPPED'

batchNumberinteger

numOfBatchesinteger

commentstring

respectPdbboolean

instanceNamesstring[]

launchSpecIdsstring[]

batchMinHealthyPercentageinteger

createdAtstring

updatedAtstring

Example response

{
  "rollId": "roll-1234",
  "oceanId": "o-12e31234",
  "scope": "Cluster",
  "status": "IN_PROGRESS",
  "batchNumber": 1,
  "numOfBatches": 5,
  "comment": "This is why I deployed my cluster.",
  "respectPdb": true,
  "progress": {
    "unit": "percentage",
    "detailedStatus": {
      "oldInstances": [
        {
          "instanceName": "sin-0a4becc0-sig-1234abcd",
          "status": "REPLACED"
        },
        {
          "instanceName": "sin-1a4becc0-sig-1234abcd",
          "status": "TO_BE_REPLACED"
        },
        {
          "instanceName": "sin-2a4becc0-sig-1234abcd",
          "status": "COULD_NOT_BE_REPLACED"
        },
        {
          "instanceName": "sin-3a4becc0-sig-1234abcd",
          "status": "NOT_REPLACED_DUE_TO_PDB"
        }
      ]
    }
  },
  "instanceNames": [
    "sin-0a4becc0-sig-6952238d",
    "sin-0542ecc0-sig-695223r4"
  ],
  "launchSpecIds": [
    "ols-76694a7d",
    "ols-56694a76"
  ],
  "batchMinHealthyPercentage": 100,
  "createdAt": "2019-03-24T15:46:09.000Z",
  "updatedAt": "2019-03-24T15:46:09.000Z"
}