EdgeXFoundry详细说明文档英文_开源边缘计算框架

edgex

需积分: 42 22 浏览量更新于2023-03-03 评论 1 收藏 16.4MB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

资源详情

资源评论

资源推荐

Welcome to the EdgeX Foundry documentation

EdgeX Foundry documentation V1.1.0 
/  309 
 
Contents 
Welcome to the EdgeX Foundry documentation ...........................................................................................................1 
Quick Start ...............................................................................................................................................................................9 
1. Setup .............................................................................................................................................................................9 
2. Running EdgeX ...........................................................................................................................................................9 
3. Connecting a Device .............................................................................................................................................. 10 
4. Connecting an Application ................................................................................................................................... 11 
5. Controlling the Device ........................................................................................................................................... 12 
6. Next Steps ................................................................................................................................................................ 15 
Introduction.......................................................................................................................................................................... 16 
1. Definitions: “South Side” and “North Side” ...................................................................................................... 16 
2. EdgeX Foundry Architectural Tenets ................................................................................................................. 17 
3. EdgeX Foundry Service Layers ............................................................................................................................ 17 
4. Core Services Layer ................................................................................................................................................ 18 
5. Supporting Services Layer .................................................................................................................................... 19 
6. Export Services Layer ............................................................................................................................................. 20 
7. Device Services Layer ............................................................................................................................................. 21 
8. System Services Layer ............................................................................................................................................ 22 
EdgeX Foundry Microservices Architecture.................................................................................................................. 24 
1. Core Services Microservices¶ ........................................................................................................................................ 25 
1.1. Configuration and Registry ........................................................................................................................................ 26 
1.1.1. Introduction ....................................................................................................................................................... 26 
1.1.1.1. Configuration ........................................................................................................................................ 26 
1.1.2. Registry ............................................................................................................................................................... 29 
1.1.2.1. Introduction to Registry ...................................................................................................................... 29 
1.1.2.2. Web User Interface .............................................................................................................................. 30 
1.1.2.3. Running on Docker .............................................................................................................................. 31 
1.1.2.4. Running on Local Machine ................................................................................................................ 31 
1.2. Core Data ....................................................................................................................................................................... 33 
1.2.1. Introduction ....................................................................................................................................................... 33 
1.2.2. Core Data “Streaming” .................................................................................................................................... 34 
1.2.3. Data Model ........................................................................................................................................................ 34 
1.2.4. Data Dictionary ................................................................................................................................................. 35 
1.2.5. High Level Interaction Diagrams .................................................................................................................. 35 
1.3. Metadata ........................................................................................................................................................................ 37 
1.3.1. Introduction ....................................................................................................................................................... 37 
1.3.1.1. Data Models .......................................................................................................................................... 40 
1.3.2. Data Dictionary ................................................................................................................................................. 44 
1.3.3. High Level Interaction Diagrams .................................................................................................................. 45 
1.4. Command ...................................................................................................................................................................... 48 
1.4.1. Introduction ....................................................................................................................................................... 48 
1.4.2. Data Dictionary ................................................................................................................................................. 49 
1.4.3. High Level Interaction Diagrams .................................................................................................................. 49 

EdgeX Foundry documentation V1.1.0 
/  309 
 
2. Supporting Services Microservices .............................................................................................................................. 51 
2.1. Alerts & Notifications .................................................................................................................................................. 52 
2.1.1. Introduction ....................................................................................................................................................... 52 
2.1.2. Data Model ........................................................................................................................................................ 54 
2.1.3. Data Dictionary ................................................................................................................................................. 54 
2.1.4. High Level Interaction Diagrams .................................................................................................................. 55 
2.1.5. Configuration Properties ................................................................................................................................ 59 
2.1.6. Configure Mail Server ..................................................................................................................................... 60 
2.1.6.1. Gmail ....................................................................................................................................................... 60 
2.1.6.2. Yahoo Mail ............................................................................................................................................. 61 
2.2. Logging ........................................................................................................................................................................... 62 
2.2.1. Introduction ....................................................................................................................................................... 62 
2.2.2. Minimum Product Feature Set ...................................................................................................................... 62 
2.2.3. High Level Design Architecture .................................................................................................................... 63 
2.2.4. Configuration Properties ................................................................................................................................ 64 
2.2.5. Logging Service Client Library for Go ......................................................................................................... 65 
2.2.6. EdgeX Logging Keys ........................................................................................................................................ 67 
2.3. Scheduling ..................................................................................................................................................................... 68 
2.3.1. Introduction ....................................................................................................................................................... 68 
2.3.2. Data Dictionary ................................................................................................................................................. 69 
2.4. Rules Engine .................................................................................................................................................................. 70 
2.4.1. Reference Implementation ............................................................................................................................ 70 
2.4.2. Rules Engine as Export Service Client ......................................................................................................... 70 
2.4.3. Rules Engine Direct Connect to Core Data ................................................................................................ 71 
2.4.4. Rules Client and High Level Interaction Diagram .................................................................................... 72 
2.4.5. Rules (Defined), and Data Model ................................................................................................................. 73 
2.4.6. Rules Engine Configuration ........................................................................................................................... 76 
2.4.7. Data Dictionary ................................................................................................................................................. 78 
3. System Management ...................................................................................................................................................... 79 
3.1. Introduction .......................................................................................................................................................... 79 
3.2. The System Management Agent ..................................................................................................................... 80 
3.3. Micro Service Management API ...................................................................................................................... 81 
3.3.1. System Management Agent (SMA) ...................................................................................................................... 82 
3.3.1.1. Introduction .................................................................................................................................................... 82 
3.3.1.2. Examples of API Calls ................................................................................................................................... 82 
3.3.1.2.1. Metrics of a service ........................................................................................................................... 82 
3.3.1.2.2. Configuration of a service ............................................................................................................... 83 
3.3.1.2.3. Start a service ..................................................................................................................................... 86 
3.3.1.2.4. Stop a service ..................................................................................................................................... 86 
3.3.1.2.5. Restart a service ................................................................................................................................ 87 
3.3.1.2.6. Health check on a service ............................................................................................................... 88 
4. Security............................................................................................................................................................................... 89 
4.1. Secret Store ................................................................................................................................................................... 90 
4.1.1. Start the Secret Store ...................................................................................................................................... 91 

EdgeX Foundry documentation V1.1.0 
/  309 
 
4.1.1.1. Troubleshooting steps ........................................................................................................................ 92 
4.1.1.2. Using Consul Web UI ........................................................................................................................ 101 
4.1.1.3. Shell Access to Consul Container and Using Consul CLI .......................................................... 106 
4.1.2. Configuring the Secret Store ....................................................................................................................... 106 
4.1.3. Using the Secret Store .................................................................................................................................. 110 
4.1.3.1.  1st  alternative:  executing  a  shell  session  in  the  active  Vault  container  to  run  Vault  CLI 
commands. ............................................................................................................................................................ 110 
4.1.3.2. 2nd alternative: using the Vault Web UI. ...................................................................................... 114 
4.1.3.3. 3rd alternative: directly using the Vault HTTP API with cURL commands............................ 116 
4.1.4. See also ............................................................................................................................................................. 119 
4.2. API Gateway ................................................................................................................................................................ 119 
4.2.1. Start the API Gateway ................................................................................................................................... 119 
4.2.2. Configuring API Gateway ............................................................................................................................. 121 
4.2.3. Using API Gateway ......................................................................................................................................... 122 
4.3. Access EdgeX REST resources ................................................................................................................................. 126 
4.4. Starting security services within EdgeX ................................................................................................................. 126 
4.5. Security Issues ............................................................................................................................................................. 127 
4.5.1. Security Announcements ............................................................................................................................. 127 
4.5.2. Vulnerability Reporting ................................................................................................................................. 127 
4.5.2.1. When to Report a Vulnerability? .................................................................................................... 127 
4.5.2.2. When NOT to Report a Vulnerability? .......................................................................................... 127 
4.5.3. Security Vulnerability Response.................................................................................................................. 128 
4.5.4. Public Disclosure Timing .............................................................................................................................. 128 
5. Export Services Microservices ..................................................................................................................................... 129 
5.1. Client Registration ...................................................................................................................................................... 130 
5.1.1. Introduction ..................................................................................................................................................... 130 
5.1.2. Data Model ...................................................................................................................................................... 133 
5.1.3. Data Dictionary ............................................................................................................................................... 133 
5.1.4. High Level Interaction Diagram .................................................................................................................. 134 
5.1.5. Client Registration Details ............................................................................................................................ 134 
5.2. Distribution .................................................................................................................................................................. 136 
5.2.1. Introduction ..................................................................................................................................................... 136 
5.2.2. Client Registration and Distro Service Cooperation .............................................................................. 137 
5.2.3. High Level Interaction Diagram .................................................................................................................. 138 
5.2.4. Data Dictionary ............................................................................................................................................... 139 
5.2.5. The Pipe and Filter ......................................................................................................................................... 139 
5.3. Google IoT Core ......................................................................................................................................................... 142 
6. Application Services Microservices ........................................................................................................................... 145 
6.1. Application Services ................................................................................................................................................... 146 
6.1.1. Export Service Deficiencies .......................................................................................................................... 147 
6.1.2. Application Service Improvements ............................................................................................................ 147 
6.1.3. Standard Functions ........................................................................................................................................ 147 
6.1.4. Examples .......................................................................................................................................................... 149 
6.1.4.1. Unsupported existing export service functions .......................................................................... 149 

EdgeX Foundry documentation V1.1.0 
/  309 
 
6.2. Application Functions SDK (GoLang) .................................................................................................................... 150 
6.2.1. Getting started ................................................................................................................................................ 150 
6.2.2. Triggers ............................................................................................................................................................. 153 
6.2.3. Context API ...................................................................................................................................................... 153 
6.2.4. Built-In Transforms/Functions .................................................................................................................... 154 
6.2.5. Configuration .................................................................................................................................................. 155 
6.2.6. Error Handling ................................................................................................................................................. 155 
6.2.2.1. Message Bus Trigger .......................................................................................................................................... 156 
6.2.2.1.1. Type and Topic Configuration .............................................................................................................. 156 
6.2.2.1.2. Message bus connection configuration ............................................................................................. 156 
6.2.2.2. HTTP Trigger ......................................................................................................................................................... 157 
7. Device Services Microservices .................................................................................................................................... 158 
7.1. Virtual Device .............................................................................................................................................................. 160 
7.1.1. Introduction ..................................................................................................................................................... 160 
7.1.2. Virtual Resources Example ........................................................................................................................... 162 
7.1.3. Special Configuration .................................................................................................................................... 163 
7.1.4. System Architecture ....................................................................................................................................... 164 
7.1.5. Device Profile Definition ............................................................................................................................... 166 
7.1.6. Data Model ...................................................................................................................................................... 166 
7.1.7. Data Dictionary ............................................................................................................................................... 169 
7.2. Device Services SDK .................................................................................................................................................. 170 
7.2.1. Introduction to the SDK ................................................................................................................................ 170 
7.2.2. Device Service Workflow .............................................................................................................................. 170 
7.2.3. Writing a Device Service ............................................................................................................................... 171 
7.3. Device Profile ..................................................................................................................................................... 172 
Getting Started .................................................................................................................................................................. 174 
1. Getting Started - Users ................................................................................................................................................ 174 
1.1. Introduction ........................................................................................................................................................ 174 
1.2. Platform Requirements .................................................................................................................................... 175 
1.3. Get & Run EdgeX Foundry .............................................................................................................................. 176 
1.3.1. Install Docker & Docker Compose .................................................................................................... 176 
1.3.2. Download the EdgeX Foundry Compose File ................................................................................ 176 
1.3.3. Run EdgeX Foundry .............................................................................................................................. 178 
1.4. Stop and Remove EdgeX Foundry ................................................................................................................ 180 
1.5. Advanced EdgeX Foundry User Commands .............................................................................................. 181 
1.6. Checking the Status of EdgeX Foundry ....................................................................................................... 184 
1.6.1. Docker Container Status Check ......................................................................................................... 184 
1.6.2. EdgeX Foundry Consul Registry......................................................................................................... 187 
2. Getting Started - Developers ..................................................................................................................................... 188 
2.1. Introduction ........................................................................................................................................................ 188 
2.2. What You Need ................................................................................................................................................. 189 
2.2.1. Get EdgeX Foundry - Go Developers ................................................................................................................ 190 
2.2.1.1. Introduction .................................................................................................................................................. 190 
2.2.1.2. What You Need For Go Development .................................................................................................. 190 