Skip to Main Content

Install Env Via Terraform Module

Refer to Overview▸, using AutoMQ Cloud requires installing the environment first. This article explains how to use the Terraform Module to install a BYOC environment.

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

Prerequisites​

Condition One: Cloud Account Operation Permissions​

To create a BYOC environment, you need to provide the credentials of a cloud account with sufficient permissions. The cloud account must be either the primary account or an IAM sub-account that has been granted the necessary permissions. If you are using the credentials of an IAM sub-account, you must grant the necessary permissions before proceeding with the service activation.

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

  • AmazonVPCFullAccess: Full access to manage the VPC.

  • AmazonEC2FullAccess: Full access to manage EC2 products.

  • AmazonS3FullAccess: Full access to manage S3 object storage.

  • AmazonRoute53FullAccess: Full access to manage Route 53 services.

Condition Two: Prepare VPC​

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

  • Automatically create a new VPC installation environment: Selecting this option will have Terraform Modules automatically create the VPC and other resources without manual configuration by the user. This is recommended for initial POCs and testing.

  • User-provided VPC installation environment: Terraform Modules will not proactively create the VPC network; instead, the user specifies an existing VPC network.

If you choose User-provided VPC installation environment, you must refer to Prepare VPC▸ to prepare the VPC network and ensure it meets AutoMQ's requirements. Otherwise, the installation will fail.

Procedure​

Go to AWS Marketplace to Activate the AutoMQ Service​

The AutoMQ Cloud BYOC environment installation image is distributed via AWS Marketplace. Users need to subscribe to AutoMQ from the Marketplace. The product link is AutoMQ for Kafka (BYOC AMI for Terraform).

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

Click Start Subscription and agree to the user agreement to complete the service activation.

Invoke AutoMQ Terraform Module to Install the Environment​

After enabling the AutoMQ service, you can integrate the AutoMQ Terraform Module to install and deploy the environment.

  1. Initialize the AWS CLI and Terraform runtime environment to ensure that AWS and Terraform services can be invoked.

  2. Access the AutoMQ Terraform Modules repository, obtain the module dependencies, and refer to the corresponding README documentation to execute the creation operations.

Next Steps​

After setting up the environment, you can access and use it. AutoMQ supports the following two methods:

  • Using AutoMQ via Terraform: Once the environment setup is complete, users can manage and use AutoMQ through the AutoMQ Terraform Provider. For instructions on using AutoMQ via Terraform, please refer to the documentation.

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