EdgeXFoundry Users入门手册

文章是在官方英文手册的基础上进行翻译制作的，原文地址DegeXFoundry，侵删

一、 简介

• 以下说明是供用户获取和运行EdgeX Foundry使用的 ，如果你需要开发或者为EdgeXFoundry贡献源码，请阅读EdgeXFoundry开发者入门 developers

• EdgeX Foundry是一个超过12个微服务的集合，它们被部署来提供最小的edge平台能力。EdgeX Foundry的微服务源代码可以下载并构建到部署构件中，但如果您不是开发人员，或者如果您没有“本地”运行EdgeX Foundry的特定需求，则不需要下载源代码。

• 用户可以更容易地选择使用Docker并且在Docker容器中运行EdgeX Foundry。EdgeX Foundry微服务在新代码签入源存储库时被自动构建和封装。因此，Dockerized EdgeX Foundry不仅更容易获得并部署到您的环境中，而且还可以拥有最新的EdgeX Foundry微服务(取决于用于获得微服务的容器注册表)。

• 要获得并运行EdgeX Foundry，请执行以下步骤:
  

二、平台要求

EdgeX Foundry是一个操作系统(OS)不可知和硬件(HW)不可知的物联网边缘平台。虽然仍在制订最低平台要求，但目前建议下列选择:

• 内存:最小1 GB
• 硬盘空间:运行EdgeX Foundry容器的最小3 GB空间，但您可能需要更多空间，这取决于要保留传感器和设备数据的时间
• 操作系统:EdgeX Foundry已经在许多系统上成功运行，包括但不限于以下系统
  • Windows (ver 7 - 10)
  • Ubuntu桌面(14-16版)
  • Ubuntu服务器(ver 14)
  • Ubuntu核心(第16版)
  • Mac OS X 10

三、 获取&运行EdgeX Foundry

3.1 安装docker和docker-compose

• 要运行Dockerized EdgeX Foundry，需要安装Docker。查看docker了解如何获取和安装Docker。如果您是使用Docker的新手，该网站还提供了其他信息。下面的短视频也非常有用油管视频

• Docker-compose用于编排EdgeX Foundry微服务容器的获取(或拉)、安装和启动和停止。参见docker-compose了解更多关于Docker Compose的信息。

• 你不需要成为Docker的专家，以获得和运行EdgeX铸造。本指南中的说明提供了在您的环境中运行EdgeX Foundry的步骤。了解Docker和Docker组合这两种技术是很好的，但不是必需的。基本Docker和Docker编写命令，使您能够运行，更新，并诊断EdgeX Foundry的问题。

3.2 下载EdgeX Foundry的docker-compose文件

• 安装Docker和Docker Compose之后，您需要Docker Compose文件，该文件是所有EdgeX Foundry微服务的清单。EdgeX Foundry在一个典型的EdgeX Foundry部署中有超过12个微服务，每个微服务都部署在它们自己的Docker容器中。

• 如果你了解Docker，了解EdgeX Foundry的架构和它的微服务，你可以手动发出Docker命令来下载和运行自己的每个EdgeX Foundry容器。在某些情况下，特别是在开发情况下，您需要手动控制，尽管手动发出命令可能有点乏味。如果您需要对下载和运行EdgeX Foundry microservices有更多的控制，本文档集中提供了更多的说明。

• 获取和运行EdgeX Foundry microservices也可以更容易地完成，只要你有Docker合成文件，指定Docker/Docker合成你想要的容器，以及你想如何运行这些容器。EdgeX Foundry开发团队通过EdgeX Foundry GitHub存储库为每个版本提供Docker撰写文件。要获得并运行EdgeX Foundry，请访问项目GitHub并下载(或复制内容)适合您希望使用的版本的EdgeX Foundry Docker撰写文件到本地目录。 地址： https://github.com/edgexfoundry/developer-scripts/tree/master/releases

• Docker撰写文件是一个清单文件，它列出:

  • 应该下载的Docker容器(或者更准确地说是Docker容器图像)
  • 容器启动的顺序
  • 应该在其下运行容器的参数

3.3 启动EdgeX Foundry

• 首先将上一步下载的docker-compose文件命名为docker-compose.yml
• 然后在docker-compose.yml所在文件夹打开终端
• 使用下面命令拉取所有镜像到本地

docker-compose pull

• 拉取镜像结束后，使用以下命令启动EdgeX

docker-compose up -d

• 在某些情况下，您可能希望使用Docker Compose一次打开一个容器。如果您是一名开发人员，或者您不希望打开所有的EdgeX(可能因为您只使用少数服务)，您可以发出Docker Compose命令来分别拉取和启动每个EdgeX容器。因为一些容器依赖于其他容器，所以应该尝试以特定的顺序启动它们。下表按照每个EdgeX微服务应该启动的顺序(基于它们之间的依赖关系)为您提供了启动它们的命令。

Docker Command	Description	Notes
docker-compose pull	Pull down, but don’t start, all the EdgeX Foundry microservices	Docker Compose will indicate when all thecontainers have been pulled successfully
docker-compose up -d volume	Start the EdgeX Foundry file volume–must be done before the other servicesare started
docker-compose up -d consul	Start the configuration and registry microservice which all services mustregister with and get their configuration from
docker-compose up -d config-seed	Populate the configuration/registry microservice
docker-compose up -d mongo	Start the NoSQL MongoDB container	An embedded initialization script configuresthe database for EdgeX documents
docker-compose up -d logging	Start the logging microservice - used by all micro services that make log entries
docker-compose up -d notifications	Start the notifications and alerts microservice–used by many of the microservices
docker-compose up -d metadata	Start the Core Metadata microservice
docker-compose up -d data	Start the Core Data microservice
docker-compose up -d command	Start the Core Command microservice
docker-compose up -d scheduler	Start the scheduling microservice -used by many of the microservices
docker-compose up -d rulesengine	Start the Rules Engine microservice	This service is still implemented in Javaand takes more time to start
docker-compose up -d device-virtual	Start the virtual device serviceThis service mocks a sensor sending data to EdgX and is used for demonstration

• 运行“docker-compose ps”命令，以确认所有容器都已下载并启动。(注意:初始化或种子容器，如config-seed，将退出，因为那里的作业只是初始化关联的服务，然后退出。)
  

四、停止并删除EdgeX Foundry

要停止所有的EdgeX Foudry容器，使用

docker-compose down

Docker显示被停止和移除的容器。注意，您可能希望停止(而不是停止并删除)所有EdgeX容器。更多细节请参见下面的高级EdgeX Foundry用户命令。

在此操作之后，调用docker-compose ps将显示没有正在运行的或可用的容器。

五、高级EdgeX Foundry用户命令

在您掌握了获取和运行EdgeX Foundry之后，您可能想要更多地控制EdgeX Foundry微服务。以下这些命令为您提供了这样做的能力。

5.1 拉取镜像

拉取镜像使用“docker-compose pull”下载撰写文件中列出的所有容器图像。

“docker-compose pull [compose-container-name]”从撰写文件下载一个特定的容器图像名称。

5.2 查看镜像列表

要获得Docker组合容器的名称的列表(就像它们在Docker组合中一样)。运行“docker-compose config -services”，如下所示

5.3 启动容器

使用“docker-compose start”重新启动所有处于停止状态的容器

或“docker-compose - start [compose-container-name]”来启动一个单独的容器(在该容器已经停止之后)。在这里，卷容器启动。

5.4 停止容器

要停止单个容器，可以使用docker-compose stop [compose-container-name]。停止的容器可以再次启动(使用上面的docker-compose - start)

停止所有的容器，使用docker-compose stop

5.5 停止并删除容器

docker-compose down命令停止并且删除所有容器，其中docker-compose stop只是停止容器，但不删除容器映像。例如，如果在docker-compose停止后运行docker ps -a，仍然会看到容器映像处于“exited”状态。

六、检查EegeX Foundry的状态

6.1 docker容器状态检查

• 从终端中，使用docker-compose ps获取已存在和正在运行的容器列表。另外，标准的docker命令(docker ps -a)也可以提供正在运行的容器列表。
  
• 标准docker命令(docker ps -a)还指示容器何时启动、运行了多长时间以及许多其他细节。可以使用-format选项只保留列表中的相关信息。

• 查看容器log

要查看任何容器的日志，使用命令

docker-compose logs -f [compose-containers -name]

下面的示例显示了数据容器的日志

6.2 微服务ping检测

• 每个EdgeX Foundry微服务都被构建以响应一个ping HTTP请求。网络环境中使用ping请求或ping实用程序来检查网络资源的可触及性。EdgeX Foundry使用相同的概念来检查微服务资源的可用性或可触及性。在EdgeX Foundry微服务容器运行之后，您可以ping任何一个微服务，以检查它是否正在运行。打开浏览器或HTTP REST客户端工具，并使用服务的ping地址(http://[host]:[port]/api/v1/ping)查看它是否可用。下面，对Core Data微服务进行ping。
  
• 下面是EdgeX Foundry微服务、它们的端口和“ping”url的列表。
  
  上述url的“host”地址由Docker引擎决定。默认的Docker引擎IP地址因操作系统的不同而不同(可以在您的系统上配置它，请参阅Docker文档了解详细信息)。

6.3 EdgeXFoundry Consul Registry

EdgeX Foundry使用开源的Consul项目作为它的注册服务。所有EdgeX Foundry微服务都需要在领事登记处登记。进入领事的仪表盘UI，地址（ http://[host]:8500/ui ），您可以看到哪些服务已经启动。