# デプロイメントの開始、停止、および削除

このページでは、プラットフォームコンソールでの各種プランのデプロイメントの開始、停止、および削除方法について詳しく説明します。

## サーバーレスプラン

このセクションでは、サーバーレスプランのデプロイメントの開始、停止、および削除方法を紹介します。

### デプロイメントの開始と停止

コンソールで停止中のデプロイメントを開始するには、該当のデプロイメントをクリックしてデプロイメント概要ページに入り、右上の **Start** ボタンをクリックします。デプロイメントを停止するには、以下の手順に従ってください。

::: warning 注意

デプロイメントを停止すると、デバイスはデプロイメントに接続できなくなりますが、データおよび接続アドレスは保持されます。

:::

1. コンソールで停止したいデプロイメントをクリックし、デプロイメント概要ページに入ります。
2. 右上の **Stop** ボタンをクリックし、ポップアップボックスにデプロイメント名を入力します。
3. **Confirm** をクリックしてデプロイメントを停止します。

### デプロイメントの削除

::: warning 注意

デプロイメントを削除すると、デバイスはデプロイメントに接続できなくなり、デプロイメントのすべてのデータおよび設定が削除されます。

:::

1. コンソールで削除したいデプロイメントをクリックし、デプロイメント概要ページに入ります。
2. 右上の **Settings** ボタンをクリックし、ページ下部の **Delete Deployment** をクリックします。
3. ポップアップボックスにデプロイメント名を入力します。
4. **Confirm** をクリックしてデプロイメントを削除します。

## 専用プラン

このセクションでは、専用プランのデプロイメントの開始、停止、および削除方法を紹介します。

### デプロイメントの開始と停止

コンソールで停止中のデプロイメントを開始するには、該当のデプロイメントをクリックしてデプロイメント概要ページに入り、右上の **Start** ボタンをクリックします。

デプロイメントを停止するには、以下の手順に従ってください。停止する前に、デプロイメントが **Running** 状態であることを確認してください。

::: warning 注意

デプロイメントを停止すると接続できなくなりますが、データおよび接続アドレスは保持され、データ保持料金が発生します。

:::

1. コンソールで停止したいデプロイメントをクリックし、デプロイメント概要ページに入ります。
2. 右上の **Stop** ボタンをクリックし、ポップアップボックスにデプロイメント名を入力します。
3. **Confirm** をクリックしてデプロイメントを停止します。

### デプロイメントの削除

削除する前に、デプロイメントが **Running** 状態であることを確認してください。

::: warning 注意

デプロイメントを削除すると接続できなくなり、すべてのデータおよび設定が削除されます。デプロイメントの課金も停止されます。

:::

1. コンソールで削除したいデプロイメントをクリックし、デプロイメント概要ページに入ります。
2. 右上の **Settings** ボタンをクリックし、ページ下部の **Delete Deployment** ボタンをクリックします。
3. ポップアップボックスにデプロイメント名を入力します。
4. **Confirm** をクリックしてデプロイメントを削除します。

## BYOC

このセクションでは、BYOCデプロイメントの開始、停止、および削除方法を紹介します。

### デプロイメントの開始

::: tip 前提条件

デプロイメントの開始操作を行う前に、正しい [IAMポリシー定義](../deployments/byoc_prerequisite.md#iam-permissions) が設定されていることを確認してください。

:::

デプロイメントを開始するには、コンソールで開始したいデプロイメントをクリックしてデプロイメント概要ページに入り、右上の **Start** ボタンをクリックすると、以下のように **Start Deployment Guide** が表示されます。

![byoc_start_deployment](./_assets/byoc_aws_start.png)

クラウドプラットフォームごとの具体的な操作手順は以下の通りです。

:::: tabs
::: tab "AWS"

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

```bash
wget https://cloudassets.emqx.com/en/byoc-deployments/5.1.0/operate-byoc-deployment.tar.gz
```

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

```bash
tar -zxf operate-byoc-deployment.tar.gz && cd operate-byoc-deployment
```

3. 以下のコマンドの対応するパラメータの値を修正し、コマンドを実行して開始します。

```bash
./byoc start \
     --platform aws \
     --accessKey <Your AccessKey> \
     --secretKey <Your SecretKey> \
     --byocEndpoint https://cloud-intl.emqx.com \
     --byocKey 58825600h0eb010ee6xxxxx
```

- `--accessKey`: AWS IAMユーザーのアクセスキーIDを入力してください。
- `--secretKey`: AWS IAMユーザーのアクセスキーシークレットを入力してください。

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

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

コマンドラインに以下の内容が表示されたら、デプロイメントの開始に成功したことを示します。

```bash
Start the deployment successfully!
```

:::
::: tab "Google Cloud"

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

```bash
wget https://cloudassets.emqx.com/en/byoc-deployments/5.1.0/operate-byoc-deployment.tar.gz
```

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

```bash
tar -zxf operate-byoc-deployment.tar.gz && cd operate-byoc-deployment
```

3. 以下のコマンドの対応するパラメータの値を修正し、コマンドを実行して開始します。

```bash
./byoc start \
     --platform gcp \
     --projectID <Your Project ID> \
     --authJSONPath <The absolute path of your Service Account JSON file> \
     --byocEndpoint https://cloud-intl.emqx.com \
     --byocKey abcdXXXXXXXXXX111
```

- `--projectID`: Google CloudのプロジェクトIDを入力してください。Google Cloudコンソールの上部バーのプロジェクトセレクターで確認できます。
- `--authJSONPath`: [Google Cloudサービスアカウントキー](https://cloud.google.com/iam/docs/keys-create-delete#creating) のJSONファイルのパスを入力してください。

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

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

コマンドラインに以下の内容が表示されたら、デプロイメントの開始に成功したことを示します。

```bash
Start the deployment successfully!
```

:::
::::

### デプロイメントの停止

::: tip 前提条件

デプロイメントの停止操作を行う前に、正しい [IAMポリシー定義](../deployments/byoc_prerequisite.md#iam-permissions) が設定されていることを確認してください。

:::

::: warning 注意

デプロイメントを停止すると接続できなくなりますが、データおよび接続アドレスは保持されます。

:::

デプロイメントを停止するには、コンソールで停止したいデプロイメントをクリックしてデプロイメント概要ページに入り、右上の **Stop** ボタンをクリックすると、以下のように **Stop Deployment Guide** が表示されます。

![byoc_stop_deployment](./_assets/byoc_aws_stop.png)

クラウドプラットフォームごとの具体的な操作手順は以下の通りです。

:::: tabs
::: tab "AWS"

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

```bash
wget https://cloudassets.emqx.com/en/byoc-deployments/5.1.0/operate-byoc-deployment.tar.gz
```

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

```bash
tar -zxf operate-byoc-deployment.tar.gz && cd operate-byoc-deployment
```

3. 以下のコマンドの対応するパラメータの値を修正し、コマンドを実行して停止します。

```bash
./byoc stop \
     --platform aws \
     --accessKey <Your AccessKey> \
     --secretKey <Your SecretKey> \
     --byocEndpoint https://cloud-intl.emqx.com \
     --byocKey 58825600h0eb010ee6xxxxx
```

- `--accessKey`: AWS IAMユーザーのアクセスキーIDを入力してください。
- `--secretKey`: AWS IAMユーザーのアクセスキーシークレットを入力してください。

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

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

コマンドラインに以下の内容が表示されたら、デプロイメントの停止に成功したことを示します。

```bash
Stop the deployment successfully!
```

:::
::: tab "Google Cloud"

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

```bash
wget https://cloudassets.emqx.com/en/byoc-deployments/5.1.0/operate-byoc-deployment.tar.gz
```

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

```bash
tar -zxf operate-byoc-deployment.tar.gz && cd operate-byoc-deployment
```

3. 以下のコマンドの対応するパラメータの値を修正し、コマンドを実行して停止します。

```bash
./byoc stop \
      --platform gcp \
      --projectID <Your Project ID> \
      --authJSONPath <The absolute path of your Service Account JSON file> \
      --byocEndpoint https://cloud-intl.emqx.com \
      --byocKey 58825600se85d4cf1cxxxxxxxx
```

- `--projectID`: Google CloudのプロジェクトIDを入力してください。Google Cloudコンソールの上部バーのプロジェクトセレクターで確認できます。
- `--authJSONPath`: [Google Cloudサービスアカウントキー](https://cloud.google.com/iam/docs/keys-create-delete#creating) のJSONファイルのパスを入力してください。

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

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

コマンドラインに以下の内容が表示されたら、デプロイメントの停止に成功したことを示します。

```bash
Stop the deployment successfully!
```

:::
::::

### デプロイメントの削除

::: tip 前提条件

削除する前に、デプロイメントの状態が **Running** であることを確認してください。また、BYOCデプロイメントのVPC内でデプロイメント作成後にご自身で作成したカスタマイズリソースはすべて削除されている必要があります。そうでない場合、デプロイメントの削除処理は失敗します。

:::

::: warning 注意

デプロイメントを削除すると接続できなくなり、デプロイメントに関連するすべてのデータおよび設定が完全に削除されます。

:::

コンソールに入り、削除したいデプロイメントをクリックしてデプロイメント概要ページに移動します。右上の **Settings** ボタンをクリックして設定ページに移動し、ページ下部の **Delete Deployment** ボタンをクリックします。すると、以下のような **Delete Deployment Guide** が表示されます。

![byoc_delete_deployment](./_assets/byoc_delete_deployment.png)

インターネット接続のあるUbuntu 20.04 (AMD64) LTS環境を用意し、**Delete Deployment Guide** に記載された手順とコマンドに従って削除処理を開始してください。

::: tip

**Delete Deployment Guide** に記載されたコマンドは、セットアップページで入力した値やシステム定義情報を含んでいます。これらのコマンドをUbuntuのコマンドラインインターフェースに1つずつコピー＆ペーストして実行してください。

:::

クラウドプラットフォームごとの具体的な操作手順は以下の通りです。

:::: tabs
::: tab "AWS"

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

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

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

```bash
tar -zxf delete-aws-byoc-deployment.tar.gz && cd delete-aws-byoc-deployment
```

3. 以下のコマンドの対応するパラメータの値を修正し、コマンドを実行して削除します。

```bash
./byoc delete \
     --platform aws \
     --accessKey <Your AccessKey> \
     --secretKey <Your SecretKey> \
     --byocEndpoint https://cloud-intl.emqx.com \
     --byocKey abcdXXXXXXXXXX111
```

- `--accessKey`: AWS IAMユーザーのアクセスキーIDを入力してください。
- `--secretKey`: AWS IAMユーザーのアクセスキーシークレットを入力してください。

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

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

コマンド実行後、クラウドリソースを本当に削除するか確認されます。`yes` と入力してEnterキーを押すと処理が続行されます。

```bash
Do you really want to destroy all resources?
  Terraform will destroy all your managed infrastructure, as shown above.
  There is no undo. Only 'yes' will be accepted to confirm.

  Enter a value: 
```

コマンドラインに以下の内容が表示されたら、デプロイメントの削除に成功したことを示します。

```bash
Delete the deployment successfully!
```

:::
::: tab "Google Cloud"

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

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

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

```bash
tar -zxf delete-gcp-byoc-deployment.tar.gz && cd delete-gcp-byoc-deployment
```

3. 以下のコマンドの対応するパラメータの値を修正し、コマンドを実行して削除します。

```bash
./byoc delete \
     --platform gcp \
     --projectID <Your Project ID> \
     --authJSONPath <The absolute path of your Service Account JSON file> \
     --byocEndpoint https://cloud-intl.emqx.com \
     --byocKey abcdXXXXXXXXXX111
```

- `--projectID`: Google CloudのプロジェクトIDを入力してください。Google Cloudコンソールの上部バーのプロジェクトセレクターで確認できます。
- `--authJSONPath`: [Google Cloudサービスアカウントキー](https://cloud.google.com/iam/docs/keys-create-delete#creating) のJSONファイルのパスを入力してください。

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

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

コマンドラインに以下の内容が表示されたら、デプロイメントの削除に成功したことを示します。

```bash
Delete the deployment successfully!
```

:::
::::
