YurtIoTDock
背景介绍
OpenYurt擅长以非侵入的方式，实现云边资源的统一管理和运维，使得边缘节点拥有云端相同的能力。但随着将相关纳管能力拓展至“端”这一层时，由于近端设备异构资源支持复杂、通信方式多样、分布位置分散等特点，会出现以下问题：
- 为了支持各种边缘设备，现有的OpenYurt框架必须为每个类别的设备开发专用的适配器；
- 在直接纳管端设备的过程中，现有解决方案要么改变Kubernetes架构，要么显著修改核心组件，丢失一些上游K8S特性的同时，与OpenYurt的非侵入式理念相悖。
与此同时，我们也发现社区里涌现了许多优秀的边缘设备管理平台，如：EdgeX Foundry。受到Unix哲学“Do one thing, and do it well”的启发，OpenYurt将复杂端设备的管理交由成熟的物联网设备管理平台，并通过抽象与设备相关的资源与服 务，以及部署yurt-iot-dock组件，来打通边缘设备管理平台和云端之间的运维管理通道，允许用户声明式地管理边缘设备，为用户提供 Kubernetes 原生管理端设备的体验。
下面是云边端三者整体的架构模型：
边缘端设备的通信范围往往局限于某一网络区域内，因此可以将同一网络区域内的边缘节点划分为一个节点池，当用户部署一个PlatformAdmin资源到某个节点池后，yurt-manager会在该节点池部署一个端设备管理平台和一个yurt-iot-dock组件：
- 在与云端apiserver的通信中，yurt-iot-dock只会监听属于该节点池内的设备对象，并将更新信息通过端设备管理平台及时地同步至对应的设备上；
- 在与端设备管理平台的通信中，复用YurtHub、节点池以及单元化部署等能力，yurt-iot-dock组件只会访问本节点池内的端设备管理平台，并将接入该节点池内的设备信息抽象为device、deviceService和deviceProfile对象同步至云端；
边缘设备管理平台
EdgeX Foundry 是一款由生态系统提供强力支持的边缘物联网即插即用型、开放式软件平台。它具有高度灵活和可扩展性，可以大大的降低应用与边缘设备，传感器等硬件互操作的复杂性。OpenYurt 与 EdgeX Foundry社区合作，在1.4.0版本完成了深度集成，除了yurt-iot-dock，还提供了PlatformAdmin这个CRD以简化edgex foundry在边缘场景下的部署工作。
结合上述的云边端架构图，OpenYurt与EdgeX Foundry集成的架构图如下：
PlatformAdmin
在之前的版本中，OpenYurt 引 入了一个yurt-edgex-controller的控制器来管理EdgeX CR。EdgeX CR是对EdgeX Foundy在OpenYurt中部署的一个抽象，用户可以操作CR的方式来管理EdgeX的部署，更新，删除。不再需要写复杂的Yaml文件以及Helm Chart。用户只需要创建一个EdgeX的CR，Yurt-edgex-manager会根据CR中版本以及对应的Nodepool的名字部署EdgeX。用户在一个集群中可以根据nodepool的数量部署多个EdgeX，每个EdgeX的版本，以及包括的EdgeX 服务可以配置。
在OpenYurt v1.4.0后，yurt-edgex-controller合入yurt-manager中，用户不需要再额外部署任何组件，只需要安装yurt-manager即可拥有所有的端设备管理能力。
- PlatformAdmin：PlatformAdmin从之前版本的EdgeX CRD演进而来，是边缘设备管理平台的抽象，用户只需要输入设置接入的平台、需要部署的NodePool的名字、需要部署的版本等等，就可以在节点池部署一套边缘设备管理平台
- AutoCollector：OpenYurt内部实现与EdgeX适配的工具，Jakarta之后的版本（以及最新的minnesota）均使用该工具自动化适配，未来OpenYurt会继续依赖AutoCollector进行EdgeX版本的快速适配
- Component机制：在v1.4.0版本中我们进一步增强了与EdgeX的融合，目前的PlatformAdmin CR支持一键配置可选组件，组件名参考Component文档
- PlatformAdminFramework：在v1.4.0版本中我们为入门级用户提供了Component机制，同时为了照顾到需要自定义配置的高端用户，我们也提供了一套Framework机制。PlatformAdmin对应的配置文件以configmap的形式存储于k8s集群中，高级用户只需要修改configmap中的内容（遵守k8s原生规范），即可 自定义边缘设备管理平台
在OpenYurt中，EdgeX的服务通过以Kubernetes服务的形式来对外提供访问，尽管不同的EdgeX实例使用相同Kubernates服务名称，ServiceToploy会确保EdgeX组件只能访问属于同一EdgeX实例的其他组件，而不会发生交叉访问的情况。platformadmin-controller利用yurtappset的能力，在nodepool中部署EdgeX的组件。
AutoCollector
AutoCollector是一个自动收集和同步关于边缘组件信息的组件。platformadmin-controller将读取AutoCollector收集的标准化的配置文件，并将该配置文件作为模板来部署edgex组件。当出现新版本的edgex时，openyurt自动与之同步，减少了频繁适应新版本的人力消耗。除此之外，AutoCollector还负责将edgex组件的单架构镜像转化为多架构镜像，并将其同步到openyurt的仓库中。
通过AutoCollector，我们已经支持edgex从Hanoi开始的所有版本，未来会继续通过它来快速跟进edgex的版本更新。
PlatformAdmin版本
| 版本号 | 镜像地址 | 发布时间 | 发布内容 | 备注 |
|---|---|---|---|---|
| v0.1.0 | openyurt/yurt-edgex-manager:v0.1.0 | 2021.09 | 首次发布 | 支持 edgex foundry Hanoi 版本 |
| v0.2.0 | openyurt/yurt-edgex-manager:v0.2.0 | 2022.06 | 支持Hanoi和Jakarta版本 | - |
| v1.4.0 | openyurt/yurt-manager:v1.4.0 | 2023.09 | 支持2.x到3.0所有版本 | yurt-edgex-manager合入yurt-manager |
边缘设备同步组件
设备管理相关CRDs
为管理现实世界中的 设备，需要对设备管理相关的服务进行抽象，yurt-iot-dock作为连通云和边缘管理平台的组件，抽象出了三个CRD，用于表示和管理对应设备管理平台上的资源，从而影响现实世界中的设备，它们分别是deviceProfile、deviceService和device：
-
DeviceProfile：设备配置文件描述了使用相同协议的一种设备类型，其中包括一些通用信息，如制造商名称、设备描述和设备型号。 DeviceProfile 还定义了此类设备提供的资源类型（例如，温度、湿度）以及如何读取/写入这些资源。每个device都需要关联一个device profile；
-
DeviceService：是针对与设备交互的边缘连接器的抽象，定义了如何将设备接入到边缘设备管理平台，包括设备的通信协议，通信地址等信息。每个device都需要关联一个device service；
-
Device：是针对现实世界中端设备的抽象，例如：电器、警报系统、暖通空调设备、照明、传感器等设备，它给出了特定设备的详细定义，包括关联的 DeviceProfile（属于哪类设备） 、关联的 DeviceService（使用何种通信方式）以及设备特有属性（如照明设备的开关状态等）。
设备管理架构
通过抽象出上述三种CRD，可以反应出设备基本的状态信息，再使用对应的controller与边缘设备管理平台进行交互，可以将边侧发现的端设备及时映射至云端；与此同时，yurt-iot-dock组件将云端针对设备属性的修改（例如：设置照明设备的开关状态）同步至端设备上，从而影响真实世界中的物理设备。用户只需要声明式地修改CRs的相应字段，以一种云原生的方式即可达到运维、管理复杂端设备的目的，下面是组成yurt-iot-dock的三个组件：
- DeviceProfile controller: 它可以将边缘平台中的 deviceProfile 对象抽象为 deviceProfile CR 并同步到云端。在deviceProfile Controller的支持下，用户可以在云端查看边缘平台的deviceProfile信息，创建或删除deviceProfile CR来影响边缘平台的实际deviceProfile。
- DeviceService controller: 它可以将边缘平台中的 deviceService 对象抽象为 deviceService CR 并同步到云端。在deviceService Controller的支持下，用户可以在云端查看边缘平台的deviceService信息，创建或删除deviceService CR来影响边缘平台的实际deviceService。
- Device controller: 它可以将边缘平台中的device对象抽象为device CR并同步到云端。在设备控制器的支持下，用户可以声明式修改云端device CR来影响边缘平台上的实际设备，如创建设备、删除设备、更新设备属性（如设置灯的开和关等）。
Yurt-IoT-Dock版本
| 版本号 | 镜像地址 | 发布时间 | 发布内容 | 备注 |
|---|---|---|---|---|
| v0.1.0 | openyurt/yurt-device-controller:v0.1.0 | 2021.09 | 首次发布 | - |
| v0.2.0 | openyurt/yurt-device-controller:v0.2.0 | 2022.06 | 支持2.x | - |
| v1.4.0 | openyurt/yurt-iot-dock:v1.4.0 | 2023.09 | 合入主仓库 | - |
| latest | openyurt/yurt-iot-dock:latest | 2023.09 | 增加edgex 3.0支持 | - |
使用教程
yurt-iot-dock作为PlatformAdmin CR的组件使用，只要在PlatformAdmin中增加即可部署到对应节点池，比如
apiVersion: iot.openyurt.io/v1alpha2
kind: PlatformAdmin
metadata:
name: edgex-sample
spec:
version: minnesota
poolName: hangzhou
components:
- name: yurt-iot-dock
同样，在components中移除掉yurt-iot-dock就可以取消对应节点池中yurt-iot-dock的部署。
具体的步骤请参考云原生管理端设备