Install Env Via Huawei Marketplace

Refer to Overview▸, using AutoMQ Cloud requires setting up the environment first. This article explains how to install the BYOC environment from the Huawei Cloud Marketplace.

In this article, references to AutoMQ Product Services, AutoMQ Services, and AutoMQ specifically refer to AutoMQ HK Limited and its affiliates.

Procedure

Step 1: Prepare VPC

The AutoMQ BYOC environment is deployed within the user's VPC to ensure data privacy and security. When installing the AutoMQ environment via the Cloud Marketplace, the following two methods are supported:

• Automatically create a new VPC installation environment: Selecting this option allows the installer to automatically create the VPC and other resources without manual configuration, recommended for initial POC and testing.

• User-Provided VPC Installation Environment: The installer will not proactively create a VPC network. Users must specify the existing VPC network and subnet information.

If you choose User-provided VPC Installation Environment, the VPC must meet the following conditions:

Zone Requirements: Based on business needs, if you need to create a three-zone instance later, you must allocate at least three zones and subnets.

Subnet CIDR Requirements: AutoMQ data plane clusters deploy using user VPCs, consuming VPC subnet IPs. It is recommended to allocate a sufficient number of available IPs in each subnet (each subnet should have no less than 1,000 available IPs) to avoid deployment and scaling issues later.

Public Network Requirements: Deploying the AutoMQ data plane cluster requires pulling Docker images and Helm Chart artifacts from the public network. Therefore, the VPC environment needs to support public network access via SNAT or similar methods. For instructions on configuring public network SNAT, refer to the appendix of this document Install Env via Huawei Marketplace▸.

Step 2: Install AutoMQ from Huawei Cloud Marketplace

1. Access the AutoMQ product link. The AutoMQ Cloud BYOC environment is distributed by default through the cloud marketplace product on Huawei Cloud. Users can subscribe to AutoMQ from the cloud marketplace, and the product link is AutoMQ for Kafka BYOC version (console).

2. Select the desired target region, and click Buy Now.

Due to the configuration issues of the marketplace product template, the Instance Configuration and Purchase Method parameters on the product page do not need attention and can be set to their default values.

Instance Type: The instance type for deploying the AutoMQ environment console can be customized in the next step deployment template.

Paid Type: Currently, only pay-as-you-go hourly billing is supported. Monthly billing is not supported at this time.

3. Follow the instructions to agree to the user agreement and authorization, then click use configuration template to activate.

4. Follow the instructions to fill in the installation template parameters. Generate the deployment plan. The parameters that need to be set are detailed in the table below.

Parameter Settings	Value Description
Environment ID	Description: The prefix for the naming of the current RFS stack and its internal resources. Restriction: This name will be used for naming resource variables. It is recommended to use only uppercase and lowercase letters and numbers.
Create New VPC	Description: Specifies whether to create a new VPC for deploying AutoMQ. It is recommended to use a new VPC for POC scenarios and to use the application's VPC for production scenarios. Default value: true
VPC ID	Description: Specifies the target VPC ID for environment deployment. This needs to be set only if Create New VPC parameter is set to false.
Public Subnet ID	Description: Specifies the target subnet ID for environment deployment. This parameter must be set only if the VPC ID parameter is set, meaning when using an existing VPC.
Console CIDR	Description: Set the source CIDR for the security group that accesses the AutoMQ environment console. Default value: 0.0.0.0/0, allowing access from all addresses.
Data OBS Bucket	Description: Set the name of the OBS bucket for storing messages. This bucket is used to store Kafka message data. If not set, a new OBS bucket will be automatically created.
Maintenance OBS Bucket	Description: Set the name of the OBS bucket for maintenance data. This OBS bucket is used to store AutoMQ's system logs, metrics, etc., excluding application data. If not set, a new OBS bucket will be automatically created.
ECS Instance Type	Description: Set the ECS instance type for deploying the AutoMQ BYOC environment console. Limit: It is recommended to choose at least a 2-core, 8GB model.
Cluster Deployment Type	Description: Specify whether the subsequent AutoMQ data cluster will be installed on Kubernetes or VMs. Options: vm: Selecting this option will default to installing the AutoMQ cluster on ECS. k8s: Selecting this option requires configuring a CCE cluster as described in Deploy to HuaWei Cloud CCE▸. The AutoMQ cluster will be installed on the user-provided CCE. Note: If you choose vm mode, you can create an AutoMQ instance (cluster) immediately after setting up the environment; if you choose k8s mode, you need to configure the CCE cluster first, then you can create an AutoMQ instance (cluster).

It is recommended to preview the parameters configured in the previous step and confirm their correctness before creating the execution plan.

5. After generating the execution plan, click Deploy Now.

6. Enter the Environment Console, log in using the initial username and password output by the RFS console, and change it to a custom password.

Note: When copying and pasting output variables from the Huawei Cloud RFS console using the mouse, it is recommended to paste them into a text editor first to avoid hidden characters that might lead to incorrect password input.

Complete RFS console output information is shown in the table below.

Output	Description of Output
automq_byoc_endpoint	URL address of the AutoMQ BYOC environment console. Users can access this address via a browser, or use APIs and Terraform to access the service.
automq_byoc_initial_username	Initial username for the environment console.
automq_byoc_initial_password	Initial password for the environment console. Users must change it immediately upon first login.
automq_byoc_env_id	Environment ID corresponding to the environment console.
automq_byoc_vpc_id	The VPC where the environment console is located.
automq_byoc_agency_name	The name of the permission delegation bound to AutoMQ. The AutoMQ cluster will use this delegated permission to access cloud resources. When configuring the CCE node pool later, you will need to enter this delegation name. For details, refer to Deploy to HuaWei Cloud CCE▸.
automq_byoc_instance_id	The ECS instance ID where the environment console is located.

Step 3: Complete BYOC Environment Operations Authorization

The BYOC environment is deployed in the user's VPC, ensuring data security and privacy isolation. However, system logs, metrics, and other non-business-related system data will be generated within the BYOC environment. After the environment installation is complete, users need to refer to Manage Environment Ops Authing▸ to provide the necessary operations authorization to the AutoMQ service provider. This facilitates system stability monitoring and self-healing operations by the AutoMQ service provider.

Next Steps

Once the environment installation is complete, you can access and use the environment through the following methods supported by AutoMQ:

• Using AutoMQ with Terraform: After the environment installation is complete, users can manage and use AutoMQ through the AutoMQ Terraform Provider. For details on using AutoMQ with Terraform, please refer to the documentation.

• Using AutoMQ via WebUI: Access the console address returned by your browser, enter the initial username and password, and you can enter the environment console to create an instance and experience product features. Experience AutoMQ for Kafka▸

Note:

If you select the k8s mode during the installation environment, you will also need to configure the CCE cluster before you can create an AutoMQ instance (cluster). For configuring the CCE cluster, please refer to Deploy to Huawei Cloud CCE▸.

Appendix

VPC Adding Public SNAT Operation Instructions

The deployment chart and Docker image repository of AutoMQ in Kubernetes are public addresses. Therefore, when pulling images in the Tencent Cloud TKE cluster, ensure that the current VPC subnet has the capability to access public addresses.

It is generally recommended to configure a public NAT gateway to achieve outbound internet access. Refer to the following steps for operation instructions:

1. Create a NAT Gateway, go to the NAT Console to create a public NAT gateway.

When creating the VPC gateway, choose the small specification, and ensure that the region and VPC are consistent with the VPC you will use subsequently.

2. Go to the NAT gateway, Create SNAT Rules, and associate the subnets that need access to the internet.

Fill in the list of subnets that need to access the Public Cloud and complete the SNAT rule creation.

Note:

Each subnet that needs to access the Public Cloud must have an SNAT rule added.