マイグレーション

データベースが設定されたWhatsAppビジネスAPIクライアントの既存のセットアップがあり、同じ電話番号を使用してクライアントとデータベースの両方を新しいセットアップに移行する場合、どんな変更を加えるべきか、またそのためにどのような処理が必要かをこのドキュメントで説明します。

開始する前に

• マイグレーションで最も重要なステップは、バックアップです。
• マイグレーションの後に電話番号を再登録する必要はありません。マイグレーション完了後、すぐにメッセージングを開始できます。
• 新しいセットアップのシャードの数は、旧セットアップと同じでなければなりません。マイグレーション中にスケールアップしたりスケールダウンすることはできません。旧セットアップがX個のMaster、Y個のCoreappで構成されている場合、新しいセットアップにはちょうど同じ数のMasterとCoareappがなければなりません。MasterとCoreappの数がマイグレーション前後で一致しない場合、マイグレーションはエラーになります。
• 本番環境アカウントの移行をする前に、テストアカウントの移行を試してください。
• ダウンタイムがあります。その長さは、マイグレーションオプションに応じて異なりますが、どのマイグレーションにもダウンタイムがあります。

マイグレーションオプション

マイグレーションするデータ量に応じて、複数のマイグレーションオプションがあります。自分のニーズに最適なオプションを選択してください。

• オプション1:設定のみ
• オプション2:設定とメッセージ
• オプション3:フルマイグレーション

各マイグレーションオプションで保持されるデータ

各マイグレーションオプションの典型的な使用事例とダウンタイム

各マイグレーションオプションの典型的な使用事例、および関連するダウンタイムを次の表に示します。これらは典型的な使用事例に過ぎず、実際のニーズに合わせてマイグレーションオプションの種類を選択することができます。

オプション1:設定のみ

設定のみのマイグレーションの場合、バックアップおよび復元が実行されるのは設定情報のみです。メッセージおよび認証トークン情報は、マイグレーションされません。

ステップ1: 新しいセットアップをインストールする

「インストール」のドキュメンテーションを参照して、新しいWhatsAppビジネスAPIクライアントをセットアップします。

ステップ2: 新しいセットアップのための新しい認証トークンを入手する

現在の認証トークンは、新しい環境では無効になります。新しい認証トークンを入手するため、新しいセットアップにログインします。

ステップ3: クリーンアップ

• [任意] 二段階認証をオフにします。二段階認証コードを忘れて再登録が必要になった場合に、これが役立ちます。スムースなマイグレーション実行のために再登録は必須ではありませんが、バックアップと復元が何らかの不明な理由でエラーになる場合には、再登録が必要になることがあります。二段階認証コードをオフにするための手順に従ってください。
  注:二段階認証コードが正しいものであるという確信があるなら、この手順は任意です。
• [任意] Webhooks(あれば)をすべてリセットします。Webhooksがインバウンドのお知らせを受信するように設定されており、マイグレーション中にWebhooksサーバーにも変更が加えられる場合は、アプリケーション設定で旧Webhooksサーバーをオフにします。
  注:マイグレーション後にWebhooksサーバーを変更しない場合、この手順は任意です。

ステップ4: 現在のセットアップから設定をバックアップする

現在の認証トークンを使用して、現在のWhatsAppビジネスAPIクライアントから設定データをバックアップします。

ステップ5: 現在のセットアップをアンインストールする

これにより、メッセージングのダウンタイムが発生します。ダウンタイムを最小限にするため、WhatsAppビジネスAPIクライアントを新しい場所で実行する準備ができていることを確認してください。手順については、該当するインストールガイドのアンインストールのセクションをご覧ください。WhatsAppビジネスAPIクライアントのアンインストールのみ実行するようにしてください。それには、Coreapp、Webapp、Masterの各Dockerコンテナが含まれます。データベースは削除しないでください。

ステップ6: 新しいセットアップで設定を復元する

まだ新しい認証トークンを使用していなければログインし、新しいセットアップで復元を実行します。
新しいWhatsAppビジネスAPIクライアントが必要な情報を使って実行されており、メッセージングの準備ができていなければなりません。覚えておく必要のある最も重要な点は、設定のバックアップと復元が適切に実行されるならWhatsAppアカウントの再登録は不要であるということです。

ステップ7: ヘルスチェックを実行する

ヘルスチェックを実行しテストメッセージを送信して、WhatsAppビジネスAPIクライアントが動作していることを確認します。

ステップ8: [任意] 二要素認証を有効にする

ステップ3で二要素認証をオフにした場合、ここで二要素認証を再び有効にします。これによりWhatsAppアカウントのセキュリティがさらに強化されます。

ステップ9: Webhooksを設定する

Webhooksを設定して、インバウンドのお知らせを有効にします。

ステップ10: 旧データベースをドロップする

旧データベースには、旧設定のデータ、旧メッセージ、および旧認証トークンが含まれています。将来そのデータの一部を復元することが必要になる場合には、旧データベースのドロップはしないでください。データベースをドロップすることにした場合は、削除を実行する前に、WhatsAppビジネスAPIクライアントが少なくとも14日間実行していること、またメッセージングが適切に動作していることを確認してください。

オプション2:設定とメッセージ

設定とメッセージのマイグレーションの場合、設定情報とメッセージのバックアップおよび復元が実行されます。認証トークン情報のマイグレーションは実行されません。

別のマシンに転送する必要があるデータの量に注意してください。オプション1に比べてバックアップと復元を行う必要があるデータが多くなるため、その分、ダウンタイムも長くなります。ダウンタイムの合計は、転送するデータの量とネットワークのレイテンシーによって異なります。

ステップ1: クリーンアップ

• [任意] 二段階認証をオフにします。二段階認証コードを忘れて再登録が必要になった場合に、これが役立ちます。スムースなマイグレーション実行のために再登録は必須ではありませんが、バックアップと復元が何らかの不明な理由でエラーになる場合には、再登録が必要になることがあります。二段階認証コードをオフにするための手順に従ってください。
  注:二段階認証コードが正しいものであるという確信があるなら、この手順は任意です。
• [任意] Webhooks(あれば)をすべてリセットします。Webhooksがインバウンドのお知らせを受信するように設定されており、マイグレーション中にWebhooksサーバーにも変更が加えられる場合は、アプリケーション設定で旧Webhooksサーバーをオフにします。これは、メッセージングのダウンタイムが発生し始める最初の段階です。
  注:マイグレーション後にWebhooksサーバーを変更しない場合、この手順は任意です。

ステップ2: 現在のセットアップをアンインストールする

これにより、メッセージングのダウンタイムが発生します。ダウンタイムを最小限にするため、WhatsAppビジネスAPIクライアントを新しい場所で実行する準備ができていることを確認してください。その手順については、該当するインストールガイドのアンインストールのセクションをご覧ください。WhatsAppビジネスAPIクライアントのアンインストールのみ実行するようにしてください。データベースは削除しないでください。

ステップ3: データベースをバックアップする

現在のWhatsAppビジネスAPIクライアントから、mysqldumpやpg_dumpなどのユーティリティを使用して、すべてのデータベースをバックアップします。ただし、ユーザーデータや認証データが含まれるwawebは除きます。
注:使用中のプラットフォームとの間でビジネスのマイグレーションを実行するソリューションプロバイダーの場合、wawebを除外することは重要です。現在保存されている認証トークンおよびユーザー情報を引き継ぐことは、望ましくないかもしれません。

ステップ4: データベースを復元する

mysqldumpやpg_dumpなどのユーティリティを使用して、新しいWhatsAppビジネスAPIクライアントにデータベースを復元します。

ステップ5: 新しいセットアップをインストールする

「インストール」のドキュメンテーションを参照して、新しいWhatsAppビジネスAPIクライアントをセットアップします。データベースの参照先が、ステップ4の復元先になっていることを確認してください。

ステップ6: 新しいセットアップのための新しい認証トークンを入手する

現在の認証トークンは、新しい環境では無効になります。新しい認証トークンを入手するため、新しいセットアップにログインします。
新しいWhatsAppビジネスAPIクライアントが必要な情報を使って実行されており、メッセージングの準備ができていなければなりません。覚えておく必要のある最も重要な点は、データベースのバックアップと復元が適切に実行されるならWhatsAppアカウントの再登録は不要であるということです。

ステップ7: ヘルスチェックを実行する

ヘルスチェックを実行しテストメッセージを送信して、WhatsAppビジネスAPIクライアントが動作していることを確認します。

ステップ8: [任意] 二要素認証を有効にする

ステップ1で二要素認証をオフにした場合、ここで二要素認証を再び有効にします。これによりWhatsAppアカウントのセキュリティがさらに強化されます。

ステップ9: Webhooksを設定する

Webhooksを設定して、インバウンドのお知らせを有効にします。

ステップ10: 旧データベースをドロップする

旧データベースには、旧設定のデータ、旧メッセージ、および旧認証トークンが含まれています。将来そのデータの一部を復元することが必要になる場合には、旧データベースのドロップはしないでください。データベースをドロップすることにした場合は、削除を実行する前に、WhatsAppビジネスAPIクライアントが少なくとも14日間実行していること、またメッセージングが適切に動作していることを確認してください。

オプション3:フルマイグレーション

フルマイグレーションでは、設定、メッセージ、および認証トークンのすべてがバックアップされ、復元されます。

このオプションが最善だと思えるかもしれませんが、別のマシンに転送する必要があるデータ量に注意してください。オプション1およびオプション2に比べてバックアップおよび復元の必要なデータが多くなるため、その分、ダウンタイムも長くなります。

ステップ1: クリーンアップ

• [任意] 二段階認証をオフにします。二段階認証コードを忘れて再登録が必要になった場合に、これが役立ちます。スムースなマイグレーション実行のために再登録は必須ではありませんが、バックアップと復元が何らかの不明な理由でエラーになる場合には、再登録が必要になることがあります。二段階認証コードをオフにするための手順に従ってください。
  注:二段階認証コードが正しいものであるという確信があるなら、この手順は任意です。

ステップ2: 現在の認証トークンをバックアップする

トークンの最大有効期間は7日間です。トークンの有効期間が、マイグレーション実行のために十分なものであることを確認してください。

ステップ3: 現在のセットアップをアンインストールする

これにより、メッセージングのダウンタイムが発生します。ダウンタイムを最小限にするため、WhatsAppビジネスAPIクライアントを新しい場所で実行する準備ができていることを確認してください。その手順については、該当するインストールガイドのアンインストールのセクションをご覧ください。WhatsAppビジネスAPIクライアントのアンインストールのみ実行するようにしてください。データベースは削除しないでください。

ステップ4: [任意] データベースをバックアップする

mysqldumpやpg_dumpなどのユーティリティを使用してデータベースをバックアップし、設定、メッセージ、および認証トークンのデータをキャプチャします。
注:WhatsAppビジネスAPIクライアントのみのマイグレーションを実行しており、データベースのマイグレーションは実行しない場合、この手順は任意です。

ステップ5: データベースを復元する

mysqldumpやpg_dumpなどのユーティリティを使用して、新しいWhatsAppビジネスAPIクライアントにデータベースを復元します。

ステップ6: 新しいセットアップをインストールする

「インストール」のドキュメンテーションを参照して、新しいWhatsAppビジネスAPIクライアントをセットアップします。データベースの参照先が、ステップ5の復元先になっていることを確認してください。
新しいWhatsAppビジネスAPIクライアントが必要な情報を使って実行されており、メッセージングの準備ができていなければなりません。覚えておく必要のある最も重要な点は、データのバックアップと復元が適切に実行されるならWhatsAppアカウントの再登録は不要であるということです。

ステップ7: ヘルスチェックを実行する

ヘルスチェックを実行しテストメッセージを送信して、WhatsAppビジネスAPIクライアントが動作していることを確認します。

ステップ8: [任意] 二要素認証を有効にする

ステップ1で二要素認証をオフにした場合、ここで二要素認証を再び有効にします。これによりWhatsAppアカウントのセキュリティがさらに強化されます。

ステップ9: Webhooksを設定する

Webhooksを設定して、インバウンドのお知らせを有効にします。

ステップ10: 旧データベースをドロップする

旧データベースには、旧設定のデータ、旧メッセージ、および旧認証トークンが含まれています。将来そのデータの一部を復元することが必要になる場合には、旧データベースのドロップはしないでください。データベースをドロップすることにした場合は、削除を実行する前に、WhatsAppビジネスAPIクライアントが少なくとも14日間実行していること、またメッセージングが適切に動作していることを確認してください。