Skip to Main Content

Install Env Via Terraform Module

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

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

Prerequisites​

Condition 1: Cloud Account Operation Permissions​

To create a BYOC environment, you need to provide the credentials of a cloud account with the necessary permissions and ensure that the cloud account is either the main account or an IAM sub-account that has been granted the relevant operation permissions. If you are currently using the credentials of an IAM sub-account, you need to authorize it before proceeding with the service activation.

You can usually grant the following AWS managed policies to the IAM sub-account to perform subsequent deployment and installation:

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

  • AmazonEC2FullAccess: Full permissions to manage EC2 products.

  • AmazonS3FullAccess: Full permissions to manage S3 object storage.

  • AmazonRoute53FullAccess: Full permissions to manage Route 53 services.

Condition Two: Prepare VPC​

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: When selecting this option, Terraform Modules automatically create the VPC and other resources without requiring manual configuration from the user. This is recommended for the first POC and testing.

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

If you choose user-provided VPC installation, you must follow the instructions in Prepare VPC▸ to prepare the VPC network and ensure it meets AutoMQ's requirements. Failure to do so may result in installation failure.

Operating Procedures​

Step 1: Invoke AutoMQ Terraform Module Installation Environment​

Before using the Terraform Module to install the BYOC environment, it is recommended to select (or upgrade to) the latest Module version per the documentation, and then integrate the AutoMQ Terraform Module for environment deployment.

  1. Initialize the AWS CLI and Terraform runtime environment to ensure you can invoke AWS and Terraform services.

  2. Access the AutoMQ Terraform Modules Repository to obtain the Modules dependencies, and refer to the corresponding README document to execute the creation operations.

Step 2: Complete BYOC Environment Operation Authorization​

The BYOC environment is deployed in the user's VPC, providing data security and privacy isolation. However, system logs, metrics, and other system data unrelated to business will be generated within the BYOC environment. After the environment is installed, users need to refer to Manage Environment Ops Authing▸ to grant the necessary operational authorization to the AutoMQ service provider. This facilitates system stability monitoring and self-healing operations by the AutoMQ service provider.

Next Steps​

Once the environment installation is complete, you can access and use the environment. AutoMQ supports the following two methods:

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

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

Appendix​