使用 Amazon Web Services 部署

本文档介绍如何使用 Amazon Web Services (AWS) 部署 WhatsApp Business API。此流程可分为 2 个主要步骤：

1. WhatsApp Business API 客户端部署
2. WhatsApp Business API 客户端配置

完成设置后，可以选择升级客户端。如果您需要重启网页应用和核心应用，请按照这些步骤操作。

立即开始

开始之前，您需要完成以下操作：

• 设置 AWS 帐户编号
• 创建 AWS 密钥对
• 订阅 CentOS 9 映像
• 在支持的区域进行部署

设置 AWS 帐户编号

您需要设置有效的 AWS 帐户，并熟练使用 AWS。WhatsApp 提供 CloudFormation 模板，可用于轻松部署 WhatsApp Business API 客户端。如需了解详情，请访问 AWS 入门资源中心。

创建 AWS 密钥对

您需要新建密钥对，用以访问使用 WhatsApp Business API 模板创建的 EC2 实例。您还可使用之前创建的密钥对。请参阅 Amazon EC2 密钥对文档，了解通过 EC2 实例创建和使用密钥对的相关信息。

订阅 CentOS 9 映像

WhatsApp Business API 客户端使用 CentOS 9 映像（可在 AWS Marketplace 中获取）。使用模板前，请先查看并接受条款和条件。如不接受这些条款，您将无法创建模板。

如要查看并接受 CentOS 9 AMI 映像，请执行以下操作：

1. 前往 AWS Marketplace：CentOS 9 (x86_64) - 附带更新 HVM 页面。
2. 点击右上角的 Continue to Subscribe（继续订阅），然后点击 Accept Terms（接受条款）按钮。

支持的区域

WhatsApp Business API 模板使用 EFS 资源类型，该资源类型并非在所有 AWS 区域都可用。因此，目前仅支持下列区域：

• 北弗吉尼亚州 (us-east-1)
• 俄亥俄州 (us-east-2)
• 北加利福尼亚州 (us-west-1)
• 俄勒冈州 (us-west-2)
• 孟买 (ap-south-1)
• 首尔 (ap-northeast-2)
• 新加坡 (ap-southeast-1)
• 悉尼 (ap-southeast-2)
• 东京 (ap-northeast-1)
• 法兰克福 (eu-central-1)
• 爱尔兰 (eu-west-1)

常见问题

部署

第 1 步：[可选] 设置网络

在您注册 AWS 帐户时，系统通常会创建虚拟私有云 (VPC) 网络。此外，企业可能还需要根据特定业务，设置一些自定义项目和访问控制限制。

如果您已经创建 VPC 网络基础架构，可以跳过此步骤。如果尚未创建，则可以使用以下模板在 AWS 上创建网络基础架构。

网络要求

• 在区域内不同的可用区中，必须至少有两个子网。否则，模板创建流程在创建 RDS（数据库）资源环节便会失败。
• 应该允许入站访问 HTTP（端口：80）、HTTPS（端口：443）和 SSH（端口：22）。为安全起见，强烈建议您使用 HTTPS，不要使用 HTTP。

如要部署网络模板，请按照以下步骤操作：

1. 前往您区域（例如 eu-west-1）的 CloudFormation 控制台。
2. 选择 Create stack（创建堆栈）。
3. 从 GitHub 下载 wa_ent_net.yml 文件，并将该文件保存到本地。
4. 在“Template source”（模板来源）部分中选择 Upload a template file（上传模板文件），然后上传在第 3 步中下载的模板文件。
   

   创建堆栈
5. 点击 Next（下一步）。
6. 在 Specify stack details（指定堆栈详情）页面中，根据以下表格输入参数值：

参数

可用区配置

VPC 配置

公有子网配置

私有子网配置

第 2 步：上传 DB 和监控堆栈配置文件

在 AWS 上部署 WhatsApp Business API 堆栈之前，您需要首先将引用的子堆栈的配置文件上传到您拥有读取权限的 S3 存储桶。

1. 新建 S3 存储桶，或者使用您拥有读取权限的现有 S3 存储桶。
2. 从 GitHub 下载 wa_ent_db.yml 文件和 wa_ent_monitoring.yml 文件，并将这 2 个文件上传 到第 1 步中提及的 S3 存储桶。
3. 从“Objects”（对象）列表中选择 wa_ent_db.yml 文件，并复制该文件的网址。此网址的格式应为 https://xxx.s3.<avalability_zone>.amazonaws.com/wa_ent_db.yml。
4. 在 wa_ent.yml 文件中，使用第 3 步中的对象网址替换 dbStack 中的 TemplateURL的值，然后保存该文件。
5. 从“Objects”（对象）列表中选择 wa_ent_monitoring.yml 文件，并复制该文件的网址。此网址的格式应为 https://xxx.s3.<avalability_zone>.amazonaws.com/wa_ent_monitoring.yml。
6. 在 wa_ent.yml 文件中，使用第 5 步中的对象网址替换监控堆栈中的 TemplateURL 的值，并保存该文件。

上传到 S3 存储桶

第 3 步：WhatsApp Business API 部署

WhatsApp Enterprise 是主模板，可用于创建 WhatsApp Business API 客户端所需的全部资源（网络除外）。如前所述，如有需要，您也可以使用此模板创建数据库资源。

如要部署 WhatsApp Business API 客户端，请按照以下步骤操作：

1. 前往您区域（例如 eu-west-1）的 CloudFormation 控制台。
2. 选择创建堆栈。
3. 从 GitHub 下载 wa_ent.yml 文件，并将该文件保存到本地。
4. 在“Template source”（模板来源）部分中选择 Upload a template file（上传模板文件），然后上传在第 3 步中下载的模板文件。
   

   创建堆栈
5. 点击 Next（下一步）
   
6. 之后，您便可输入参数。请参阅以下表格，了解参数描述。
   
7. 设置所有参数（位于后面的表格中）后，在 Configure stack options（配置堆栈选项）页面中点击 Next（下一步）。您可以根据偏好进行任何必要的修改，然后点击 Next（下一步）。
8. 在 Review stack（审核堆栈）页面，您将看到参数值和堆栈选项的摘要。进行验证后，在 Capabilities（功能）部分勾选以下两个复选框，然后点击 Submit（提交），开始创建堆栈。
   注意：部署过程大约需要 20 至 30 分钟。
   

参数

通用配置

网络配置

容器配置

数据库配置

日志记录配置

文件系统配置

安全配置

WhatsApp Business API 接入点

在 Grafana 面板出于监控目的检索应用程序指标时，这些参数均为必要项。

Grafana

部署后的输出

成功创建模板后，系统会显示以下参数：

• Load balancer name：访问 WhatsApp Business 开放平台 API 客户端的负载均衡器的主机名
• Database hostname：在模板创建过程中创建或提供的数据库的主机名
• Database port number：数据库连接的端口编号
• ECS cluster name：所创建 ECS 群集的名称
• Log retention days：留存记录的天数
• DB connection CA：DB 连接 CA 的值（如已配置）
• DB connection cert：DB 连接 cert 的值（如已配置）
• DB connection key：数据库连接密钥的值（如已配置）
• Grafana：Grafana 面板网址
• ShardCount：为 WhatsApp Business 开放平台 API 配置的分片数量

编辑 SSH 安全规则

默认情况下，堆栈所创建的安全规则允许所有流量通过 SSH 到达 EC2 实例，通过 HTTPS 到达 API 端点和 Grafana 面板，以及到达 cAdvisor 和 Prometheus 容器。出于安全考虑，我们强烈建议关闭非必要的访问权限。此部分将以更新 SSH 安全规则为例展示操作步骤。您应始终将 SSH 访问权限限制为仅您信任的流量。

1. 在“EC2”>“Security Groups”（安全小组）控制台（例如：EC2 管理控制台 (amazon.com)）中，执行以下操作：
   1. 在右上角选择正确的区域。
   2. 选择包含 <stackName>-EcsSecurityGroup 的安全小组，然后切换到 Inbound Rules（入站规则）选项卡。
      

      编辑入站规则
   3. 选择 Edit inbound rules（编辑入站规则），将Source（来源）列更新为只允许信任的流量 [例如：My IP（我的 IP）] 通过 SSH 访问 EC2 主机。
      
   4. 调整所有安全规则后，点击 Save rules（保存规则），即可应用更改。
   5. 针对包含 "<stackName>-ms-xxx-EcsSecurityGroup" 的安全小组重复执行这些更改，以便限制通过 SSH 访问监控堆栈。

WhatsApp Business API 客户端配置

成功部署 WhatsApp Business API 客户端后，需要对其进行配置，以使其投入运行。

第 1 步：电话号码注册

请参阅电话号码指南，详细了解电话号码注册。

请前往 WhatsApp 管理工具，打开电话号码选项卡，在 Facebook 商务管理平台中下载 WhatsApp 帐户的 base64 编码证书。

选择正确的电话号码并获取 base64 编码证书后，需要通过 account 节点注册 WhatsApp Business API 客户端。详情请参阅注册文档。

第 2 步：设置分片

创建堆栈后，您需要使用 shards API 调用增加活跃核心应用实例的数量，以达到所需吞吐量。分片数量位于堆栈的输出部分。

第 3 步：更新应用程序设置

如需了解 WhatsApp Business API 网络回调及其他参数的配置，请参阅应用程式设置文档。为了实现稳定的吞吐量，建议使用以下应用程式设置。

 {
    "settings": {
        "application": {
            "callback_backoff_delay_ms": 3000,
            "callback_persist": true,
            "db_garbagecollector_enable": false, # change this to true when there are no ongoing messaging campaigns
            "heartbeat_interval": 5,
            "max_callback_backoff_delay_ms": 900000,
            "media": {
                "auto_download": [
                    "document",
                    "image",
                    "video",
                    "voice",
                    "sticker",
                    "audio"
                ]
            },
            "notify_user_change_number": true,
            "pass_through": false,
            "sent_status": true,
            "show_security_notifications": false,
            "skip_referral_media_download": false,
            "unhealthy_interval": 30,
            "wa_id": "12245552741",
            "webhooks": {
                "max_concurrent_requests": 24,
                "message": {
                    "delivered": true,
                    "read": true,
                    "sent": true
                },
                "url": "<YOUR_WEBHOOK_SERVER_URL>"
            }
        }
    },
    "meta": {
        "api_status": "stable",
        "version": "2.41.3"
    }
}

      
      
    

第 4 步：[可选] SSL 配置

在创建时 WhatsApp Business API 客户端时，该客户端会默认生成自签名证书。您可能需要使用用于生成自签名证书的认证机构 (CA) 证书来验证 WhatsApp Business API 客户端的端点，并避免出现证书信任警告。

您可以下载 CA 证书并将其存储在本地设备，以免出现证书信任警告，或者您也可以上传自己的证书。详情请参阅 certificate 节点文档。

第 5 步：验证设置

完成配置和注册步骤后，您可以收发消息，以验证 WhatsApp Business API 客户端的基本功能。详情请参阅消息文档。

成功收到消息后，WhatsApp Business API 客户端会通过 POST 向第 3 步中配置的 Webhooks 发送消息状态或详情。

如果您的消息被成功接收，那么恭喜您，您已经全部准备就绪！请参阅参考文档，进一步了解可用的 API 端点。

重启核心应用和网页应用

如要重新开启 WhatsApp Business API 客户端，请前往 ECS 控制台（例如 https://us-west-2.console.aws.amazon.com/ecs/home?region=us-west-2#/clusters），然后执行以下操作：

1. 在右上角选择正确的区域。
2. 从列表中选择相应的集群。
3. 在 Services（服务）选项卡中，选择含有 WAEntService 的服务名称。
4. 选择 Tasks（任务）选项卡。通常应该只有一个任务，包含一个由十六进制数字组成的编号。
5. 在 Tasks（任务）窗口中，点击右上角的 Stop（停止），在系统提示后再次点击 Stop（停止）。

此操作将同时停止网页应用和核心应用。不久后，AWS 基础架构会同时重启网页应用和核心应用。

升级

此部分将介绍如何同时升级 WhatsApp Business API 客户端以及 CloudFormation (CFN) 模板。执行升级会导致停机，因此请勿在此期间发送消息，待升级完成后再发送。

按照以下步骤操作，您可以同时升级 CFN 模板和 WhatsApp Business API 客户端版本：

1. 在“WhatsApp Business API 客户端升级”指南的第 5 步中，选择 Replace current template（替换当前模板），而不是 Use current template（使用当前模板）。
2. 在 Specify template（指定模板）部分，选择“Upload a template file”（上传模板文件），然后选择从 GitHub 下载的最新模板文件。

WhatsApp Business API 客户端升级

1. 前往 CFN 控制台（例如：https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks?filter=active）。
2. 在右上角选择正确的区域。
3. 选择已经创建的 WhatsApp Business API 客户端堆栈。
4. 点击 Update（更新）。
5. 前往 Prerequisite - Prepare template（前提条件 - 准备模板）页面，选择 Replace current template（替换当前模板）选项。在 Specify template（指定模板）部分，选择“Upload a template file”（上传模板文件），然后选择从 GitHub 下载的最新模板文件。点击 Next（下一步）。
6. 前往 Specify stack details（指定堆栈详情）页面，将 WhatsApp Business API Client (container) version（WhatsApp Business API 客户端（容器）版本）更改为所需版本。请勿更改其他任何参数。点击 Next（下一步）。
7. 前往 Configure stack options（配置堆栈选项）页面，点击 Next（下一步）。
8. 前往 Review（审核）页面，选择“I acknowledge that AWS CloudFormation might create IAM resources with custom names”（我确认，AWS CloudFormation 可能会创建拥有自定义名称的 IAM 资源）。查看 Change set preview（更改设置预览）部分，了解是否存在任何意外更改。如果发现任何意外或不确定的更改，请联系 WhatsApp 站内支持。点击 Update stack（更新堆栈）。您可以在 CFN 控制台追踪堆栈更新状态；升级完成后，该状态将由 UPDATE_IN_PROGRESS 变为 UPDATE_COMPLETE。

WhatsApp CFN 模板升级

1. 前往 CFN 控制台（例如：https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks?filter=active）。
2. 在右上角选择正确的区域。
3. 选择已经创建的 WhatsApp Business API 客户端堆栈。
4. 点击 Update（更新）。
5. 前往 Prerequisite - Prepare template（前提条件 - 准备模板）页面，选择 Replace current template（替换当前模板）选项。在 Specify template（指定模板）部分，选择“Upload a template file”（上传模板文件），然后选择从 GitHub 下载的最新模板文件。点击 Next（下一步）。
6. 前往 Specify Stack Details（指定堆栈详情）页面，然后按照前面部分的信息，输入相应参数。点击 Next（下一步）。
7. 前往 Configure stack options（配置堆栈选项）页面，点击 Next（下一步）。
8. 前往 Review（审核）页面，选择“I acknowledge that AWS CloudFormation might create IAM resources with custom names”（我确认，AWS CloudFormation 可能会创建拥有自定义名称的 IAM 资源）。查看 Change set preview（更改设置预览）部分，了解是否存在任何意外更改。如果发现任何意外或不确定的更改，请联系 WhatsApp 站内支持。点击 Update stack（更新堆栈）。您可以在 CFN 控制台追踪堆栈更新状态；升级完成后，该状态将由 UPDATE_IN_PROGRESS 变为 UPDATE_COMPLETE。

如何在系统处于空闲模式时手动缩减成本（可选）

企业通常希望为有时间限制的营销活动设置高吞吐量环境，并且希望在非营销活动期间保持环境以低成本运行。此部分针对如何手动减少 AWS 设置以节省成本提供了建议。

1. 在 ECS 控制台（例如：Amazon ECS）中，执行以下操作：
   1. 在右上角选择正确的区域。
   2. 从列表中选择相应的集群。
   3. 在 Services（服务）选项卡中，选择含有 WAEntCoreappService 的服务名称。选择 Edit Service（编辑服务），并将“Desired tasks”（所需任务）的值更新为“0”。
      

      部署配置
   4. 针对所有其他服务（包括 WAEntWebService、WAEntMasterService 和 HostExporterService）重复执行步骤 c。
   5. 返回集群页面，在 Tasks（任务）选项卡中，确保上述服务没有运行任何任务。
2. 在“EC2”>“Auto Scaling Groups”（自动缩放组）控制台（例如自动缩放组 | EC2 管理控制台 (amazon.com)）中，执行以下操作：
   1. 在右上角选择正确的区域。
   2. 选择名称中包含 HAECSAutoScalingGroup 的堆栈的自动缩放组，然后选择 Edit（编辑）。将“Desired capacity”（所需容量）和“Minimum capacity”（最小容量）全都更新为 3。
      

      组规模
   3. 选择名称中包含 HAECSAutoScalingGroupWeb 的堆栈的自动缩放组，然后选择 Edit（编辑）。将“Desired capacity”（所需容量）和“Minimum capacity”（最小容量）全都更新为 2。
3. （可选）如果“Type of message”（消息类型）的初始值是任意图像类型，则您可以将 EC2 实例类型替换为更便宜的 c5.large 选项。
   1. 在“EC2”>“Launch Templates”（启动模板）控制台中，从列表中选择适当的启动模板。
   2. 选择“Actions”（操作）>“Modify template (create new version)”[修改模板（创建新版本）]。
      

      启动模板控制台
   3. 在 Instance type（实例类型）部分，将实例类型更新为 c5.large，然后选择 Create template version（创建模板版本）。
      

      实例类型
   4. 在“EC2”>“Auto Scaling Groups”（自动缩放组）控制台中，选择名称中包含 HAECSAutoScalingGroup 的堆栈的自动缩放组。
   5. 在 Launch template（启动模板）部分选择 Edit（编辑）。
   6. 选择在步骤 3c 中创建的新启动模板，然后选择 Update（更新）。
      

      启动模板
4. 在 RDS 控制台（例如 RDS 管理控制台 (amazon.com)）中，执行以下操作：
   1. 在右上角选择正确的区域。
   2. 从列表中选择相应的 Aurora 数据库。
   3. 选择 Modify（修改），然后将数据库实例类更新为 r5.xlarge。
      

      实例配置
5. 在 ECS 控制台（例如 Amazon ECS）中，执行以下操作：
   1. 在右上角选择正确的区域。
   2. 从列表中选择相应的集群。
   3. 在服务选项卡中，选择含有 WAEntCoreappService 的服务名称。选择 Edit Service（编辑服务），并将“Desired tasks”（所需任务）的值更新为 3。
   4. 在 Services（服务）选项卡中，选择含有 HostExporterService 的服务名称。选择 Edit Service（编辑服务），并将“Desired tasks”（所需任务）的值更新为 3。
   5. 在 Services（服务）选项卡中，选择含有 WAEntWebService 的服务名称。选择 Edit Service（编辑服务），并将“Desired tasks”（所需任务）的值更新为 2。
   6. 在 Services（服务）选项卡中，选择含有 WAEntMasterService 的服务名称。选择 Edit Service（编辑服务），并将“Desired tasks”（所需任务）的值更新为 2。
6. 等待所有服务启动所需数量的任务。所有任务开始运行后，使用设置分片 API 将分片重置为 2。
7. 使用运行状况 API 验证系统的运行状况。您还可以通过收发消息验证 WhatsApp Business API 客户端的基本功能。详情请参阅消息文档。