Upgrading the Kernel Version of a DB Instance

Function

This API is used to upgrade kernel version of a DB instance. There are three upgrade types: in-place upgrade, gray upgrade, and hot patch upgrade.

• In-place upgrade

  Services are interrupted for about 30 minutes during the in-place upgrade. All nodes in a DB instance are upgraded at a time and you need to stop all services during the upgrade.

• Gray upgrade
  Services are interrupted for 10s during the upgrade of each primary DN or CN. The management plane is upgraded first, and then the data plane from the standby nodes to the primary nodes. You can either select auto-commit after the upgrade or perform a rolling upgrade.

  • Auto-commit: All nodes are upgraded at the same time. Services are interrupted for about 10s during the upgrade.
  • Rolling upgrade: You can observe service status before committing the upgrade. There are upgrade and commit phases.
    • In the upgrade phase, DB instances can be upgraded by shard or AZ based on the deployment model.
      • Distributed instances are upgraded by shard.
      • Primary/standby instances are upgraded by AZ.
    • In the commit phase, you can test services on your instance after the upgrade is complete, and then either commit or roll back the upgrade based on test results.
      • Commit: After the upgrade is complete and services are normal, commit the upgrade.
      • Rollback: When the upgrade is complete and enters the commit phase, you can roll back the instance to the source version as required.
• Hot patch upgrade
  • Auto-commit: Hot patches are automatically upgraded and committed without downtime.
  • Rollback: Services are not interrupted when the hot patches are rolled back.

• Learn how to authenticate this API.
• Obtain the required region and endpoint.

URI

PUT https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/db-upgrade

Request Parameters

Response Parameters

Example Request

• In-place upgrade

  PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade
  { 
      "upgrade_type" : "inplace",
      "target_version": "xxx"
  }

• Hot patch upgrade
  • Upgrading hot patches

    PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade
    {
        "upgrade_type" : "hotfix",
        "target_version" : "xxxx,xxxx,xxxx",
        "upgrade_action" : "upgradeAutoCommit"
    }

  • Rolling back hot patches

    PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade
    {
        "upgrade_type": "hotfix",
        "target_version": "xxxx,xxxx,xxxx",
        "upgrade_action": "rollback"
    }

• Gray upgrade
  1. Setting upgrade_action to upgradeAutoCommit

     PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade
     { 
         "upgrade_type" : "grey",
         "target_version": "xxx",
         "upgrade_action" : "upgradeAutoCommit" 
     }

  2. Setting upgrade_action to upgrade
     1. Configuring required parameters

        PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade
        { 
            "upgrade_type" : "grey",
            "target_version": "xxx",
            "upgrade_action" : "upgrade", 
            "upgrade_shard_num" : 1 
        }

     2. Rollin back the upgrade when the instance is in the rolling upgrade phase (All upgraded shards will be rolled back. After the instance becomes available, the rollback is successful.)

        PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade
        { 
            "upgrade_type" : "grey",
            "target_version": "xxx",
            "upgrade_action" : "rollback"
        }

     3. Committing the upgrade when the instance is in the rolling upgrade phase and all shards are upgraded (After the instance is available, the upgrade is complete.)

        PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade
        { 
            "upgrade_type" : "grey",
            "target_version": "xxx",
            "upgrade_action" : "commit"
        }

• Upgrading a primary/standby instance in the gray method (upgrade action is rolling upgrade)

  PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade
  { 
      "upgrade_type" : "grey", 
      "upgrade_action" : "upgrade", 
      "target_version": "xxx",
      "upgrade_az" : "az1,az2" 
  }

Example Response

{ 
  "job_id" : "2b414788a6004883a02390e2eb0ea227" 
}

Status Code

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.