This topic describes how to upgrade instance configurations in the Message Queue for Apache Kafka console. You can upgrade configurations such as the instance edition, traffic specification, disk capacity, and partition specification.

Prerequisites

  • The instance is in the Running or Not Deployed state.
  • No topic traffic rebalancing tasks are in progress in the instance.

Precautions

When you upgrade instance configurations, brokers in the cluster restart one by one. This may cause the following risks:
  • Clients are temporarily disconnected and reconnected, and a few errors may be reported.
  • Messages may fail to be sent during an upgrade. In this case, we recommend that you configure the message retry feature on the client and resend the messages. Messages that were successfully sent are not lost after the upgrade.
  • During an upgrade, services are not interrupted, but messages may be distributed to another partition for consumption. An upgrade typically takes about 30 minutes. The larger the increase in disk capacity is, the longer the upgrade takes. We recommend that you assess the impact on your business and upgrade instance configurations during off-peak hours.

Scenarios and risks

Scenario Risk
You want to increase the disk capacity for your instance because the current disk usage is high and may soon affect your business. Brokers in the cluster restart one by one.
You want to increase the traffic specification of your instance because the current business traffic has exceeded the purchased specification many times. Brokers in the cluster restart one by one.
You want to upgrade your instance from Standard Edition to Professional Edition (High Write) or Professional Edition (High Read). Brokers in the cluster restart one by one.
You want to switch the network type of your Message Queue for Apache Kafka instance from VPC to Internet and VPC because your instance needs to access resources on the Internet. Brokers in the cluster restart one by one.
You want to switch the network type of your Message Queue for Apache Kafka instance from Internet and VPC to VPC because your instance does not need to access resources on the Internet. Brokers in the cluster restart one by one.
You want to change the number of partitions or topics for your instance.
Note You can change both the numbers of partitions and topics for instances purchased before August 26, 2022, and only the number of partitions for instances purchased on and after August 26, 2022.
None.
You want to change the Internet bandwidth for your instance. None.

Procedure

  1. Log on to the Message Queue for Apache Kafka console. In the Resource Distribution section of the Overview page, click the name of the region where your instance is deployed.
  2. On the Instances page, click the name of the instance that you want to manage.
  3. On the Instance Details page, click Upgrade in the upper-right corner of the Overview section.
  4. In the Instance upgrade risks dialog box, read the notes on the Instance upgrade risks, and then click OK.
  5. On the configuration changing page that appears, change the specifications.
    Table 1.
    Parameter Description
    Instance Edition
    • You can upgrade an instance from Standard Edition to Professional Edition.
    • You can upgrade the traffic specification of a Professional Edition instance.
    • You cannot downgrade an instance from Professional Edition to Standard Edition.

    For more information about the billing of Message Queue for Apache Kafka instances of different editions, see Billing overview.

    Network Type
    • You can switch the network type of an instance from VPC to Internet and VPC.
    • You can switch the network type of an instance from Internet and VPC to VPC.
    Public Traffic Internet traffic is divided into read traffic and write traffic. The maximum read traffic and maximum write traffic provided by Message Queue for Apache Kafka are the same. Select a bandwidth that meets the requirements of your peak read or write traffic. You are charged for the use of Internet traffic only if your instance is of the Internet and VPC type.
    Note To prevent traffic throttling caused by insufficient bandwidth, Message Queue for Apache Kafka estimates the optimal bandwidth based on the instance type you selected. You can purchase the Internet traffic that meets your business requirements as prompted on the buy page.
    Traffic Specification When you upgrade the traffic specification of your instance, take note of the following items:
    • Edition
      • Standard Edition: You can select a traffic specification with a peak read or write rate of up to 120 MB/s. If you need a traffic specification that supports a peak read or write rate more than 120 MB/s, upgrade your instance to Professional Edition before you upgrade the traffic specification.
      • Professional Edition (High Write): You can select a traffic specification with a peak read or write rate up to 2,000 MB/s.
      • Professional Edition (High Read): You can select a traffic specification with a peak read rate up to 3,000 MB/s and a peak write rate up to 1,000 MB/s.
    • Disk type
      • Ultra Disk: If the peak traffic supported by the traffic specification that you want to select exceeds 120 MB/s, the corresponding cluster is scaled out. After the upgrade is complete, you must rebalance topic traffic. For more information, see Rebalance topic traffic.
      • SSD: If the peak traffic supported by the traffic specification that you want to select exceeds 300 MB/s, the corresponding cluster is scaled out. After the upgrade is complete, you must rebalance topic traffic. For more information, see Rebalance topic traffic.
    Disk Capacity The default recommended disk capacity varies with the traffic specification. The disk capacity is adjusted accordingly when you adjust the traffic specification. You can also adjust the disk capacity based on your business requirements.
    Partitions
    • Total number of partitions of an instance = Number of purchased partitions + Number of partitions provided free of charge within the instance specification.
    • Number of available topics = Total number of partitions.
    • Number of available consumer groups = 2 x Total number of partitions.
    Note Message Queue for Apache Kafka does not support separate upgrades of topics for instances purchased on and after August 26, 2022. For more information about the existing instances purchased based on the number of topics, see What are the number of topics, groups, and partitions if an existing instance is purchased based on topic specifications? .
  6. Read and agree to the terms of service by selecting the check box. Then, click Buy Now. The Congratulations, purchase successfully message appears. Click Close.
    Note After you upgrade the specifications of your instance, the time when your order takes effect appears on the upgrade order page.
    On the Instance Details page, the status of the instance changes to Upgrading. After the upgrade is complete, the new specifications appear.Status