介绍

这些说明是为了让用户使用最新的稳定Docker镜像获取和运行EdgeX Foundry。

如果您希望获得EdgeX Docker映像的最新版本(在发布之前)，请参阅Getting Docker Images from EdgeX Nexus Repository - EdgeX Foundry Documentation

获取并运行EdgeX Foundry

安装Docker和Docker Compose

要运行Dockerized EdgeX，需要先安装Docker。请参阅Install Docker Engine | Docker Documentation了解如何安装Docker。如果您是Docker的新手，该网站还为您提供教育信息。下面的短视频也非常有用https://www.youtube.com/watch?time_continue=3&v=VhabrYF1nms  

使用Docker Compose来编排获取(或提取)、安装和启动EdgeX微服务容器。还要使用Docker Compose来停止微服务容器。请参阅Docker Compose overview | Docker Documentation了解有关Docker Compose的更多信息，并参阅Install the Compose plugin | Docker Documentation安装它。

你不需要成为Docker(或Docker Compose)的专家来获取和运行EdgeX。本指南提供了在您的环境中运行EdgeX的步骤。有一些Docker和Docker Compose的知识是很好的，但不是必需的。这里提供的基本Docker和Docker Compose命令使您能够在EdgeX中运行、更新和诊断问题。

选择一个EdgeX foundry Compose文件

在安装了Docker和Docker Compose之后，你需要一个EdgeX Docker Compose文件。EdgeX Foundry有十几个微服务，每个都部署在自己的Docker容器中。该文件是要运行的所有EdgeX Foundry微服务的清单。Docker Compose文件提供了如何运行每个服务的详细信息。具体来说，Docker撰写文件是一个清单文件，其中列出:

应该下载的Docker容器映像;
启动容器的顺序，
应该在其下运行容器的参数(如端口)
EdgeX开发团队为每个版本提供Docker Compose文件。访问项目的GitHub并找到edgex-compose存储库。这个存储库保存了每个EdgeX发行版/版本的所有EdgeX Docker Compose文件。每个版本的Compose文件位于不同的分支中。单击main按钮查看所有分支。

• 你的硬件（x86或者ARM）
• 你是否需要安全服务

文件名	Docker Compose 内容
docker-compose-arm64.yml	指定ARM64容器，使用Redis数据库进行持久化，并包含安全服务
docker-compose-no-secty-arm64.yml	指定ARM64容器，使用Redis数据库进行持久化，但不包括安全服务
docker-compose-no-secty.yml	指定x86容器，使用Redis数据库进行持久化，但不包括安全服务
docker-compose.yml	指定x86容器，使用Redis数据库进行持久化，包括安全服务
docker-compose-no-secty-with-ui-arm64.	与docker- composition-no-secty-arm64相同。还包括EdgeX用户界面
docker-compose-no-secty-with-ui.yml	与docker- composition-no-security相同。还包括EdgeX用户界面
docker-compose-portainer.yml	指定Portainer用户界面扩展名(用于x86或ARM EdgeX平台)

下载EdgeX Foundry撰写文件

一旦您选择了想要使用的edgex-compose的发布分支，请使用您最喜欢的工具下载它。下面的例子使用wget来获取爱尔兰版本的Docker Compose，没有安全性。

x86：

wget https://raw.githubusercontent.com/edgexfoundry/edgex-compose/ireland/docker-compose-no-secty.yml -O docker-compose.yml

ARM64：

wget https://raw.githubusercontent.com/edgexfoundry/edgex-compose/ireland/docker-compose-no-secty-arm64.yml -O docker-compose.yml

请注意：上面的命令将Docker Compose获取到一个名为“docker - compose.yml”的文件中。Docker Compose命令查找名为“docker - compose.yml”的文件。您可以使用另一个文件名，但是在发出Docker Compose命令时必须指定该文件名。有关帮助，请参阅Overview of docker compose CLI | Docker Documentation。

生成一个自定义Docker Compose文件

爱尔兰分支中的Docker Compose文件包含了一组标准的EdgeX服务，这些服务被配置为使用Redis消息总线，并且只包括Virtual和REST设备服务。如果需要运行不同的设备服务或为消息总线使用MQTT，则需要一个标准Docker Compose文件的修改版本。您可以手动将设备服务添加到现有的EdgeX Compose文件之一，或者使用EdgeX Compose Builder工具生成一个新的自定义Compose文件，其中包含您想要包含的服务。当您使用Compose Builder时，您不必担心添加所有必要的端口、变量等，因为该工具将在文件中为您生成服务元素。撰写生成器工具是随河内版本一起添加的。您将在自Hanoi以来的每个发布分支的composition - Builder文件夹下找到Compose Builder工具。您还可以在主分支上找到一个Compose -builder文件夹，用于为夜间构建创建自定义Compose文件。

执行以下操作，使用此工具生成自定义撰写文件:

1、克隆edgex-compose存储库。

git clone https://github.com/edgexfoundry/edgex-compose.git

2. 将目录更改为克隆并签出适当的发布分支。爱尔兰发布分支的签出如图所示

cd edgex-compose/

git checkout kamakura

3.将目录更改为compose-builder文件夹，然后使用make gen <options>命令生成自定义撰写文件。生成的Docker Compose文件名为Docker - Compose .yaml。下面是一些例子:

cd compose-builder/
make gen ds-mqtt mqtt-broker
-生成安全的Compose文件，配置为为消息总线使用MQTT，然后添加MQTT代理和设备MQTT服务。

make gen no-secty ds-modbus
-仅使用Device Modbus设备服务生成非安全组合文件。

make gen no-secty arm64 ds-grove
-仅使用Device Grove设备服务为ARM64生成非安全组合文件。

Edgex 2.2(Kamakura)的新功能是TUI生成器工具，它引导用户生成和运行自定义撰写文件。在Linux终端中，从composer -builder文件夹中运行./tui-generator.sh，并从菜单中进行选择。

有关所有可用选项的详细信息，请参阅composer -builder目录中的README文档。每个版本的Compose Builder都是不同的，所以一定要在相应的发布分支中查阅README。有关最新版本的make gen的Compose Builder选项的详细信息，请参阅爱尔兰的Compose Builder README

运行EdgeX Foundry

现在有了EdgeX Docker Compose文件，就可以运行EdgeX了。按照以下步骤获取容器映像并启动EdgeX!

在命令终端中，将目录更改为docker- composer .yml所在的位置。在终端上执行以下命令拉取(fetch)，然后启动EdgeX容器。

docker-compose up -d

如果您愿意，可以先获取图像，然后再运行它们。这允许您在尝试运行之前确保所需的EdgeX图像全部可用。
docker-compose pull
docker-compose up -d

验证EdgeX Foundry运行

在同一终端中，运行如下所示的process status命令，确认所有容器都已下载并启动。

docker-compose ps

 如果所有的EdgeX容器都正确地拉出并启动，并且没有错误，那么您应该看到一个类似于上图的进程状态(ps)。如果使用自定义Compose文件，则容器列表可能会有所不同。还要注意，一些“设置”容器被设计为在配置EdgeX实例后启动然后退出。

检查EdgeX Foundry的状态

除了EdgeX容器的进程状态之外，还有许多其他工具可以检查EdgeX实例的运行状况和状态。

EdgeXfoundry 容器日志

使用下面的命令查看任何服务的日志。

# 查看服务日志
docker-compose logs -f [compose-service-name]
# core data 为例
docker-compose logs -f data

请参阅EdgeX容器名称Quick Start - EdgeX Foundry Documentation查看EdgeX Docker Compose服务名称列表

检查EdgeX服务日志通常可以显示服务是否正常运行或出现错误。

检查完日志内容后，选择Control-c停止向终端输出。

Ping 检查

每个EdgeX微服务都有一个内置的对“ping”HTTP请求的响应。在网络环境中，使用ping请求来检查网络资源的可达性。EdgeX使用相同的概念来检查微服务的可用性或可达性。在EdgeX微服务容器运行之后，您可以“ping”任何一个微服务以检查它是否正在运行。打开浏览器或HTTP REST客户端工具，并使用服务的ping地址(如下所示)检查是否可用。

http://localhost:[service port]/api/v2/ping

EdgeX默认服务端口列表请参见Default Service Ports - EdgeX Foundry Documentation。

“ping”一个EdgeX微服务允许你检查它的可用性。如果服务没有响应ping，则表示服务已关闭或存在问题。

Consul注册表检查

EdgeX使用开源Consul项目作为其注册服务。所有EdgeX微服务在启动时都要向Consul注册。转到Consul的仪表板UI可以让您查看哪些服务启动了。在http://localhost:8500/ui上找到Consul UI。

注意：当EdgeX使用安全Consul以安全模式运行时，必须提供Consul的访问令牌才能访问上面引用的仪表板UI。有关详细信息，请参见如果获取Consul ACL 令牌Secure Consul - EdgeX Foundry Documentation。