Skip to Main Content

Install Env from Marketplace

Refer to Overview▸, you need to set up the environment before using AutoMQ Cloud. This document explains how to install the BYOC environment from the AWS Marketplace.

Info

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

Prerequisites​

Condition 1: Cloud Account Operation Permissions​

To create a BYOC environment, the operating cloud account must be the primary account or an IAM sub-account with the necessary operation permissions. If you are currently using an IAM sub-account on the AWS console, authorization must be granted before proceeding with service activation.

Typically, you can grant the following AWS managed policies to an IAM sub-account to proceed with subsequent deployment and installation:

  • AmazonVPCFullAccess: Permissions to manage Virtual Private Cloud (VPC).

  • AmazonEC2FullAccess: Full access to manage EC2 products.

  • AmazonS3FullAccess: Full access to manage object storage S3.

  • AmazonRoute53FullAccess: Full access to manage the Route 53 service.

  • IAMFullAccess: Permissions to manage AWS IAM authorization policies and roles.

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 from AWS Marketplace, the following two methods are supported:

  • Automatically create a new VPC installation environment: Select this option to have Marketplace CloudFormation automatically create the VPC and other resources, eliminating the need for manual configuration. This is recommended for initial POCs and testing.

  • VPC Environment Provided by User: Marketplace will not proactively create a VPC network; users must specify an existing VPC network.

Tip

If you choose Install Environment with User-Provided VPC, you must refer to Prepare VPC▸ to prepare the VPC network to meet AutoMQ’s requirements. Failure to do so may result in installation failure.

Step 2: Subscribe to AutoMQ from the Marketplace​

The AutoMQ Cloud BYOC environment installation package is distributed on AWS through the Marketplace CloudFormation product. Users can subscribe to AutoMQ from the Marketplace, and the product link is AutoMQ for Kafka (BYOC Console).

Go to the AWS Marketplace and visit the product page AutoMQ for Kafka (BYOC Console).

Click Continue to Subscribe. On your first visit, please click to confirm the user agreement.

Click Continue to Subscribe. If this is your first visit, please confirm the user agreement.

Select the CloudFormation Template configuration, and fill out the form as prompted.

Step 3: Install the Environment Using the CloudFormation Template​

In the previous step, after selecting the CloudFormation Template configuration, you will be redirected to the CloudFormation product page to create a new Stack.

Parameter Settings
Value Description
Stack Name
  • Description: The name of the current CloudFormation Stack.
  • Constraint: This name will be used for naming resource variables. It is recommended to use only uppercase and lowercase letters and numbers.
ExistingVPCId
  • Description: Specifies the target VPC Id for the environment deployment. If left empty, a new VPC will be created automatically.
ExistingPublicSubnetId
  • Description: Specify the target subnet Id for environment deployment. When setting ExistingVPCId, this parameter must be set for using an existing VPC.
ExistingPubliceSubnetAvailabilityZone
  • Description: Specifies the availability zone of the target subnet for the environment deployment. This parameter must be set when ExistingPublicSubnetId is used, i.e., when using an existing subnet.
MsgBucket
  • Description: Set the name of the S3 Bucket for messages. This Bucket is used to store Kafka message data.
  • If not set, a new Bucket will be automatically created.
OpsBucket
  • Description: Set the operations S3 Bucket name. This Bucket is used to store AutoMQ's system logs, metrics, etc., and does not contain application data.
  • If not set, a new Bucket will be created automatically.
WebConsoleInstanceType
  • Description: Set the EC2 instance type for deploying the AutoMQ BYOC environment console.
  • Limitation: It is recommended to choose a model with at least 2 cores and 8GB of memory.
SecurityGroupCIDR
  • Description: Set the CIDR for the security group that can access the AutoMQ environment console.
KeyName
  • Description: Set the KeyName for the login certificate of the EC2 instance where the AutoMQ environment console is located.
  • If not set, no EC2 Key will be created, and subsequent SSH login to the EC2 instance will not be possible.

Step 4: Retrieve CloudFormation Output and Access Environment​

After completing the previous installation, check the current CloudFormation Outputs to retrieve initial information for accessing the environment.

Output Returns
Output Description
AutoMQWebConsoleURL
  • The 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.
DefaultUserName
  • The initial username for the environment console.
DefaultPassword
  • The initial password for the environment console. Users must change it immediately after the first login.
IAMRoleforAutoMQEnvironmentConsole
  • The IAM Role bound to the AutoMQ BYOC environment console allows the AutoMQ console to access AWS cloud resources.

Step 5: Complete BYOC Environment Operations Authorization​

The BYOC environment is deployed in the user's VPC, providing data security and privacy isolation benefits. However, the BYOC environment will generate system logs, metrics, and other non-business system data. Once the environment installation is complete, users need to refer to Overview▸ to grant operational maintenance permissions to AutoMQ service providers. This allows for system stability monitoring and fault recovery operations by AutoMQ service providers.

Next Steps​

  • Configure EKS (Optional, required when deploying the AutoMQ data plane to EKS): After installing the BYOC environment console, if you intend to deploy the AutoMQ data plane cluster to EKS, you need to first prepare the EKS cluster post-environment setup and then configure it in the AutoMQ console to deploy the AutoMQ cluster to EKS. For documentation on preparing EKS and completing subsequent deployment, please refer to Deploy to AWS EKS▸.

  • Using AutoMQ via WebUI: Access the console address returned in step 3 through a web browser, enter the initial username and password to access the environment console, create an instance, and experience the product features. Experience AutoMQ▸

  • Using AutoMQ with Terraform:

Uninstall Process​

Step 1: Delete AutoMQ Instance Via AutoMQ Console​

In the AutoMQ console, delete all created clusters.

Danger

Before deleting the entire AutoMQ environment, you need to delete the AutoMQ instances. CloudFormation does not recognize the cloud resources of AutoMQ instances, so if you skip the first step and directly delete through CloudFormation, it will only delete the AutoMQ Console, leading to the retention of AutoMQ instance cloud resources.

Step 2: Delete the AutoMQ Environment Console Via CloudFormation​

Find the stack created in the AWS CloudFormation service console and delete it. Once the stack is deleted, the AutoMQ environment console will be completely removed.

Appendix​

  • See the list of installed cloud resources and instructions at Cloud Resource List▸.

  • The overall deployment architecture diagram of AutoMQ on AWS is as follows:

Info

AutoMQ uses Amazon Linux 2 AMI system images to ensure a secure and reliable operating system.