BYOC デプロイメントの作成

EMQX Cloud の Bring Your Own Cloud（BYOC）プランは、お客様自身のクラウドインフラストラクチャ上にデプロイメントを作成できるようにサポートしており、データをお客様の環境内に保持することを保証します。このデプロイメントにより、データのセキュリティと管理が向上し、データ漏洩などのリスクを回避できます。さらに、EMQX BYOC デプロイメントは、異なるシナリオのニーズに応じて、より良いパフォーマンスとスケーラビリティを提供できます。本ページでは、BYOC デプロイメントの作成と使用方法について説明します。

前提条件

BYOC デプロイメントを作成する前に、Console で BYOC 作成状況を確認してください。デプロイメント作成ページで BYOC を選択し、右側のボタンを確認します：Contact Us は承認が必要であることを示し、New Deployment はアカウントが承認済みであることを示します。

また、対応するパブリッククラウドのアカウント、クラウドリソースのプランニング、および EMQX BYOC 製品ライセンスの申請も準備してください。詳細は Deployment Prerequisites をご参照ください。

デプロイメントの作成

1. アカウントにログインし、EMQX Cloud Console にアクセスします。

2. プラットフォームを初めて使用する場合は、まずプロジェクトを作成する必要があります。詳細な手順は Create a Project をご参照ください。すでにプロジェクトを作成済みの場合は、このステップをスキップできます。

3. Console の Overview ページで New Deployment をクリックして直接作成プロセスを開始するか、デプロイメントを作成したいプロジェクトカードをクリックし、プロジェクトページで New Deployment をクリックして進めます。

4. Choose Plan で BYOC を選択します。

5. BYOC プランの設定をニーズに応じて構成します。

   

   クラウドプロバイダーとリージョンの設定：

   • Choose Cloud Platform：AWS または Google Cloud を選択します。

     他のクラウドプラットフォームにデプロイしたい場合は、チケット または メール でお問い合わせください。

   • Choose Region：デプロイするリージョンを選択します。

     他のリージョンにデプロイしたい場合は、チケット または メール でお問い合わせください。

   設定（EMQX クラスター用）：

   TIP

   最大セッション数は、申請した EMQX BYOC ライセンスに記載された数と一致している必要があります。デプロイ完了後にセッション数の上限を変更する場合は、チケット でお問い合わせください。

   • Sessions Limit：任意の時点で接続可能な MQTT デバイスの最大同時セッション数を指定します。

   • Pub&Sub TPS：送受信されるメッセージの最大トランザクション数（TPS）を指定します。

   • EMQX Node Instance Type：Sessions Limit と Pub&Sub TPS に基づいて自動選択されます。実際のビジネスニーズに応じてインスタンスタイプを変更可能です。

   • EMQX Node Quantity：Sessions Limit と Pub&Sub TPS に基づいて自動入力されます。実際のビジネスニーズに応じてノード数（2～5ノード）を変更可能です。

   • VPC CIDR Block：仮想プライベートクラウド（VPC）作成に使用するプライベートIPアドレス範囲を選択します。

   デプロイメント名とプロジェクト：

   • Deployment Name：ビジネス上の意味を持つデプロイメント名を入力します。
   • Project：適切なプロジェクトを選択します。デフォルトは最後にアクセスしたプロジェクトです。ページ上部のプロジェクト名をクリックして別のプロジェクトに切り替え可能です。デプロイ作成後はプロジェクトの変更はできません。

   タグ（任意）：リソース管理のためにクラウドリソースタグを最大10個まで追加可能です。

6. デプロイメント情報を確認後、右側のボタンを使用します：

   • Contact Us：BYOC 作成の承認がされていません。ボタンをクリックし、事前入力されたチケットウィンドウで Confirm をクリックしてください。承認後、このページに戻り BYOC デプロイメントの作成を続行します。
   • New Deployment：BYOC 作成が承認されています。ボタンをクリックして続行します。

7. 表示される BYOC Deployment Guide を確認し、Get Started をクリックします。

次に、Run Deployment セクションの手順に従ってデプロイメントを開始できます。

デプロイメントの実行

Deployment Overview ページで、デプロイメントのステータスが Waiting to be Deployed となっていることを確認してください。この時点では MQTT Connection Information にデプロイメントの詳細は表示されません。Deploy ボタンをクリックすると、Deployment Guide のサイドバーが表示され、デプロイメントの手順を案内します。以下の手順に従ってデプロイメントを完了することも可能です。

以下の手順は、パブリックネットワーク接続がある Ubuntu 20.04（AMD64）環境でのデプロイ完了方法を示しています。開始前に、TLS/SSL 証明書および BYOC ライセンスファイルをデプロイに必要なものとして Ubuntu 環境のディレクトリにコピーしてください。

1. 準備した Ubuntu 20.04（AMD64）環境を開きます。この Ubuntu 環境はインターネットにアクセス可能である必要があります。

2. Ubuntu のコマンドラインで、以下のコマンドを使用してツールキットをダウンロードし、Ubuntu のディレクトリに保存します。

   wget https://cloudassets.emqx.com/en/byoc-deployments/5.1.0/create-aws-byoc-deployment.tar.gz

3. 以下のコマンドでダウンロードしたツールキットを解凍し、解凍したフォルダのディレクトリに移動します。

   tar -zxf create-aws-byoc-deployment.tar.gz && cd create-aws-byoc-deployment

4. ./byoc create コマンドの各フィールドに実際のパラメータを入力します：

   ./byoc create \
         --platform aws \
         --accessKey <Your AccessKey> \
         --secretKey <Your SecretKey> \
         --domain <Your Domain> \
         --sslCertPath <Your Domain SSL Absolute Cert Path>  \
         --sslKeyPath <Your Domain SSL Absolute Key Path> \
         --clientCaPath <Your Client CA Absolute Path (Optional)> \
         --byocEndpoint https://cloud-intl.emqx.com \
         --byocKey abcdXXXXXXXXXX111

   • --accessKey：AWS IAM ユーザーのアクセスキーIDを入力します。
   • --secretKey：AWS IAM ユーザーのアクセスキーシークレットを入力します。
   • --domain：デプロイメント内の MQTT サービスのドメイン名（例：your.domain.com）を入力します。このドメインを通じてクライアントが MQTT サービスにアクセスします。
   • --sslCertPath：TLS/SSL 証明書の絶対パスを指定します。CA署名証明書のみ対応。SSL 証明書の形式要件は TLS/SSL Configuration for BYOC Plan を参照してください。注：BYOC はカスタムの片方向 TLS/SSL 認証を提供します。
   • --sslKeyPath：TLS/SSL 証明書キーの絶対パスを指定します。CA署名証明書のみ対応。SSL 証明書キーの形式要件は TLS/SSL Configuration for BYOC Plan を参照してください。
   • --clientCaPath：クライアント CA 証明書の絶対パスを指定します。指定すると作成されるデプロイメントは双方向 TLS/SSL 認証を使用します。不要な場合は実行時にこのパラメータを削除してください。双方向 TLS/SSL 認証の詳細は TLS/SSL Configuration for BYOC Plan を参照してください。

   以下の3つの値はコンソールでデプロイメントガイド生成時に自動入力されるため、変更しないでください。

   • --platform はクラウドプロバイダーを指定します。
   • --byocEndpoint は EMQX Cloud のアクセスアドレスです。
   • --byocKey は BYOC デプロイメントの認証キーです。生成された byocKey は1時間有効で、スクリプトコマンド生成後できるだけ早く実行してください。

5. ./byoc create コマンドを実行し、数分待ちます。システムから作成すべきクラウドリソースの確認を求められたら、yes と入力して続行します。

   Do you want to perform these actions?
     Terraform will perform the actions described above.
     Only 'yes' will be accepted to approve.
   
     Enter a value:

1. 準備した Ubuntu 20.04（AMD64）環境を開きます。この Ubuntu 環境はインターネットにアクセス可能である必要があります。

2. Ubuntu のコマンドラインで、以下のコマンドを使用してツールキットをダウンロードし、Ubuntu のディレクトリに保存します。

   wget https://cloudassets.emqx.com/en/byoc-deployments/5.1.0/create-gcp-byoc-deployment.tar.gz

3. 以下のコマンドでダウンロードしたツールキットを解凍し、解凍したフォルダのディレクトリに移動します。

   tar -zxf create-gcp-byoc-deployment.tar.gz && cd create-gcp-byoc-deployment

4. ./byoc create コマンドの各フィールドに実際のパラメータを入力します：

   ./byoc create \
         --platform gcp \
         --projectID <Your Project ID> \
         --authJSONPath <The absolute path of your Service Account JSON file> \
         --domain <Your Domain> \
         --sslCertPath <Your Domain SSL Absolute Cert Path>  \
         --sslKeyPath <Your Domain SSL Absolute Key Path> \
         --clientCaPath <Your Client CA Absolute Path (Optional)> \
         --byocEndpoint https://cloud-intl.emqx.com \
         --byocKey abcdXXXXXXXXXX111

   • --projectID：Google Cloud プロジェクトIDを入力します。Google Cloud Console の上部バーのプロジェクトセレクターで確認可能です。
   • --authJSONPath：Google Cloud サービスアカウントキー の JSON ファイルのパスを入力します。
   • --domain：デプロイメント内の MQTT サービスのドメイン名（例：your.domain.com）を入力します。このドメインを通じてクライアントが MQTT サービスにアクセスします。
   • --sslCertPath：TLS/SSL 証明書の絶対パスを指定します。CA署名証明書のみ対応。SSL 証明書の形式要件は TLS/SSL Configuration for BYOC Plan を参照してください。注：BYOC はカスタムの片方向 TLS/SSL 認証を提供します。
   • --sslKeyPath：TLS/SSL 証明書キーの絶対パスを指定します。CA署名証明書のみ対応。SSL 証明書キーの形式要件は TLS/SSL Configuration for BYOC Plan を参照してください。
   • --clientCaPath：クライアント CA 証明書の絶対パスを指定します。指定すると作成されるデプロイメントは双方向 TLS/SSL 認証を使用します。不要な場合は実行時にこのパラメータを削除してください。双方向 TLS/SSL 認証の詳細は TLS/SSL Configuration for BYOC Plan を参照してください。

   以下の3つの値はコンソールでデプロイメントガイド生成時に自動入力されるため、変更しないでください。

   • --platform はクラウドプロバイダーを指定します。
   • --byocEndpoint は EMQX Cloud のアクセスアドレスです。
   • --byocKey は BYOC デプロイメントの認証キーです。生成された byocKey は1時間有効で、スクリプトコマンド生成後できるだけ早く実行してください。

5. ./byoc create コマンドを実行し、数分待ちます。システムから作成すべきクラウドリソースの確認を求められたら、yes と入力して続行します。

   Do you want to perform these actions?
     Terraform will perform the actions described above.
     Only 'yes' will be accepted to approve.
   
     Enter a value:

DNS レコードの追加

デプロイメントリソースが作成されると、システムは以下の情報を返します。返された IP アドレスを基に、DNS サービスにドメイン名解決レコードを追加し、デプロイされたパブリックIPアドレスをお客様のドメイン名に紐付けます。DNS やドメイン名解決の基本概念については DNS Concepts をご参照ください。

Apply complete! Resources: 45 added, 0 changed, 0 destroyed.

Outputs:

cloud_register_data = <sensitive>
jwt_token = <sensitive>
lb_address = "<Your Deployment IP>"
password = "<EMQX Dashboard Password>"
username = "<EMQX Dashboard Username>"
vpc_id = "vpc-bp1n1dwiv2srgkgle4rlu"
*****************************
You need add a record to your DNS service provider.
IP address: 112.124.9.12
Domain: <Your Custom Domain>
*****************************
Checking if <Your Custom Domain> is resolved to the 112.124.9.12 of the load balancer

クラウドプラットフォームが提供する DNS 解決サービスや他の管理された DNS プロバイダーを利用可能です。例として Google Cloud Platform の Cloud DNS を使用する場合は、以下の手順を参考にしてください：Add, modify, and delete records | Cloud DNS | Google Cloud。

DNS レコードが有効になると、システムは HTTPS listener is ready を返します。

HTTPS listener is ready

デプロイメントの完了

ドメイン名解決が完了すると、Ubuntu のコマンドラインに以下の出力が表示され、デプロイメントが成功したことを示します。

Deployment successful! Here is the service information:
--------------------------------------------------------
EMQX service connection address: <Your Custom Doamin>
EMQX Dashboard address: https://<Your Custom Doamin>:18084
EMQX Dashboard username: <EMQX Dashboard Username>
EMQX Dashboard password: <EMQX Dashboard Password>
You can log in to the EMQX Cloud Console(https://cloud.emqx.com/console) to manage your deployment.
--------------------------------------------------------
Thank you for choosing our service. Happy IoT!

EMQX ダッシュボードのユーザー名とパスワードは管理コンソールへのログインおよびクラスター管理に使用するため、安全に保存してください。この情報は今後再表示されません。

デプロイメント情報の確認

デプロイメント概要ページに戻り、ページを更新するとリアルタイムのステータスや接続情報を取得できます。

リアルタイムステータス：

• Deployment Name：デプロイメント名。クラウドリソースのプレフィックスとしても使用されるため、パブリッククラウドコンソールでの迅速な検索に役立ちます。
• Instance Status：稼働状況と作成日時。
• Sessions：現在の接続数と最大許容数。
• Pub&Sub TPS：デプロイメント内の秒間送受信メッセージ数と TPS 制限。

接続情報：

• Address：デプロイ時にユーザーが指定したドメイン名。
• Connection Ports：デフォルトで MQTT プロトコルアクセス用に 1883（mqtt）、8883（mqtts）、8083（ws）、8084（wss）が開放されています。Dashboard ログイン用に 18084（https）、REST API アクセス用に 8443（https）が使用されます。

ポートのカスタマイズを希望される場合は、サポートチケット またはメール（cloud-support@emqx.io）でお問い合わせください。

ライセンス情報：

基本的なライセンス情報と有効期限を含みます。詳細は BYOC License をご参照ください。

高度なネットワーク設定

VPC ピアリング設定

仮想プライベートクラウド（VPC）ピアリングは、異なるネットワークにある2つの VPC 間で通信を可能にするネットワーク接続です。これはクラウドサービスプロバイダーが提供する機能で、BYOC がデプロイされた VPC と同一クラウドサービスプロバイダー内の他の VPC 間のピアリング接続をサポートします。VPC ピアリングの設定については、各パブリッククラウドのドキュメントを参照してください：Working with VPC Peering - Amazon Web Service および VPC Network Peering - Google Cloud。

NAT ゲートウェイ設定

パブリッククラウドプラットフォームが提供する NAT ゲートウェイはネットワークアドレス変換サービスを提供し、BYOC デプロイメントが VPC ピアリング接続なしでパブリックネットワークリソースにアクセスできるようにします。BYOC がデプロイされた VPC に NAT ゲートウェイを追加可能です。詳細は各パブリッククラウドの NAT ゲートウェイドキュメントを参照してください：NAT Gateways - Amazon Web Service および Cloud NAT - Google Cloud。

デプロイメントへの接続

任意の MQTT クライアントツールを使用してデプロイメントに接続し、テストできます。推奨ツールの一例として MQTTX があります。