Skip to Main Content

Deploy to Tencent Cloud TKE

Referencing Overview▸, AutoMQ supports deployment on Kubernetes. This article outlines the installation process for deploying AutoMQ on the Tencent Cloud TKE platform.

Info

In this article, references to AutoMQ product service provider, AutoMQ service provider, and AutoMQ specifically refer to AutoMQ HK Limited and its affiliates.

Operating Procedures​

Step 1: Install the Environment Console​

Referencing Overview▸, AutoMQ supports deployment on TKE clusters. In the TKE deployment mode, first, you need to install the AutoMQ console, and then deploy the cluster to TKE through operations in the console interface.

Tencent Cloud supports installation environments via the application control console. Refer to Install Env via Tencent Marketplace▸.

After the AutoMQ console is installed, you need to obtain the environment console address, initial username, and password from the console interface.

Tip

Note:

Deploying the AutoMQ data plane cluster requires pulling Docker images and Helm Chart artifacts from a public network. Therefore, the VPC environment needs to support public access via SNAT or other methods. For instructions on configuring public SNAT, please refer to the appendix in this document Install Env via Tencent Marketplace▸.

Step 2: Create a CAM Role​

AutoMQ data plane clusters require a separate node pool, which needs to bind an independent CAM role for access to cloud resource permissions verification. Therefore, before creating the TKE cluster, you need to go to the CAM console to create a custom role. The steps are as follows:

  1. Go to the CAM Console, click on roles, Create role, select Tencent Cloud Product Service.
  1. Select the product service Cloud Virtual Machine (CVM).
  1. Enter a custom role name, click complete, and create the custom role. Record the role name, as it will be needed in step 4 when configuring the TKE dedicated node pool with the role name.

Step 3: Create TKE Cluster​

Referencing Overview▸, users need to create an independent TKE cluster allocated for AutoMQ in advance. Users can follow the steps below on the Tencent Cloud TKE product console.

  1. Log in to the Tencent Cloud TKE Console. Click Create Cluster.
  1. Select the cluster type as Standard Cluster.
  1. Fill in the basic configuration. Pay attention to the cluster specifications and other information. It is recommended to select at least L20 and enable automatic scaling. Keep other parameters at their default values.
Info

It is recommended to select at least L20 to manage around 20 nodes and enable automatic scaling. This prevents issues with TKE capacity limitations affecting scaling operations.

  1. Fill in network configuration. Select the correct VPC, choose the recommended VPC-CNI as the network plugin, and select the container subnets for all required availability zones.
  1. Click Next, disable non-essential Prometheus plugins, and complete the creation.

Step 4: Create TKE Public Node Pool​

Refer to Overview▸, users need to create a public node pool for the TKE cluster to deploy TKE system components. Follow these steps to create a compliant node pool.

  1. Go to the details of the TKE cluster created in step 2, click on the Nodes menu, and select Create Node Pool.
  1. Choose the General Node Pool type, refer to the documentation below to set custom parameters and complete the node pool creation. For parameters not specified in the table, please follow the default recommended values.
Set Parameter
Value Description
Node Pool Name
  • Description: Fill in a distinct name based on business semantics.
Instance Configuration
  • Note: It is recommended to select at least 2c4G instance types for deploying TKE system components.
Initial Number of Nodes
  • Note: Depending on the scale of the TKE cluster, it is recommended to select at least 2-3 nodes.

Step 5: Create a Dedicated AutoMQ TKE Node Pool​

Refer to Overview▸, users need to create a dedicated node pool for AutoMQ to apply for machine instances. Follow these steps to create a compliant node pool and complete the delegation authorization.

  1. Go to the details of the TKE cluster created in step 2, click on the Nodes menu, and select Create Node Pool.
  1. Choose the General Node Pool type, refer to the documentation below to set custom parameters and complete the node pool creation. For parameters not specified in the table, please follow the default recommended values.
Tip

When creating a node pool, only single availability zone or three availability zones are supported. If other numbers of availability zones are selected, instances cannot be created later.

Set Parameter
Value Description
Node Pool Name
  • Description: Fill in a distinct name based on business semantics.
Instance Configuration
  • Description: Specify the instance type for the node pool, please refer to the Overview▸. Fill in the instance type.
Danger

Note: AutoMQ must run on the specified instance type VM. If a non-preset instance type is selected during node pool creation, the subsequent usage of that node pool will be unavailable.

Supported Subnet
  • Description: Select one or three availability zone subnets based on the actual needs of the AutoMQ cluster.
Danger

Note:
AutoMQ requires the availability zone and node pool created subsequently to be completely consistent. Therefore, if you need to create a single availability zone AutoMQ cluster, create a single availability zone node pool here; if you need to create a three availability zone AutoMQ cluster, create a three availability zone node pool here. The two cannot be mixed.

CAM Role
  • Description: The AutoMQ cluster needs to access COS, network, and other cloud services, so the node pool requires authorized access to perform these operations. Provide the CAM role created in Step 2.
Taints
  • Note: To prevent other workloads within the Kubernetes cluster from occupying resources of the exclusive AutoMQ nodes, a taint needs to be applied to the AutoMQ dedicated node pool.
  • The key of the taint is dedicated, the value is automq, and the effect is NO_SCHEDULE.
  1. Node Startup Configuration: Select one or three subnets, with an initial quantity of 1.
  1. Fill in the Operations Settings: Enable elastic scaling, set the number of nodes to at least 1, and adjust the elastic upper limit to match the TKE cluster specifications and the anticipated scale of machines to deploy AutoMQ. For instance creation strategy, choose multi-zone distribution.

Step 5: Bind CAM roles to the node pool using information from output parameters after installing the console. Then click to create the node pool and add the exclusive taint for AutoMQ. The key of the taint is dedicated, the value is automq, and the effect is NO_SCHEDULE.

Step 6: Enter the Environment Console and Create the Deployment Configuration​

When first entering the AutoMQ BYOC Console, you need to create a deployment configuration to set up information for the Kubernetes cluster and OBS Bucket, among other details, before you can create an instance.

  1. Copy the Cluster ID of the TKE cluster created in Step 2.
  1. Locate the APIServer configuration menu and obtain the Kubeconfig configuration file.

  1. Log in to the console, enter the cluster ID and Kubeconfig configuration, and click Next.

    1. Cloud Account ID: Enter the main account ID of the current cloud account, which can be viewed in the Tencent Cloud console.

    2. Deployment type: Choose Kubernetes.

    3. Kubernetes cluster: Enter the cluster ID of the TKE cluster.

    4. Kubeconfig: Enter the content copied in the previous step.

    5. DNS ZoneId: Enter the ZoneId of the Private DNS used for deploying AutoMQ.

    6. Bucket name: Enter the data bucket used to store messages for AutoMQ deployment. Multiple COS Buckets are supported.

  1. After providing the cloud resource information, generate the permissions required to authorize the TKE node pool for the data plane. Refer to the console guide to create a custom authorization policy. Then bind the authorization policy to the AutoMQ CAM role created in Step 2, and enter the node pool role name. Click Next to Preview.
  1. Preview the deployment configuration information and complete the creation. You can then go to the instance management page to create an instance.