Skip to content

Deployment Prerequisites

Before deploying EMQX Cloud Bring Your Own Cloud (BYOC), make sure to complete the following preparations:

  • Familiarize yourself with the basic concepts of public cloud services and network structures, such as VPC, subnet, ECS, etc.
  • Have a public cloud account and an EMQX Cloud account.
  • Prepare relevant cloud resources and cloud account permissions.
  • Set up the deployment bootstrap environment.
  • Prepare a domain name and the corresponding TLS/SSL certificate for EMQX service.
  • Prepare an EMQX Cloud BYOC license.

Account Preparation

The EMQX Cloud BYOC deployment will be created in your cloud account. If you do not have a corresponding public cloud account, you can create an account according to the official documentation of the cloud platform you preferred, for example:

Currently, BYOC supports the following public clouds and regions. If you need support from other cloud service providers or regions, you can submit a ticket or send an email to contact us.

Cloud ProviderRegion
AWSUS: US East (N. Virginia), US East (Ohio), US West (N. California), US West (Oregon)
EU: EU (Ireland), EU (Frankfurt)
Aisa: Asia Pacific (Singapore), Asia Pacific (Mumbai), Asia Pacific (Hong Kong), Asia Pacific (Tokyo)
Google CloudUS: us-east1 (South Carolina), us-west1 (Oregon), us-central1 (Iowa)
EU: europe-west3 (Frankfurt), europe-north1 (Finland)
Asia: asia-south1 (Mumbai), asia-southeast1 (Singapore), asia-east1 (Taiwan)

In addition, you also need an EMQX Cloud account to complete the deployment. If you have not registered, please go to the EMQX Cloud account registration page to register an account.

Resources and Permissions

EMQX Cloud BYOC deployment requires you to create various cloud resources and services in your cloud account. Make sure that the relevant cloud account has reserved enough resources quota and completed the setting of relevant permissions.

Resource Quotas

The following table shows the cloud resources and services required for EMQX Cloud BYOC deployment. If the resources in the current account are insufficient, please contact the cloud account administrator to increase the relevant service quotas.

TIP

Your cloud administrator can quickly view the usage and quotas of resources and services in the cloud quota.

Notice

If you're using Google Cloud, it's important to verify the presence of the default network in your GCP account. If it's not already in place, please create it. During the deployment process, packer will be used as the system image packaging tool. This requires the creation of necessary resources for packaging within the default network of the Virtual Private Cloud (VPC).

If the default network cannot be created due to security policies, you can submit a ticket or send an email to contact us.

IAM Permissions

Your role needs to have the necessary Identity and Access Management (IAM) permissions to run commands to create the cloud resources in your cloud account. You need to ask your cloud administrator to assign sufficient permissions for creating BYOC deployments and generate the corresponding credentials.

Prepare the Startup Environment

To deploy EMQX Cloud BYOC, you need an Ubuntu 20.04 LTS (AMD64) environment that can be connected to the public network. Either of the following ways works:

  • (Recommended) Use the Ubuntu 20.04 LTS image to create a virtual machine instance in the cloud account. The memory of the instance must be more than 1 GiB.
  • Use a local Ubuntu 20.04 LTS environment.

Domain Name and Certificate

Prepare a domain name and TLS/SSL certificate for the EMQX service in advance. EMQX Cloud BYOC supports custom one-way TLS/SSL authentication and only supports specifying TLS/SSL certificates during the deployment.

WARNING

The certificate needs to be a CA-signed certificate. Please refer to the TLS/SSL Configuration for BYOC Plan for TLS/SSL certificate format requirements.

BYOC License

Prepare the EMQX Cloud BYOC license. You can contact sales to apply for a BYOC license. Our sales team will determine the license specifications based on the number of devices connected and the number of Pub&Sub transactions per second (TPS).