Skip to Main Content

Install Env Via Terraform Module

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

In this article, any mention of AutoMQ Product Services, AutoMQ Services, or AutoMQ specifically refers to AutoMQ HK Limited and its subsidiaries.

Prerequisites: 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 options are supported:

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

  • Provided VPC Installation Environment: Terraform Modules do not proactively create VPC networks; users need to specify an existing VPC network.

If you choose Provided VPC Installation Environment, it is recommended to create a VPC with at least 3 availability zones. Otherwise, it will not be possible to create a three-availability-zone instance later.

Operation Procedure​

Step 1: Invoke the AutoMQ Terraform Module Installation Environment​

  1. Install the Terraform CLI tool in your local environment; after installation, confirm that you can output the version.
  1. Install gcloud and configure a Google Cloud account.

   gcloud auth application-default login

  1. Refer to the AutoMQ GCP Terraform Moduledocumentation, install the module, and follow the example code to install the BYOC environment.
  1. Access the environment console, log in using the initial username and password output by Terraform, and change to a custom password.

Step 2: Create a GKE Cluster and Configure the Environment​

On Google Cloud, AutoMQ currently supports deploying the data plane cluster only on the GKE platform. Therefore, after installing the environment console, you will still need to prepare the GKE cluster and configure it in the environment console to use it.

For preparing GKE clusters, node pools, and other configurations, please refer to Deploy to Google Cloud GKE▸.

Step 3: Complete BYOC Environment Operations Authorization​

The BYOC environment is deployed in the user's VPC, providing data security and privacy isolation. However, the BYOC environment will generate system logs, metrics, and other non-business system data. After the environment installation is complete, users need to refer to Manage Environment Ops Authing▸ to provide corresponding operations authorization to the AutoMQ service provider, facilitating system stability monitoring and self-healing operations.

Subsequent Steps​

After 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 more details on using AutoMQ via Terraform, please refer to the documentation.

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

Appendix​