Skip to main content

​
Overview

To use the AutoMQ Cloud BYOC environment on AWS, you first need to install the AutoMQ console. The console is a web application deployed in your account that you will use to create, manage, and monitor your AutoMQ clusters.

​
Prerequisites

Before you begin installing the AutoMQ console, please ensure that you have prepared the basic AWS cloud resources as required.
  • VPC Environment: The AutoMQ console and clusters need to run in your own VPC, typically the same VPC where your Kafka applications are deployed.

​
Steps

​
Step 1: Register Your Environment on the AutoMQ Website

First, you need to register your deployment environment on the AutoMQ official website to obtain the metadata for environment installation.
  1. Visit AutoMQ Cloud and log in to your account.
  2. On the console page, click Create Environment.
  3. Follow the wizard to enter the following information:
    • Environment Name: Set a custom name for your environment.
    • Description: Enter a description for the environment.
    • Cloud Provider: Select AWS.
    • Region: Select the AWS region where you plan to deploy AutoMQ.
  4. After creation, you will receive the environment metadata for deployment.

​
Step 2: Prepare an EC2 Instance for Deploying the Console

Next, you need to follow the installation wizard’s instructions to prepare an EC2 instance specifically for deploying the AutoMQ console.
  • EC2 Preparation Guide: Please strictly follow the documentation to prepare an EC2 instance that meets the specifications, network, and storage requirements.
Once the EC2 instance is ready, you can refer to the installation wizard, copy the installation command, and start the AutoMQ console.

​
Step 3: Configure Console Permissions and Complete Initialization

After the AutoMQ console starts successfully, you need to log in to the console. On your first visit, you will need to grant it the necessary permissions to operate AWS cloud resources.
  1. Log in to the Console
    • Access http://<Your EC2 Public IP>:8080 in your browser.
    • Log in with the initial username and password.
  2. Grant IAM Permissions to the Console After logging in, the interface will guide you to complete IAM authorization for the AutoMQ console. This is to allow the console to have permission to create and manage cluster resources in your AWS account. The process is as follows:
    1. Create an IAM Policy:
      • Go to the AWS IAM console and create a new customer-managed policy based on the policy JSON provided in the console interface.
    2. Create an IAM Role:
      • Create a new IAM Role.
      • When selecting the trusted entity, choose AWS service and EC2.
      • Attach the IAM Policy created in the previous step to this Role.
    3. Associate the IAM Role with the EC2 Instance:
      • Go to the AWS EC2 console and find the EC2 instance you are using to deploy the console.
      • In Actions -> Security -> Modify IAM role, associate the IAM Role created in the previous step with this instance.
  3. Complete Initialization
    • Return to the AutoMQ console page and click Confirm Authorization or Next.
    • The console will automatically verify if the permissions are configured correctly. Once verified, you can officially enter the AutoMQ console and start creating your first cluster.

​
Next Steps

  • Use AutoMQ via WebUI: Continue to create instances through the environment console and experience the product features. Experience AutoMQ▸
  • Use AutoMQ via Terraform: After installing the console, users can manage and use AutoMQ through the AutoMQ Terraform Provider. For using AutoMQ via Terraform, please refer to the documentation.