Skip to Main Content

Experience AutoMQ for Kafka

After you've set up the environment and completed all necessary initializations, this article will guide you through the process of quickly creating a Kafka instance for both sending and receiving messages.

Throughout this article, any references to AutoMQ, or its service providers, are specifically about "AutoMQ CO."

Prerequisites​

Before you can create a Kafka instance, you must meet certain prerequisites to ensure that the environment setup is complete. If not, please follow the outlined steps here:

Creating an Instance​

To begin using AutoMQ for Kafka, you first need to create an instance; each instance is linked to an open-source Apache Kafka® cluster. Users interact with the front-end interface of the environment console to create an instance, while the backend manages the creation of underlying cloud resources and completes the software deployment.

The procedure is as follows:

  1. Go to the environment console URL and log into the console.

  2. Access the Environment Control Console, click the left navigation bar, and navigate to the instance list.

  3. Click the "Create Instance" button and choose parameters according to the following specifications.

Parameter
Value Description
Instance Name
  • Description: The instance name is an alias used to distinguish between instances. Input is user-defined.
  • Limitation: Refer to Restrictions▸.
Instance Remarks
  • Description: Instance remarks are used to differentiate the purposes of instances with a custom description, typically inputting business scenarios. Input is user-defined.
  • Limitation: Refer to Restrictions▸.
Availability Zone Information
  • Description: AutoMQ for Kafka instances currently support both single and three availability zone deployments. Choose the appropriate form based on business characteristics.
  • Options:
    • Single Availability Zone: All nodes of the Kafka cluster are deployed within one availability zone specified by the user.
    • Three Availability Zones: Nodes of the Kafka cluster are evenly distributed across three specified availability zones.
Subnet Information
  • Description: AutoMQ for Kafka instances currently support setting up one subnet per availability zone. If there are demands for multiple availability zones and subnets, please refer to Obtaining Services▸.
  • Options: The subnet provided by the user should contain a sufficient number of available IPs (recommended at least 100) to prevent the risk of instance expansion failure due to insufficient IPs in the future.
Compute Specification
  • Description: Compute specifications represent the message sending and receiving throughput capacity of the current AutoMQ Kafka instance. Refer to the product pricing details, evaluated based on the number of AKUs. For more details, see Billing Instructions for BYOC▸.
  • Limitation: The maximum AKU count for instance creation is subject to version limitations, see Restrictions▸.
Storage Specifications
  • Description: AutoMQ Kafka uses object storage as the message storage medium, thus eliminating the need to reserve storage capacity in advance. Storage is utilized on-demand based on the actual message volume and is pay-per-use.
  1. Initiate the instance creation and wait for the completion of the setup.

Experience Message Sending and Receiving​

Once the instance is ready, before diving into basic message sending and receiving, you'll need to set up a Topic. Here’s how to proceed:

  1. Click on instance details, access the instance, and select the Topics tab on the left-hand navigation.

  2. Choose Create Topic, input the necessary parameters, and finalize the topic creation.

  1. Click on the topic name, go to the topic details, and select the Produce Message tab.

  2. Type in your test message and hit send to complete the test experience.

Subsequent Steps​

This quick-start guide outlines the fundamental steps from setting up the environment to creating an instance. AutoMQ Kafka is fully compatible with Apache Kafka®, so for practical applications, please consult the relevant Apache Kafka® documentation and resources.

If there are no ongoing business requirements after a brief exploration and testing, it is recommended to decommission the environment promptly to prevent unnecessary consumption of cloud resources and additional expenses.