AWS App Mesh 和 Amazon ECS 入门 - Amazon Elastic Container Service
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS App Mesh 和 Amazon ECS 入门

重要

App Mesh 在此区域内不受支持。

AWS App Mesh 是一种基于 Envoy 代理的服务网格,可帮助您监控和控制服务。App Mesh 对服务的通信方式进行标准化,从而为您提供端到端可见性,并有助于确保应用程序的高可用性。App Mesh 可为您提供对应用程序中每个服务一致的可见性和网络流量控制。有关更多信息,请参阅 AWS App Mesh 用户指南

本主题将帮助您配合使用 AWS App Mesh 和在 Amazon ECS。本教程介绍了多种 App Mesh 资源类型的基本功能。要了解有关您在完成本教程时不使用的资源功能的更多信息,请参阅有关虚拟节点虚拟服务虚拟路由器路由Envoy 代理的主题。

场景

为了说明如何配合使用 App Mesh 与 Amazon ECS,假定您有一个具有以下特征的应用程序:

  • 包括两个名为 serviceAserviceB 的服务。

  • 这两个服务均注册到名为 apps.local 的命名空间。

  • ServiceA 通过 HTTP/2 和端口 80 与 serviceB 通信。

  • 您已部署版本 2 的 serviceB,并采用名称 serviceBv2apps.local 命名空间中注册了该服务。

您的要求如下:

  • 您希望将 75% 的流量从 serviceA 发送到 serviceB,并将 25% 的流量发送到 serviceBv2,以确保在将 100% 的流量从 serviceA 发送到 serviceBv2 之前,该服务没有错误。

  • 您希望能够轻松调整流量权重,以便一旦证明 serviceBv2 可靠便可将 100% 的流量发送到该服务。将所有流量发送到 serviceBv2 后,您希望弃用 serviceB

  • 您不希望必须更改实际服务的任何现有应用程序代码或服务发现注册以满足以前的要求。

为了满足您的要求,您已决定创建包含虚拟服务、虚拟节点、虚拟路由器和路由的 App Mesh 服务网格。实施您的网格后,更新任务定义的服务,以便让您的服务使用 Envoy 代理。更新后,您的服务将通过 Envoy 代理相互通信,而不是直接相互通信。

先决条件

App Mesh 支持已注册到 DNS 和/或 AWS Cloud Map 的 Linux 服务。要使用此入门指南,我们建议您提供三个已注册到 DNS 的现有服务。即使服务不存在,您也可以创建服务网格及其资源,但在部署实际服务之前,您无法使用网格。

有关 Amazon ECS 上服务发现的更多信息,请参阅服务发现。要使用服务发现创建 Amazon ECS 服务,请参阅教程:使用服务发现创建服务

剩余步骤假定实际服务命名为 serviceAserviceBserviceBv2,并且可以在名为 apps.local 的命名空间中发现所有服务。

步骤 1:创建网格和虚拟服务

服务网格是一种用于驻留在其内的服务之间的网络流量的逻辑边界。有关更多信息,请参阅 AWS App Mesh 用户指南 中的服务网格。虚拟服务是实际服务的抽象。有关更多信息,请参阅 AWS App Mesh 用户指南 中的虚拟服务

创建以下资源:

  • 名为 apps 的网格,因为此场景中的所有服务均注册到 apps.local 命名空间。

  • 名为 serviceb.apps.local 的虚拟服务,因为虚拟服务表示可以使用该名称发现的服务,并且您不希望更改代码以引用其他名称。稍后的步骤中将添加名为 servicea.apps.local 的虚拟服务。

您可以使用 AWS 管理控制台或 AWS CLI 版本 1.18.99 或更高版本或者 2.0.31 或更高版本来完成以下步骤。如果使用 AWS CLI,请使用 aws --version 命令检查已安装的 AWS CLI 版本。如果您没有安装版本 1.18.99 或更高版本,或者没有安装版本 2.0.31 或更高版本,则必须安装或更新 AWS CLI。选择要使用的工具所对应的选项卡。

AWS 管理控制台
  1. 打开 App Mesh 控制台首次运行向导,网址为 https://console.aws.amazon.com/appmesh/get-started

  2. 对于 Mesh name (网格名称),输入 apps

  3. 对于 Virtual service name (虚拟服务名称),输入 serviceb.apps.local

  4. 要继续,请选择 Next

AWS CLI
  1. 使用 create-mesh 命令创建网格。

    aws appmesh create-mesh --mesh-name apps
  2. 使用 create-virtual-service 命令创建虚拟服务。

    aws appmesh create-virtual-service --mesh-name apps --virtual-service-name serviceb.apps.local --spec {}

步骤 2:创建虚拟节点

虚拟节点充当实际服务的逻辑指针。有关更多信息,请参阅 AWS App Mesh 用户指南 中的虚拟节点

创建名为 serviceB 的虚拟节点,因为某个虚拟节点表示名为 serviceB 的实际服务。可使用主机名 serviceb.apps.local,通过 DNS 发现虚拟节点所表示的实际服务。或者,也可以使用 AWS Cloud Map 发现实际服务。虚拟节点将采用 HTTP/2 协议在端口 80 上侦听流量。此外,还支持其他协议和运行状况检查。您将在后面的步骤中为 serviceBv2serviceA 创建虚拟节点。

AWS 管理控制台
  1. 对于 Virtual node name (虚拟节点名称),输入 serviceB

  2. 对于 Service discovery method (服务发现方法),选择 DNS,并为 DNS hostname (DNS 主机名) 输入 serviceb.apps.local

  3. Listener configuration (侦听器配置) 下,为 Protocol (协议) 选择 http2,并为 Port (端口) 输入 80

  4. 要继续,请选择 Next

AWS CLI
  1. 使用以下内容创建名为 create-virtual-node-serviceb.json 的文件:

    { "meshName": "apps", "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http2" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceB.apps.local" } } }, "virtualNodeName": "serviceB" }
  2. 采用 JSON 文件作为输入,使用 create-virtual-node 命令创建虚拟节点。

    aws appmesh create-virtual-node --cli-input-json file://create-virtual-node-serviceb.json

步骤 3:创建虚拟路由器和路由

虚拟路由器路由网格中一个或多个虚拟服务的流量。有关更多信息,请参阅 AWS App Mesh 用户指南 中的虚拟路由器路由

创建以下资源:

  • 名为 serviceB 的虚拟路由器,因为 serviceB.apps.local 虚拟服务不会启动与任何其他服务的出站通信。请记住,您之前创建的虚拟服务是实际 serviceb.apps.local 服务的抽象。虚拟服务将流量发送到虚拟路由器。虚拟路由器将采用 HTTP/2 协议在端口 80 上侦听流量。此外,还支持其他协议。

  • 名为 serviceB 的路由。它将 100% 的流量路由到 serviceB 虚拟节点。添加 serviceBv2 虚拟节点后,您将在稍后的步骤中更改权重。虽然本指南中未作介绍,但您可以为路由添加额外的筛选条件,并添加重试策略,从而使 Envoy 代理在遇到通信问题时会多次尝试将流量发送到虚拟节点。

AWS 管理控制台
  1. 对于 Virtual router name (虚拟路由器名称),输入 serviceB

  2. Listener configuration (侦听器配置) 下,为 Protocol (协议) 选择 http2,并为 Port (端口) 指定 80

  3. 对于 Route name (路由名称),输入 serviceB

  4. 对于 Route type (路由类型),选择 http2

  5. 对于 Route configuration (路由配置) 下的 Virtual node name (虚拟节点名称),选择 serviceB 并为 Weight (权重) 输入 100

  6. 要继续,请选择 Next

AWS CLI
  1. 创建虚拟路由器。

    1. 使用以下内容创建名为 create-virtual-router.json 的文件:

      { "meshName": "apps", "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http2" } } ] }, "virtualRouterName": "serviceB" }
    2. 采用 JSON 文件作为输入,使用 create-virtual-router 命令创建虚拟路由器。

      aws appmesh create-virtual-router --cli-input-json file://create-virtual-router.json
  2. 创建路由。

    1. 使用以下内容创建名为 create-route.json 的文件:

      { "meshName" : "apps", "routeName" : "serviceB", "spec" : { "httpRoute" : { "action" : { "weightedTargets" : [ { "virtualNode" : "serviceB", "weight" : 100 } ] }, "match" : { "prefix" : "/" } } }, "virtualRouterName" : "serviceB" }
    2. 采用 JSON 文件作为输入,使用 create-route 命令创建路由。

      aws appmesh create-route --cli-input-json file://create-route.json

步骤 4:审核并创建

根据之前的说明审核设置。

AWS 管理控制台

如果需要对任何部分进行任何更改,请选择 Edit (编辑)。在您对设置感到满意后,选择 Create mesh (创建网格)

Status (状态) 屏幕将显示已创建的所有网格资源。您可以通过选择 View mesh (查看网格) 来在控制台中查看创建的资源。

AWS CLI

使用 describe-mesh 命令查看所创建网格的设置。

aws appmesh describe-mesh --mesh-name apps

使用 describe-virtual-service 命令查看所创建的虚拟服务的设置。

aws appmesh describe-virtual-service --mesh-name apps --virtual-service-name serviceb.apps.local

使用 describe-virtual-node 命令查看所创建的虚拟节点的设置。

aws appmesh describe-virtual-node --mesh-name apps --virtual-node-name serviceB

使用 describe-virtual-router 命令查看所创建的虚拟路由器的设置。

aws appmesh describe-virtual-router --mesh-name apps --virtual-router-name serviceB

使用 describe-route 命令查看所创建路由的设置。

aws appmesh describe-route --mesh-name apps \ --virtual-router-name serviceB --route-name serviceB

步骤 5:创建其他资源

要完成此场景,您需要执行以下操作:

  • 创建名为 serviceBv2 的虚拟节点,以及名为 serviceA 的虚拟节点。这两个虚拟节点均通过 HTTP/2 和端口 80 侦听请求。对于 serviceA 虚拟节点,配置 serviceb.apps.local 的后端,因为来自 serviceA 虚拟节点的所有出站流量都会发送到名为 serviceb.apps.local 的虚拟服务。虽然本指南中未作介绍,但您还可以为虚拟节点指定用于写入访问日志的文件路径。

  • 另外创建一个名为 servicea.apps.local 的虚拟服务,该虚拟服务将所有流量直接发送到 serviceA 虚拟节点。

  • 更新在上一步中创建的 serviceB 路由,以将 75% 的流量发送到 serviceB 虚拟节点,将 25% 的流量发送到 serviceBv2 虚拟节点。随着时间的推移,您可以继续修改权重,直到 serviceBv2 收到 100% 的流量。将所有流量发送到 serviceBv2 后,您可以弃用 serviceB 虚拟节点和实际服务。在更改权重时,不需要对代码进行任何修改,因为 serviceb.apps.local 虚拟服务名称和实际服务名称没有改变。回想一下,serviceb.apps.local 虚拟服务将流量发送到虚拟路由器,该路由器将流量路由到虚拟节点。虚拟节点的服务发现名称可以随时更改。

AWS 管理控制台
  1. 在左侧导航窗格中,选择 Meshes (网格)

  2. 选择在上一步中创建的 apps 网格。

  3. 在左侧导航窗格中,选择 Virtual nodes (虚拟节点)

  4. 选择 Create virtual node (创建虚拟节点)

  5. 对于 Virtual node name (虚拟节点名称),为 Service discovery method (服务发现方法) 输入 serviceBv2,选择 DNS,为 DNS hostname (DNS 主机名) 输入 servicebv2.apps.local

  6. 对于 Listener configuration (侦听器配置),为 Protocol (协议) 选择 http2,为 Port (端口) 输入 80.

  7. 选择 Create virtual node (创建虚拟节点)

  8. 再次选择 Create virtual node (创建虚拟节点)。为 Virtual node name (虚拟节点名称) 输入 serviceA。对于 Service discovery method (服务发现方法),选择 DNS,并为 DNS hostname (DNS 主机名) 输入 servicea.apps.local

  9. 对于 New backend (新后端) 下的 Enter a virtual service name (输入虚拟服务名称),输入 servicea.apps.local

  10. Listener configuration (侦听器配置) 下,为 Protocol (协议) 选择 http2,为 Port (端口) 输入 80,然后选择 Create virtual node (创建虚拟节点)

  11. 在左侧导航窗格中,选择 Virtual routers (虚拟路由器),然后从列表中选择 serviceB 虚拟路由器。

  12. Routes (路由) 下,选择在上一步中创建的名为 ServiceB 的路由,然后选择 Edit (编辑)

  13. Targets (目标)Virtual node name (虚拟节点名称) 下,将 serviceBWeight (权重) 值更改为 75

  14. 选择 Add target (添加目标),从下拉列表中选择 serviceBv2,然后将 Weight (权重) 值设置为 25

  15. 选择保存

  16. 在左侧导航窗格中,选择 Virtual services (虚拟服务),然后选择 Create virtual service (创建虚拟服务)

  17. Virtual service name (虚拟服务名称) 输入 servicea.apps.local,为 Provider (提供程序) 选择 Virtual node (虚拟节点),为 Virtual node (虚拟节点) 选择 serviceA,然后选择 Create virtual service (创建虚拟服务)

AWS CLI
  1. 创建 serviceBv2 虚拟节点。

    1. 使用以下内容创建名为 create-virtual-node-servicebv2.json 的文件:

      { "meshName": "apps", "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http2" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceBv2.apps.local" } } }, "virtualNodeName": "serviceBv2" }
    2. 创建虚拟节点。

      aws appmesh create-virtual-node --cli-input-json file://create-virtual-node-servicebv2.json
  2. 创建 serviceA 虚拟节点。

    1. 使用以下内容创建名为 create-virtual-node-servicea.json 的文件:

      { "meshName" : "apps", "spec" : { "backends" : [ { "virtualService" : { "virtualServiceName" : "serviceb.apps.local" } } ], "listeners" : [ { "portMapping" : { "port" : 80, "protocol" : "http2" } } ], "serviceDiscovery" : { "dns" : { "hostname" : "servicea.apps.local" } } }, "virtualNodeName" : "serviceA" }
    2. 创建虚拟节点。

      aws appmesh create-virtual-node --cli-input-json file://create-virtual-node-servicea.json
  3. 更新在上一步中创建的 serviceb.apps.local 虚拟服务,以将其流量发送到 serviceB 虚拟路由器。最初创建虚拟服务时,它不会向任何位置发送流量,因为尚未创建 serviceB 虚拟路由器。

    1. 使用以下内容创建名为 update-virtual-service.json 的文件:

      { "meshName" : "apps", "spec" : { "provider" : { "virtualRouter" : { "virtualRouterName" : "serviceB" } } }, "virtualServiceName" : "serviceb.apps.local" }
    2. 使用 update-virtual-service 命令更新虚拟服务。

      aws appmesh update-virtual-service --cli-input-json file://update-virtual-service.json
  4. 更新在上一步中创建的 serviceB 路径。

    1. 使用以下内容创建名为 update-route.json 的文件:

      { "meshName" : "apps", "routeName" : "serviceB", "spec" : { "http2Route" : { "action" : { "weightedTargets" : [ { "virtualNode" : "serviceB", "weight" : 75 }, { "virtualNode" : "serviceBv2", "weight" : 25 } ] }, "match" : { "prefix" : "/" } } }, "virtualRouterName" : "serviceB" }
    2. 使用 update-route 命令更新路由。

      aws appmesh update-route --cli-input-json file://update-route.json
  5. 创建 serviceA 虚拟服务。

    1. 使用以下内容创建名为 create-virtual-servicea.json 的文件:

      { "meshName" : "apps", "spec" : { "provider" : { "virtualNode" : { "virtualNodeName" : "serviceA" } } }, "virtualServiceName" : "servicea.apps.local" }
    2. 创建虚拟服务。

      aws appmesh create-virtual-service --cli-input-json file://create-virtual-servicea.json

网格摘要

在创建服务网格之前,您具有三个名为 servicea.apps.localserviceb.apps.localservicebv2.apps.local 的实际服务。除实际服务之外,现在您还具有一个服务网格,其中包含用以表示实际服务的以下资源:

  • 两个虚拟服务。代理通过虚拟路由器将所有流量从 servicea.apps.local 虚拟服务发送到 serviceb.apps.local 虚拟服务。

  • 三个名为 serviceAserviceBserviceBv2 的虚拟节点。Envoy 代理使用为虚拟节点配置的服务发现信息来查找实际服务的 IP 地址。

  • 一个虚拟路由器,其路由指示 Envoy 代理将 75% 的入站流量路由到 serviceB 虚拟节点,将 25% 的流量路由到 serviceBv2 虚拟节点。

步骤 6:更新服务

创建网格后,您需要完成以下任务:

  • 授予随每个 Amazon ECS 任务部署的 Envoy 代理读取一个或多个虚拟节点配置的权限。有关如何向代理授权的更多信息,请参阅代理授权

  • 更新每个现有 Amazon ECS 任务定义,以使用 Envoy 代理。

凭证

Envoy 容器需要 AWS Identity and Access Management 凭证来签署发送到 App Mesh 服务的请求。对于使用 Amazon EC2 启动类型部署的 Amazon ECS 任务,凭证可以来自实例角色任务 IAM 角色。使用 Fargate 启动类型部署的 Amazon ECS 任务无权访问提供实例 IAM 配置文件凭证的 Amazon EC2 元数据服务器。要提供凭证,您必须将 IAM 任务角色附加到使用 Fargate 启动类型部署的任何任务。如果使用 Amazon EC2 启动类型部署任务,并且阻止对 Amazon EC2 元数据服务器的访问(如任务的 IAM 角色中的重要 注释中所述),还必须将任务 IAM 角色附加到任务。您分配给实例或任务的角色必须附加一个 IAM 策略,如代理授权中所述。

更新任务定义

您可以通过使用 AWS 管理控制台或修改任务定义的 JSON 文件来更新任务定义。以下步骤仅显示如何更新此场景的 taskB 任务。您还需要通过更改相应值来更新 taskBv2taskA 任务。选择您喜欢用于更新任务定义的方法。

AWS 管理控制台
  1. https://console.amazonaws.cn/ecs/ 上打开 Amazon ECS 控制台。

  2. 从导航栏中,选择包含您的任务定义的区域。

  3. 在导航窗格中,选择 Task Definitions

  4. Task Definitions (任务定义) 页面上,选择要修订的任务定义左侧的框。从先决条件和之前的步骤中,您可能已具有名为 taskAtaskBtaskBv2 的任务定义。选择 taskB,然后选择 Create new revision (创建新修订)

  5. Create new revision of Task Definition (创建任务定义的新修订) 页面上,进行以下更改来启用 App Mesh 集成。

    1. 对于 Service Integration (服务集成),要配置 App Mesh 集成的参数,请选择 Enable App Mesh integration (启用 App Mesh 集成),然后执行以下操作:

      1. 对于 Application container name (应用程序容器名称),选择要用于 App Mesh 应用程序的容器名称。必须已在任务定义中定义此容器。

      2. 对于 Envoy 映像,请完成以下任务并输入返回的值。

        • me-south-1 and ap-east-1外的所有受支持区域。您可以将 us-west-2 替换为除 me-south-1 and ap-east-1 之外的任何区域。

          840364872350.dkr.ecr.region-code.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod
        • me-south-1 区域:

          772975370895.dkr.ecr.me-south-1.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod
        • ap-east-1 区域:

          856666278305.dkr.ecr.ap-east-1.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod
      3. 对于 Mesh name (网格名称),选择要使用的 App Mesh 服务网格。在本主题中,创建的网格名称为 apps.

      4. 对于 Virtual node name (虚拟节点名称),选择要使用的 App Mesh 虚拟节点。例如,对于 taskB 任务,您可以选择在上一步中创建的 serviceB 虚拟节点。

      5. Virtual node port (虚拟节点端口) 的值将使用您在创建虚拟节点时指定的侦听器端口进行预填充。

      6. 选择应用,然后选择确认。将创建一个新的 Envoy 代理容器并将其添加到任务定义中,同时还会创建支持该容器的设置。然后,Envoy 代理容器会为下一步预填充 App Mesh Proxy Configuration (代理配置) 设置。

    2. 对于 Proxy Configuration (代理配置),请验证所有预填充值。

    3. 对于 Network Mode (网络模式),请确保选择 awsvpc。要了解有关 awsvpc 网络模式的更多信息,请参阅使用 awsvpc 网络模式进行任务联网

  6. 选择 Create

  7. 使用更新后的任务定义更新服务。有关更多信息,请参阅更新服务

JSON

代理配置

要将您的 Amazon ECS 服务配置为使用 App Mesh,您的服务的任务定义必须具有以下代理配置部分。将代理配置 type 设置为 APPMESH,并 containerName 配置为 envoy。相应地设置以下属性值。

IgnoredUID

Envoy 代理不会路由来自使用此用户 ID 的进程的流量。您可以为此属性值选择所需的任何用户 ID,但此 ID 必须与任务定义中的 Envoy 容器的 user ID 相同。此匹配允许 Envoy 忽略其自己的流量,而无需使用代理。出于历史原因,我们的示例使用 1337

ProxyIngressPort

这是 Envoy 代理容器的入口端口。将此值设置为 15000

ProxyEgressPort

这是 Envoy 代理容器的出口端口。将此值设置为 15001

AppPorts

指定您的应用程序容器在其上侦听的任何入口端口。在此示例中,应用程序容器在端口 9080 上侦听。您指定的端口必须与虚拟节点侦听器上配置的端口匹配。

EgressIgnoredIPs

Envoy 不会将流量代理至这些 IP 地址。将此值设置为 169.254.170.2,169.254.169.254,这会忽略 Amazon EC2 元数据服务器和 Amazon ECS 任务元数据终端节点。元数据终端节点为任务凭证提供 IAM 角色。您可以添加其他地址。

EgressIgnoredPorts

您可以添加以逗号分隔的端口列表。Envoy 不会将流量转发至这些端口。即使您没有列出任何端口,端口 22 也会被忽略。

"proxyConfiguration": { "type": "APPMESH", "containerName": "envoy", "properties": [{ "name": "IgnoredUID", "value": "1337" }, { "name": "ProxyIngressPort", "value": "15000" }, { "name": "ProxyEgressPort", "value": "15001" }, { "name": "AppPorts", "value": "9080" }, { "name": "EgressIgnoredIPs", "value": "169.254.170.2,169.254.169.254" }, { "name": "EgressIgnoredPorts", "value": "22" } ] }

应用程序容器 Envoy 依赖项

您的任务定义中的应用程序容器必须等待 Envoy 代理来引导和启动之后才能启动。为确保发生此情况,设置每个应用程序容器定义中的 dependsOn 部分以等待 Envoy 容器报告为 HEALTHY。以下代码显示了包含此依赖项的应用程序容器定义示例。以下示例中的所有属性都是必需的。某些属性值也是必需的,但某些属性值是可替换的

{ "name": "appName", "image": "appImage", "portMappings": [{ "containerPort": 9080, "hostPort": 9080, "protocol": "tcp" }], "essential": true, "dependsOn": [{ "containerName": "envoy", "condition": "HEALTHY" }] }

Envoy 容器定义

Amazon ECS 任务定义必须包含 App Mesh Envoy 容器映像。

  • me-south-1 and ap-east-1外的所有受支持区域。您可以将 us-west-2 替换为除 me-south-1 and ap-east-1 之外的任何区域。

    840364872350.dkr.ecr.region-code.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod
  • me-south-1 区域:

    772975370895.dkr.ecr.me-south-1.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod
  • ap-east-1 区域:

    856666278305.dkr.ecr.ap-east-1.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod

您必须使用 App Mesh Envoy 容器映像,直至 Envoy 项目团队将支持 App Mesh 的更改合并。有关更多详细信息,请参阅 GitHub roadmap issue

以下示例中的所有属性都是必需的。某些属性值也是必需的,但某些属性值是可替换的。Envoy 容器定义必须标记为 essential。Amazon ECS 服务的虚拟节点名称必须设置为 APPMESH_VIRTUAL_NODE_NAME 属性的值。user 设置的值必须与任务定义代理配置中的 IgnoredUID 值匹配。在此示例中,我们使用的是 1337。此处显示的运行状况检查等待 Envoy 容器正确引导,然后再向 Amazon ECS 报告其运行状况良好且已准备好启动应用程序容器。

以下代码显示 Envoy 容器定义示例。

{ "name": "envoy", "image": "840364872350.dkr.ecr.us-west-2.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod", "essential": true, "environment": [{ "name": "APPMESH_VIRTUAL_NODE_NAME", "value": "mesh/apps/virtualNode/serviceB" }], "healthCheck": { "command": [ "CMD-SHELL", "curl -s http://localhost:9901/server_info | grep state | grep -q LIVE" ], "startPeriod": 10, "interval": 5, "timeout": 2, "retries": 3 }, "user": "1337" }

示例任务定义

以下示例 Amazon ECS 任务定义显示如何将上述示例合并到 taskB 的任务定义中。本文分别提供了使用或不使用 AWS X-Ray 为两种 Amazon ECS 启动类型创建任务的示例。可根据需要更改可替换的 值,为此场景中名为 taskBv2taskA 的任务创建任务定义。用您的网格名称和虚拟节点名称替换 APPMESH_VIRTUAL_NODE_NAME 值,并用您的应用程序侦听的端口列表替换代理配置 AppPorts 值。以下示例中的所有属性都是必需的。某些属性值也是必需的,但某些属性值是可替换的

如果按照“凭证”部分中所述运行 Amazon ECS 任务,那么需要将现有任务 IAM 角色添加到示例中。

例 JSON for Amazon ECS task definition - Fargate launch type

{ "family" : "taskB", "memory" : "1024", "cpu" : "0.5 vCPU", "proxyConfiguration" : { "containerName" : "envoy", "properties" : [ { "name" : "ProxyIngressPort", "value" : "15000" }, { "name" : "AppPorts", "value" : "9080" }, { "name" : "EgressIgnoredIPs", "value" : "169.254.170.2,169.254.169.254" }, { "name": "EgressIgnoredPorts", "value": "22" }, { "name" : "IgnoredUID", "value" : "1337" }, { "name" : "ProxyEgressPort", "value" : "15001" } ], "type" : "APPMESH" }, "containerDefinitions" : [ { "name" : "appName", "image" : "appImage", "portMappings" : [ { "containerPort" : 9080, "protocol" : "tcp" } ], "essential" : true, "dependsOn" : [ { "containerName" : "envoy", "condition" : "HEALTHY" } ] }, { "name" : "envoy", "image" : "840364872350.dkr.ecr.us-west-2.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod", "essential" : true, "environment" : [ { "name" : "APPMESH_VIRTUAL_NODE_NAME", "value" : "mesh/apps/virtualNode/serviceB" } ], "healthCheck" : { "command" : [ "CMD-SHELL", "curl -s http://localhost:9901/server_info | grep state | grep -q LIVE" ], "interval" : 5, "retries" : 3, "startPeriod" : 10, "timeout" : 2 }, "memory" : "500", "user" : "1337" } ], "requiresCompatibilities" : [ "FARGATE" ], "taskRoleArn" : "arn:aws:iam::123456789012:role/ecsTaskRole", "executionRoleArn" : "arn:aws:iam::123456789012:role/ecsTaskExecutionRole", "networkMode" : "awsvpc" }

例 JSON for Amazon ECS task definition with AWS X-Ray - Fargate launch type

X-Ray allows you to collect data about requests that an application serves and provides tools that you can use to visualize traffic flow. Using the X-Ray driver for Envoy enables Envoy to report tracing information to X-Ray. You can enable X-Ray tracing using the Envoy configuration. Based on the configuration, Envoy sends tracing data to the X-Ray daemon running as a sidecar container and the daemon forwards the traces to the X-Ray service. Once the traces are published to X-Ray, you can use the X-Ray console to visualize the service call graph and request trace details. The following JSON represents a task definition to enable X-Ray integration.

{ "family" : "taskB", "memory" : "1024", "cpu" : "0.5 vCPU", "proxyConfiguration" : { "containerName" : "envoy", "properties" : [ { "name" : "ProxyIngressPort", "value" : "15000" }, { "name" : "AppPorts", "value" : "9080" }, { "name" : "EgressIgnoredIPs", "value" : "169.254.170.2,169.254.169.254" }, { "name": "EgressIgnoredPorts", "value": "22" }, { "name" : "IgnoredUID", "value" : "1337" }, { "name" : "ProxyEgressPort", "value" : "15001" } ], "type" : "APPMESH" }, "containerDefinitions" : [ { "name" : "appName", "image" : "appImage", "portMappings" : [ { "containerPort" : 9080, "protocol" : "tcp" } ], "essential" : true, "dependsOn" : [ { "containerName" : "envoy", "condition" : "HEALTHY" } ] }, { "name" : "envoy", "image" : "840364872350.dkr.ecr.us-west-2.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod", "essential" : true, "environment" : [ { "name" : "APPMESH_VIRTUAL_NODE_NAME", "value" : "mesh/apps/virtualNode/serviceB" }, { "name": "ENABLE_ENVOY_XRAY_TRACING", "value": "1" } ], "healthCheck" : { "command" : [ "CMD-SHELL", "curl -s http://localhost:9901/server_info | grep state | grep -q LIVE" ], "interval" : 5, "retries" : 3, "startPeriod" : 10, "timeout" : 2 }, "memory" : "500", "user" : "1337" }, { "name" : "xray-daemon", "image" : "amazon/aws-xray-daemon", "user" : "1337", "essential" : true, "cpu" : "32", "memoryReservation" : "256", "portMappings" : [ { "containerPort" : 2000, "protocol" : "udp" } ] } ], "requiresCompatibilities" : [ "FARGATE" ], "taskRoleArn" : "arn:aws:iam::123456789012:role/ecsTaskRole", "executionRoleArn" : "arn:aws:iam::123456789012:role/ecsTaskExecutionRole", "networkMode" : "awsvpc" }

例 JSON for Amazon ECS task definition - EC2 launch type

{ "family": "taskB", "memory": "256", "proxyConfiguration": { "type": "APPMESH", "containerName": "envoy", "properties": [ { "name": "IgnoredUID", "value": "1337" }, { "name": "ProxyIngressPort", "value": "15000" }, { "name": "ProxyEgressPort", "value": "15001" }, { "name": "AppPorts", "value": "9080" }, { "name": "EgressIgnoredIPs", "value": "169.254.170.2,169.254.169.254" }, { "name": "EgressIgnoredPorts", "value": "22" } ] }, "containerDefinitions": [ { "name": "appName", "image": "appImage", "portMappings": [ { "containerPort": 9080, "hostPort": 9080, "protocol": "tcp" } ], "essential": true, "dependsOn": [ { "containerName": "envoy", "condition": "HEALTHY" } ] }, { "name": "envoy", "image": "840364872350.dkr.ecr.us-west-2.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod", "essential": true, "environment": [ { "name": "APPMESH_VIRTUAL_NODE_NAME", "value": "mesh/apps/virtualNode/serviceB" } ], "healthCheck": { "command": [ "CMD-SHELL", "curl -s http://localhost:9901/server_info | grep state | grep -q LIVE" ], "startPeriod": 10, "interval": 5, "timeout": 2, "retries": 3 }, "user": "1337" } ], "requiresCompatibilities" : [ "EC2" ], "taskRoleArn" : "arn:aws:iam::123456789012:role/ecsTaskRole", "executionRoleArn" : "arn:aws:iam::123456789012:role/ecsTaskExecutionRole", "networkMode": "awsvpc" }

例 JSON for Amazon ECS task definition with AWS X-Ray - EC2 launch type

X-Ray allows you to collect data about requests that an application serves and provides tools that you can use to visualize traffic flow. Using the X-Ray driver for Envoy enables Envoy to report tracing information to X-Ray. You can enable X-Ray tracing using the Envoy configuration. Based on the configuration, Envoy sends tracing data to the X-Ray daemon running as a sidecar container and the daemon forwards the traces to the X-Ray service. Once the traces are published to X-Ray, you can use the X-Ray console to visualize the service call graph and request trace details. The following JSON represents a task definition to enable X-Ray integration.

{ "family": "taskB", "memory": "256", "cpu" : "1024", "proxyConfiguration": { "type": "APPMESH", "containerName": "envoy", "properties": [ { "name": "IgnoredUID", "value": "1337" }, { "name": "ProxyIngressPort", "value": "15000" }, { "name": "ProxyEgressPort", "value": "15001" }, { "name": "AppPorts", "value": "9080" }, { "name": "EgressIgnoredIPs", "value": "169.254.170.2,169.254.169.254" }, { "name": "EgressIgnoredPorts", "value": "22" } ] }, "containerDefinitions": [ { "name": "appName", "image": "appImage", "portMappings": [ { "containerPort": 9080, "hostPort": 9080, "protocol": "tcp" } ], "essential": true, "dependsOn": [ { "containerName": "envoy", "condition": "HEALTHY" } ] }, { "name": "envoy", "image": "840364872350.dkr.ecr.us-west-2.amazonaws.com/aws-appmesh-envoy:v1.12.5.0-prod", "essential": true, "environment": [ { "name": "APPMESH_VIRTUAL_NODE_NAME", "value": "mesh/apps/virtualNode/serviceB" }, { "name": "ENABLE_ENVOY_XRAY_TRACING", "value": "1" } ], "healthCheck": { "command": [ "CMD-SHELL", "curl -s http://localhost:9901/server_info | grep state | grep -q LIVE" ], "startPeriod": 10, "interval": 5, "timeout": 2, "retries": 3 }, "user": "1337" }, { "name": "xray-daemon", "image": "amazon/aws-xray-daemon", "user": "1337", "essential": true, "cpu": 32, "memoryReservation": 256, "portMappings": [ { "containerPort": 2000, "protocol": "udp" } ] } ], "requiresCompatibilities" : [ "EC2" ], "taskRoleArn" : "arn:aws:iam::123456789012:role/ecsTaskRole", "executionRoleArn" : "arn:aws:iam::123456789012:role/ecsTaskExecutionRole", "networkMode": "awsvpc" }