Install Env from Marketplace

Refer to Overview▸ for information on using AutoMQ Cloud; an environment setup is required. This article describes how to install a BYOC environment from the AWS Marketplace.

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.

Use AWS Managed Policies for Authorization

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.

If you choose to use a VPC provided by the user, you must refer to Prepare VPC▸ to prepare the VPC network, ensuring it meets AutoMQ requirements. Otherwise, the installation will fail.

Step 2: Subscribe to AutoMQ from the Marketplace

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

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

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.

Follow the prompts to fill in the parameters and continue configuring to start the creation process.

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.
Cluster Deployment Type	Description: Set up this environment to subsequently install the AutoMQ data cluster on either Kubernetes or VM. Available values: vm: With this option, the default installation of the AutoMQ cluster will be on EC2. k8s: With this option, follow the Deploy to AWS EKS▸ guidance to configure an EKS cluster. Subsequently, the AutoMQ cluster will be installed on the user-provided EKS. Note: If you select the vm mode, you can create the AutoMQ instance (cluster) immediately after setting up the environment. If you select the k8s mode, configure the EKS cluster first, then you can create the AutoMQ instance (cluster).

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 is used to authorize the AutoMQ console to query AWS EKS and other services.
IAMRoleforAutoMQDedicatedNodeGroup	The AutoMQ cluster needs to use a dedicated node group, and this role is bound to the dedicated node group to authorize AutoMQ components within the node group to access AWS S3 and other cloud services.

Step 5: Complete BYOC Environment Operations Authorization

Deploying a BYOC environment in the user's VPC ensures data security and privacy isolation. However, the BYOC environment will generate system logs, metrics, and other system data unrelated to business operations. After completing the environment installation, users need to refer to Manage Environment Ops Authing▸ to provide the necessary Ops authorization to the AutoMQ service provider, facilitating system stability monitoring and self-healing operations by the AutoMQ Team.

Next Steps

• Configure EKS (Required for EKS mode): If deploying AutoMQ to EKS when installing the BYOC environment, the user must first prepare the EKS cluster after completing the installation and then configure it in the AutoMQ console to deploy the AutoMQ cluster to EKS. For documentation on preparing EKS and completing subsequent deployments, refer to Deploy to AWS EKS▸.

• Use AutoMQ through WebUI: Access the console URL returned in step 3 via a web browser, enter the initial username and password, and you will be able to access the environment console to create instances and experience product features. Experience AutoMQ for Kafka▸

• Using AutoMQ with Terraform:

Appendix

• For the list of deployed cloud resources and explanations, see Cloud Resource List▸

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

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