Skip to Main Content

Experience AutoMQ

After completing the environment setup and related initialization, this document explains how to quickly create a Kafka instance and experience message sending and receiving.

Info

This document specifically refers to the AutoMQ product service provider, AutoMQ service provider, and AutoMQ, all of which refer to AutoMQ (Hangzhou) Technology Co., Ltd.

Prerequisites​

Before creating a Kafka instance, certain prerequisites must be met to ensure the environment installation is complete. If not, refer to the following steps:

Create an Instance​

To experience AutoMQ, you need to create an instance corresponding to an open-source Apache Kafka cluster. Users can create instances via the environment console's front-end interface, while the console backend manages the creation of underlying cloud resources and completes the instance software deployment on behalf of the user.

The steps are as follows:

  1. Visit the environment console address to enter the environment console.

  2. In the environment console, click the left navigation bar and select "Instances List".

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

Parameter
Value description
Instance Name
  • Description: Instance name is an alias used to distinguish instances. User-defined input.
  • Restriction: Refer to Restrictions▸.
Instance Remark
  • Description: Instance remark is a custom description used to distinguish the purpose of the instance, usually entered as the business scenario. User-defined input.
  • Restriction: Refer to Restrictions▸.
Availability Zone Information
  • Description: AutoMQ instances currently support single availability zone and three availability zone deployments. Please select the appropriate deployment type according to business characteristics.
  • Options:
    • Single availability zone: All Kafka cluster nodes are deployed in the user-specified single availability zone.
    • Three availability zones: All Kafka cluster nodes will be evenly distributed across the three user-specified availability zones.
Subnet Information
  • Description: AutoMQ instances currently support only one subnet setting per availability zone. If there is a requirement for multiple availability zones and subnets, please refer to Obtaining Services▸.
  • Options: The user-provided subnet should contain sufficient available IPs (recommended at least 100) to prevent the risk of instance expansion failure due to insufficient IPs in the future.
Compute Specification
  • Description: The compute specification represents the message sending and receiving throughput capacity of the current AutoMQ Kafka instance. It is evaluated based on the number of AKUs according to the product billing instructions. For more details, refer to Billing Instructions for BYOC▸.
  • Limitations: The maximum AKU limit for instance creation is restricted by the version. For more details, refer to Restrictions▸.
Storage Specification
  • Description: AutoMQ Kafka utilizes object storage as the message storage medium, thus there is no need to reserve storage capacity in advance. You will be charged based on actual message capacity used during operation.
  1. Click "Create Instance" and wait for the instance creation to complete.

Message Sending and Receiving Experience​

Once the instance creation is complete, create a Topic to begin simple message sending and receiving. The steps are as follows:

  1. Click on the Instance Details to enter the instance, then click on the Topics navigation bar on the left side.

  2. Click on Create New Topic, fill in the relevant parameters, and create the topic.

  1. Click on the topic name to enter the topic details, then click on the Produce Messages tab.

  2. Fill in the test message content, click on Send, and complete the feature experience.

Next Steps​

The current quick tutorial showcases only the basic operational steps from environment creation to instance creation. AutoMQ Kafka is fully compatible with Apache Kafka, so please refer to Apache Kafka documentation and relevant knowledge when using AutoMQ Kafka.

Tip

If there is no business need after the quick experience and testing ends, it is advisable to release the environment promptly to avoid unnecessary consumption of cloud resources that may incur costs.

Appendix: Accessing AutoMQ Across VPCs​

By default, AutoMQ instances provide domain name resolution and private network addresses through PrivateDNS within the VPC and can only serve the current VPC. If your application needs to access AutoMQ across VPCs, you must configure the network yourself, meeting the following criteria:

  • Condition 1: VPC Interconnectivity: Users can connect the VPC where AutoMQ resides and the VPC where the application resides through VPC Peering or other methods to access AutoMQ instances. Please refer to the cloud vendor's VPC documentation for configuring VPC Peering.

  • Condition Two: Private Zone Associated with Multiple VPCs: AutoMQ uses Private Zone for domain name resolution by default, which is limited to the current VPC. If cross-VPC domain name resolution is needed, the Private Zone used by AutoMQ must be additionally associated with the application’s VPC.

Configuration Instructions for Private Zone Associated with Multiple VPCs​

To configure the AWS Route53 product to achieve Zone association with multiple VPCs, follow these steps.

  1. Locate the Private Zone Id used by AutoMQ.

Copy the AutoMQ console instance access point address, remove the domain name prefix, and obtain the Private Zone. Go to the Route53 product console and search for the Zone.

Visit the Zone details page to view the copied Hosted Zone ID.

Scenario 1: Edit Hosted Zone, add this account's VPC.
  1. Scenario 1: Edit Hosted Zone, add this account's VPC.
Scenario 2: Use AWS CLI to add a cross-account VPC.
  1. Scenario 2: Use AWS CLI to add a cross-account VPC.

To add a cross-account VPC, you cannot complete this process through the console page; it must be done via AWS CLI or SDK.

Suppose AutoMQ is deployed in account A's vpc-a, and now you need to associate account B's vpc-b to use AutoMQ. The specific steps are as follows:

Log into AWS CLI using account A to create DNS association authorization.


aws route53 create-vpc-association-authorization --hosted-zone-id   XXXXX  --vpc VPCRegion=XXXX,VPCId=vpc-b

Parameter description:

  • hosted-zone-id: enter the Zone ID of the Zone used by AutoMQ in account A.

  • vpc: Provide the VPC information for account B, which must be encoded in the format "VPCRegion=XXXX,VPCId=XXXX".

After pressing enter, detailed information will be output. Type ":wq" to submit the command.

Log in to AWS CLI using account B, and create a DNS association request.


aws route53 associate-vpc-with-hosted-zone --hosted-zone-id  XXXX  --vpc VPCRegion=xxx,VPCId=vpc-b

Parameter description:

  • hosted-zone-id: Enter the Zone ID of the AutoMQ zone used by account A.

  • vpc: Fill in the VPC information for account B. It must be formatted as "VPCRegion=XXXX,VPCId=XXXX".

After pressing enter, detailed information will be displayed. Enter ":wq" to submit the command, and you can view the console login for account A to confirm the addition has been completed.

Tip

Adding a new VPC to the Route 53 Zone requires 3-5 minutes to take effect. Once effective, the application's VPC will be able to resolve the AutoMQ domain name.