Updated on 2024-04-23 GMT+08:00

Pre-upgrade Check

Function

Pre-upgrade check

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

apiVersion

Yes

String

API version, which defaults to v3

kind

Yes

String

Resource type, which defaults to PreCheckTask

spec

Yes

PrecheckSpec object

spec is an element type of the collection class. The main body of the configuration that needs to be checked before an upgrade is provided in spec. CCE checks the configuration based on the spec description.

Table 3 PrecheckSpec

Parameter

Mandatory

Type

Description

clusterID

No

String

Cluster ID

clusterVersion

No

String

Cluster version

targetVersion

No

String

Target Version

skippedCheckItemList

No

Array of skippedCheckItemList objects

Skipped check items

Table 4 skippedCheckItemList

Parameter

Mandatory

Type

Description

name

No

String

Names of the skipped check items

resourceSelector

No

resourceSelector object

Resource tag selector. This parameter is available only for node check, but not for cluster check or add-on check.

Table 5 resourceSelector

Parameter

Mandatory

Type

Description

key

Yes

String

Tag key. Options:

  • node.uid: node UID

values

No

Array of strings

Tag values

operator

Yes

String

Logical operator of a tag. Options:

  • In

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

apiVersion

String

API version

kind

String

Resource type

metadata

PrecheckCluserResponseMetadata object

Pre-upgrade check metadata

spec

PrecheckSpec object

spec is an element type of the collection class. The main body of the configuration that needs to be checked before an upgrade is provided in spec. CCE checks the configuration based on the spec description.

status

PrecheckStatus object

Pre-upgrade check status of a cluster

Table 7 PrecheckCluserResponseMetadata

Parameter

Type

Description

uid

String

Check the task ID.

Table 8 PrecheckSpec

Parameter

Type

Description

clusterID

String

Cluster ID

clusterVersion

String

Cluster version

targetVersion

String

Target Version

skippedCheckItemList

Array of skippedCheckItemList objects

Skipped check items

Table 9 skippedCheckItemList

Parameter

Type

Description

name

String

Names of the skipped check items

resourceSelector

resourceSelector object

Resource tag selector. This parameter is available only for node check, but not for cluster check or add-on check.

Table 10 resourceSelector

Parameter

Type

Description

key

String

Tag key. Options:

  • node.uid: node UID

values

Array of strings

Tag values

operator

String

Logical operator of a tag. Options:

  • In

Table 11 PrecheckStatus

Parameter

Type

Description

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

  • Error

expireTimeStamp

String

Check result expiration time

message

String

Information, which typically indicates the log for execution errors

clusterCheckStatus

clusterCheckStatus object

Status of a cluster restrictions check

addonCheckStatus

addonCheckStatus object

Status of an add-on check

nodeCheckStatus

nodeCheckStatus object

Node check status

Table 12 clusterCheckStatus

Parameter

Type

Description

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

itemsStatus

Array of PreCheckItemStatus objects

Compliance set by check item

Table 13 addonCheckStatus

Parameter

Type

Description

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

itemsStatus

Array of PreCheckItemStatus objects

Compliance set by check item

Table 14 nodeCheckStatus

Parameter

Type

Description

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

nodeStageStatus

Array of NodeStageStatus objects

Node check status

Table 15 NodeStageStatus

Parameter

Type

Description

nodeInfo

NodeInfo object

Node information

itemsStatus

Array of PreCheckItemStatus objects

Compliance set by check item

Table 16 NodeInfo

Parameter

Type

Description

uid

String

Node UID

name

String

Node name

status

String

Status

nodeType

String

Node type

Table 17 PreCheckItemStatus

Parameter

Type

Description

name

String

Check item

kind

String

Check item type. Options:

  • Exception: exceptions that need to be resolved by you

  • Risk: risks that can be skipped after you confirm them

group

String

Check item group. Options:

  • LimitCheck: cluster limit check

  • MasterCheck: master node check

  • NodeCheck: worker node check

  • AddonCheck: add-on check

  • ExecuteException: process error check

level

String

Check item severity. Options:

  • Info: information

  • Warning

  • Fatal: critical

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

message

String

Information

riskSource

riskSource object

Risk item

errorCodes

Array of strings

Error code set

Table 18 riskSource

Parameter

Type

Description

configurationRisks

Array of configurationRisks objects

Configuration risk

deprecatedAPIRisks

Array of deprecatedAPIRisks objects

Deprecated API risk

nodeRisks

Array of nodeRisks objects

Node risk

addonRisks

Array of addonRisks objects

Add-on risk

Table 19 configurationRisks

Parameter

Type

Description

package

String

Component

sourceFile

String

How to Obtain

nodeMsg

String

Node information

field

String

Parameter Value

operation

String

Change an operation type.

originalValue

String

Original Value

value

String

Current Value

Table 20 deprecatedAPIRisks

Parameter

Type

Description

url

String

Request path, for example, /apis/policy/v1beta1/podsecuritypolicies

userAgent

String

Client information

Table 21 nodeRisks

Parameter

Type

Description

NodeID

String

Worker node ID

Table 22 addonRisks

Parameter

Type

Description

addonTemplateName

String

Name of the add-on template

alias

String

Add-on alias

Example Requests

Request body for a cluster pre-upgrade check

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck

{
  "kind" : "PreCheckTask",
  "apiVersion" : "v3",
  "spec" : {
    "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c",
    "clusterVersion" : "v1.15.11-r1",
    "targetVersion" : "v1.19.16-r80",
    "skippedCheckItemList" : [ ]
  }
}

Example Responses

Status code: 200

Cluster pre-upgrade check succeeded.

{
  "kind" : "PreCheckTask",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "9991b45e-a2be-4b49-aca4-50a25fa6f81e"
  },
  "spec" : {
    "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c",
    "clusterVersion" : "v1.15.11-r1",
    "targetVersion" : "v1.19.16-r80"
  },
  "status" : {
    "phase" : "Init",
    "clusterCheckStatus" : {
      "phase" : "Init"
    },
    "addonCheckStatus" : {
      "phase" : "Init"
    },
    "nodeCheckStatus" : {
      "phase" : "Init"
    }
  }
}

Status Codes

Status Code

Description

200

Cluster pre-upgrade check succeeded.

Error Codes

See Error Codes.