forked from edgexfoundry/edgex-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
442 lines (441 loc) · 25.4 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
site_name: EdgeX Foundry Documentation
docs_dir: docs_src
site_dir: docs/3.2
site_description: 'Documentation for use of EdgeX Foundry'
site_author: 'Michael Johanson'
site_url: 'https://docs.edgexfoundry.org/3.2'
repo_url: 'https://github.com/edgexfoundry/edgex-go'
repo_name: 'edgex/edgex-go'
copyright: 'Copyright © 2023 EdgeX Foundry'
strict: false # mkdocs-materials will prevent running on 0.0.0.0 otherwise (or have custom image)
validation:
nav:
omitted_files: info
not_found: warn
absolute_links: info
links:
not_found: warn
absolute_links: info
unrecognized_links: ignore
theme:
name: 'material'
logo: 'assets/logo_edgex_white.png'
favicon: 'assets/logo_edgex.png'
features:
- navigation.tabs # changed with version 6 of mkdocs-materials
- navigation.footer
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
nav:
- Home:
- Overview: index.md
- about.md
- Getting Started:
- Guides: getting-started/index.md
- getting-started/quick-start/index.md
- getting-started/Ch-GettingStartedUsers.md
- getting-started/Ch-GettingStartedDockerUsers.md
- getting-started/tools/Ch-GUI.md
- Developer:
- getting-started/Ch-GettingStartedDevelopers.md
- getting-started/Ch-GettingStartedGoDevelopers.md
- getting-started/Ch-GettingStartedCDevelopers.md
- getting-started/Ch-GettingStartedHybrid.md
- Native Build and Run Guides:
- getting-started/native/Ch-BuildRunNative.md
- getting-started/native/Ch-BuildRunOnLinuxDistro.md
- getting-started/native/Ch-BuildRunOnArm32.md
- getting-started/native/Ch-BuildRunOnWindows.md
- Application Functions SDK: microservices/application/sdk/Purpose.md
- Device Services:
- microservices/device/GettingStarted.md
- getting-started/Ch-GettingStartedUsersNexus.md
- getting-started/Ch-GettingStartedDTOValidation.md
- APIs:
- api/Ch-APIIntroduction.md
- api/core/Ch-APICoreCommand.md
- Core Data: microservices/core/data/ApiReference.md
- api/core/Ch-APICoreMetadata.md
- api/core/Ch-APICoreConfigurationAndRegistry.md
- api/support/Ch-APISupportNotifications.md
- api/support/Ch-APISupportScheduler.md
- api/devices/Ch-APIDeviceSDK.md
- App Services: microservices/application/ApiReference.md
- api/applications/Ch-APIRulesEngine.md
- Services:
- Core:
- microservices/core/Ch-CoreServices.md
- Core Data:
- Purpose: microservices/core/data/Purpose.md
- Getting Started: microservices/core/data/GettingStarted.md
- Configuration: microservices/core/data/Configuration.md
- API Reference: microservices/core/data/ApiReference.md
- Source Code: microservices/core/data/SourceCode.md
- Additional Details:
- Events and Readings: microservices/core/data/details/EventsAndReadings.md
- Data Retention: microservices/core/data/details/DataRetention.md
- Core Metadata:
- Purpose: microservices/core/metadata/Purpose.md
- Getting Started: microservices/core/metadata/GettingStarted.md
- Configuration: microservices/core/metadata/Configuration.md
- API Reference: microservices/core/metadata/ApiReference.md
- Source Code: microservices/core/metadata/SourceCode.md
- Additional Details:
- Device Profile: microservices/core/metadata/details/DeviceProfile.md
- Device System Events: microservices/core/metadata/details/DeviceSystemEvents.md
- Core Command:
- Purpose: microservices/core/command/Purpose.md
- Getting Started: microservices/core/command/GettingStarted.md
- Configuration: microservices/core/command/Configuration.md
- API Reference: microservices/core/command/ApiReference.md
- Source Code: microservices/core/command/SourceCode.md
- Additional Details:
- Regex Get Command: microservices/core/command/details/RegexGetCommand.md
- microservices/core/database/Ch-Redis.md
- Supporting:
- microservices/support/Ch-SupportingServices.md
- Notifications:
- Purpose: microservices/support/notifications/Purpose.md
- Getting Started: microservices/support/notifications/GettingStarted.md
- How-To Guides:
- Configure Email Notifications: microservices/support/notifications/HowTo_EmailNotifications.md
- Configuration: microservices/support/notifications/Configuration.md
- API Reference: microservices/support/notifications/ApiReference.md
- Source Code: microservices/support/notifications/SourceCode.md
- Additional Details:
- Data Retention: microservices/support/notifications/details/DataRetention.md
- Scheduler:
- Purpose: microservices/support/scheduler/Purpose.md
- Getting Started: microservices/support/scheduler/GettingStarted.md
- Configuration: microservices/support/scheduler/Configuration.md
- API Reference: microservices/support/scheduler/ApiReference.md
- Source Code: microservices/support/scheduler/SourceCode.md
- microservices/support/eKuiper/Ch-eKuiper.md
- Device:
- Device Service: microservices/device/DeviceService.md
- Getting Started: microservices/device/GettingStarted.md
- How-To Guides:
- Remote Deployment:
- Non-Secure Mode: microservices/device/how-to/Ch-RemoteNonSecure.md
- Secure Mode: microservices/device/how-to/Ch-RemoteSecure.md
- Configuration: microservices/device/Configuration.md
- API Reference: microservices/device/ApiReference.md
- Additional Details:
- Device Profiles: microservices/device/details/DeviceProfiles.md
- Device Commands: microservices/device/details/DeviceCommands.md
- Device Definitions: microservices/device/details/DeviceDefinitions.md
- Auto Events: microservices/device/details/AutoEvents.md
- Device Discovery: microservices/device/details/DeviceDiscovery.md
- Command-line Options: microservices/device/details/CommandLine.md
- Environment Variables: microservices/device/details/EnvironmentVariables.md
- Seeding Secrets: microservices/device/details/SeedingSecrets.md
- Service Metrics: microservices/device/details/ServiceMetrics.md
- Device Service SDK:
- Purpose: microservices/device/sdk/Purpose.md
- Getting Started:
- Go SDK: microservices/device/sdk/devicesdk-getting-started/GettingStartedSDK-Go.md
- C SDK: microservices/device/sdk/devicesdk-getting-started/GettingStartedSDK-C.md
- APIs:
- Go SDK:
- DeviceServiceSDK: microservices/device/sdk/api/GoDeviceSDK/GoDeviceSDKAPI.md
- ProtocolDriver: microservices/device/sdk/api/GoDeviceSDK/GoProtocolDriverAPI.md
- C SDK:
- SDK: microservices/device/sdk/api/CDeviceSDK/CDeviceSDKAPI.md
- C Utilities: microservices/device/sdk/api/CDeviceSDK/CUtilities.md
- Source Code: microservices/device/sdk/SourceCode.md
- Additional Details:
- Custom Configuration: microservices/device/sdk/details/CustomConfiguration.md
- Custom Rest Apis: microservices/device/sdk/details/CustomRestApis.md
- Custom Service Metrics: microservices/device/sdk/details/CustomServiceMetrics.md
- Secrets: microservices/device/sdk/details/Secrets.md
- V3 Migration: microservices/device/V3Migration.md
- Services:
- Device BacNet: microservices/device/services/device-bacnet.md
- Device COAP: microservices/device/services/device-coap.md
- Device GPIO:
- Purpose: microservices/device/services/device-gpio/Purpose.md
- Getting Started: microservices/device/services/device-gpio/GettingStarted.md
- Configuration: microservices/device/services/device-gpio/Configuration.md
- Protocol Properties: microservices/device/services/device-gpio/ProtocolProperties.md
- API Reference: microservices/device/services/device-gpio/ApiReference.md
- Source Code: microservices/device/services/device-gpio/SourceCode.md
- Device Modbus:
- Purpose: microservices/device/services/device-modbus/Purpose.md
- Getting Started: microservices/device/services/device-modbus/GettingStarted.md
- Configuration: microservices/device/services/device-modbus/Configuration.md
- Protocol Properties: microservices/device/services/device-modbus/ProtocolProperties.md
- API Reference: microservices/device/services/device-modbus/APIReference.md
- Source Code: microservices/device/services/device-modbus/SourceCode.md
- Additional Details:
- Data Type Conversion: microservices/device/services/device-modbus/details/DataTypeConversion.md
- Device MQTT:
- Purpose: microservices/device/services/device-mqtt/Purpose.md
- Getting Started: microservices/device/services/device-mqtt/GettingStarted.md
- How To Guides:
- How To Add an MQTT Device: microservices/device/services/device-mqtt/Ch-ExamplesAddingMQTTDevice.md
- Configuration: microservices/device/services/device-mqtt/Configuration.md
- Protocol Properties: microservices/device/services/device-mqtt/ProtocolProperties.md
- API Reference: microservices/device/services/device-mqtt/APIReference.md
- Source Code: microservices/device/services/device-mqtt/SourceCode.md
- Additional Details:
- Multi-Level Topics: microservices/device/services/device-mqtt/details/MultiLevelTopics.md
- Device Onvif Camera:
- microservices/device/services/device-onvif-camera/General.md
- microservices/device/services/device-onvif-camera/swagger.md
- Walkthrough:
- microservices/device/services/device-onvif-camera/Walkthrough/setup.md
- microservices/device/services/device-onvif-camera/Walkthrough/deployment.md
- microservices/device/services/device-onvif-camera/Walkthrough/general-usage.md
- microservices/device/services/device-onvif-camera/Walkthrough/custom-build.md
- Supplementary Information:
- ONVIF Protocol:
- microservices/device/services/device-onvif-camera/supplementary-info/ONVIF-protocol.md
- microservices/device/services/device-onvif-camera/supplementary-info/onvif-user-authentication.md
- Features:
- microservices/device/services/device-onvif-camera/supplementary-info/custom-metadata-feature.md
- microservices/device/services/device-onvif-camera/supplementary-info/friendlyname-mac.md
- microservices/device/services/device-onvif-camera/supplementary-info/device-status.md
- microservices/device/services/device-onvif-camera/supplementary-info/auto-discovery.md
- microservices/device/services/device-onvif-camera/supplementary-info/credentials.md
- microservices/device/services/device-onvif-camera/supplementary-info/reboot-needed.md
- API Reference:
- microservices/device/services/device-onvif-camera/supplementary-info/api-analytic-support.md
- microservices/device/services/device-onvif-camera/supplementary-info/api-event-handling.md
- microservices/device/services/device-onvif-camera/supplementary-info/api-usage-user-handling.md
- Utility:
- microservices/device/services/device-onvif-camera/supplementary-info/test-with-postman.md
- microservices/device/services/device-onvif-camera/supplementary-info/utility-scripts.md
- Miscellaneous:
- microservices/device/services/device-onvif-camera/supplementary-info/control-plane-events.md
- microservices/device/services/device-onvif-camera/supplementary-info/getting-started-with-docker-security.md
- microservices/device/services/device-onvif-camera/supplementary-info/ws-discovery.md
- microservices/device/services/device-onvif-camera/supplementary-info/onvif-footnotes.md
- Device REST:
- Purpose: microservices/device/services/device-rest/Purpose.md
- Getting Started: microservices/device/services/device-rest/GettingStarted.md
- How-To Guides:
- Testing: microservices/device/services/device-rest/howto/Testing.md
- Configuration: microservices/device/services/device-rest/Configuration.md
- Protocol Properties: microservices/device/services/device-rest/ProtocolProperties.md
- API Reference: microservices/device/services/device-rest/ApiReference.md
- Source Code: microservices/device/services/device-rest/SourceCode.md
- Device RFID LLRP: microservices/device/services/device-rfid-llrp.md
- Device SNMP: microservices/device/services/device-snmp.md
- Device UART:
- Purpose: microservices/device/services/device-uart/Purpose.md
- Getting Started: microservices/device/services/device-uart/GettingStarted.md
- Configuration: microservices/device/services/device-uart/Configuration.md
- Protocol Properties: microservices/device/services/device-uart/ProtocolProperties.md
- API Reference: microservices/device/services/device-uart/APIReference.md
- Source Code: microservices/device/services/device-uart/SourceCode.md
- Device USB Camera:
- microservices/device/services/device-usb-camera/General.md
- Walkthrough:
- microservices/device/services/device-usb-camera/walkthrough/setup.md
- microservices/device/services/device-usb-camera/walkthrough/deployment.md
- microservices/device/services/device-usb-camera/walkthrough/general-usage.md
- microservices/device/services/device-usb-camera/walkthrough/custom-build.md
- Supplementary Information:
- microservices/device/services/device-usb-camera/supplementary-info/USB-protocol.md
- microservices/device/services/device-usb-camera/supplementary-info/discovery.md
- microservices/device/services/device-usb-camera/supplementary-info/advanced-options.md
- Device Virtual: microservices/device/services/device-virtual/Ch-VirtualDevice.md
- Application:
- Application Services: microservices/application/ApplicationServices.md
- Getting Started: microservices/application/GettingStarted.md
- Configuration: microservices/application/Configuration.md
- API Reference: microservices/application/ApiReference.md
- Additional Details:
- Command-Line Options: microservices/application/details/CommandLine.md
- Environment Variables: microservices/application/details/EnvironmentVariables.md
- Seeding Secrets: microservices/application/details/SeedingSecrets.md
- Service Metrics: microservices/application/details/ServiceMetrics.md
- Triggers: microservices/application/details/Triggers.md
- App Functions SDK:
- Purpose: microservices/application/sdk/Purpose.md
- Getting Started: microservices/application/sdk/GettingStarted.md
- APIs:
- Application Service: microservices/application/sdk/api/ApplicationServiceAPI.md
- App Function Context: microservices/application/sdk/api/AppFunctionContextAPI.md
- Pipeline Functions: microservices/application/sdk/api/BuiltInPipelineFunctions.md
- Source Code: microservices/application/sdk/SourceCode.md
- Additional Details:
- Background Publishing: microservices/application/sdk/details/BackgroundPublishing.md
- Custom Configuration: microservices/application/sdk/details/CustomConfiguration.md
- Custom REST APIs: microservices/application/sdk/details/CustomRestApis.md
- Custom Service Metrics: microservices/application/sdk/details/CustomServiceMetrics.md
- Pipelines Per Topic: microservices/application/sdk/details/PipelinesPerTopics.md
- Secrets: microservices/application/sdk/details/Secrets.md
- Store and Forward: microservices/application/sdk/details/StoreAndForward.md
- Target Type: microservices/application/sdk/details/TargetType.md
- V3 Migration: microservices/application/V3Migration.md
- Services:
- App Service Configurable:
- Purpose: microservices/application/services/AppServiceConfigurable/Purpose.md
- Getting Started: microservices/application/services/AppServiceConfigurable/GettingStarted.md
- Configuration: microservices/application/services/AppServiceConfigurable/Configuration.md
- API Reference: microservices/application/services/AppServiceConfigurable/ApiReference.md
- Source Code: microservices/application/services/AppServiceConfigurable/SourceCode.md
- Additional Details:
- Pipeline Per Topics: microservices/application/services/AppServiceConfigurable/details/PipelinePerTopics.md
- Available Pipeline Functions: microservices/application/services/AppServiceConfigurable/details/AvailablePipelineFunctions.md
- Available Profiles: microservices/application/services/AppServiceConfigurable/details/Profiles.md
- Target Type: microservices/application/services/AppServiceConfigurable/details/TargetType.md
- App RFID LLRP Inventory:
- Purpose: microservices/application/services/AppLLRPInventory/Purpose.md
- Getting Started: microservices/application/services/AppLLRPInventory/GettingStarted.md
- Configuration: microservices/application/services/AppLLRPInventory/Configuration.md
- API Reference: microservices/application/services/AppLLRPInventory/ApiReference.md
- Source Code: microservices/application/services/AppLLRPInventory/SourceCode.md
- Additional Details:
- Inventory Events: microservices/application/services/AppLLRPInventory/details/InventoryEvents.md
- Tag Location Algorithm: microservices/application/services/AppLLRPInventory/details/TagLocationAlgorithm.md
- Location Aliases: microservices/application/services/AppLLRPInventory/details/LocationAliases.md
- Behaviors: microservices/application/services/AppLLRPInventory/details/Behaviors.md
- Mobility Profile: microservices/application/services/AppLLRPInventory/details/MobilityProfile.md
- App Record & Replay :
- Purpose: microservices/application/services/AppRecordReplay/Purpose.md
- Getting Started: microservices/application/services/AppRecordReplay/GettingStarted.md
- Configuration: microservices/application/services/AppRecordReplay/Configuration.md
- API Reference: microservices/application/services/AppRecordReplay/ApiReference.md
- Source Code: microservices/application/services/AppRecordReplay/SourceCode.md
- Configuration & Registry:
- microservices/configuration/ConfigurationAndRegistry.md
- microservices/configuration/CommonConfiguration.md
- microservices/configuration/CommonCommandLineOptions.md
- microservices/configuration/CommonEnvironmentVariables.md
- V3 Migration: microservices/configuration/V3MigrationCommonConfig.md
- microservices/general/index.md
- microservices/general/messagebus.md
- Security:
- Security Services: security/Ch-Security.md
- security/Ch-SecretStore.md
- security/Ch-Authenticating.md
- security/Ch-SecretProviderApi.md
- security/Ch-APIGateway.md
- security/Ch-Secure-MessageBus.md
- security/Ch-Configuring-Add-On-Services.md
- security/Ch-Secure-Consul.md
- security/Ch-SecurityIssues.md
- security/secrets-config.md
- security/secrets-config-proxy.md
- security/SeedingServiceSecrets.md
- security/Ch-CORS-Settings.md
- security/Ch-DelayedStartServices.md
- security/Ch-RemoteDeviceServices.md
- V3 Migration: security/V3Migration.md
- Threat Models:
- threat-models/secret-store/README.md
- threat-models/stride-model/EdgeX-STRIDE.md
- threat-models/stride-model/EdgeXFoundryThreatReportV2.2.md
- Migration:
- V3.0 Migration:
- General Migration: V3TopLevelMigration.md
- Security Migration: security/V3Migration.md
- Configuration Migration: microservices/configuration/V3MigrationCommonConfig.md
- Device Service Migration: microservices/device/V3Migration.md
- Application Service Migration: microservices/application/V3Migration.md
- Tutorials:
- examples/Ch-ExamplesVirtualDeviceService.md
- examples/Ch-ExamplesSendingAndConsumingBinary.md
- examples/Ch-CommandingDeviceThroughRulesEngine.md
- Adding a Device:
- examples/Ch-ExamplesAddingSNMPDevice.md
- microservices/device/services/device-mqtt/Ch-ExamplesAddingMQTTDevice.md
- Walkthrough:
- walk-through/Ch-Walkthrough.md
- walk-through/Ch-WalkthroughSetup.md
- walk-through/Ch-WalkthroughUseCase.md
- walk-through/Ch-WalkthroughDeviceProfile.md
- walk-through/Ch-WalkthroughDeviceService.md
- walk-through/Ch-WalkthroughProvision.md
- walk-through/Ch-WalkthroughCommands.md
- walk-through/Ch-WalkthroughReading.md
- walk-through/Ch-WalkthroughExporting.md
- Examples:
- Code Examples: examples/index.md
- App Service Examples:
- examples/AppServiceExamples.md
- examples/app-service-examples/camera-management/Ch-CameraManagement.md
- Reference:
- general/Definitions.md
- general/PlatformRequirements.md
- general/ServicePorts.md
- general/ContainerNames.md
- general/ServiceConfiguration.md
- general/EdgeX_CN.md
- Use Case & Design:
- Process: design/Process.md
- Documents: design/TOC.md
- Legacy:
- Designs: design/legacy-design/README.md
- Requirements: design/legacy-requirements/README.md
markdown_extensions:
- codehilite
- admonition
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- pymdownx.superfences
- pymdownx.mark
- pymdownx.critic
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- attr_list
- md_in_html
- tables
# - mdx_truly_sane_lists
extra:
version:
provider: mike
# - make edgexversion the latest version for repository tree references
social:
- icon: 'fontawesome/brands/github-alt'
link: 'https://github.com/edgexfoundry'
- icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/edgexfoundry'
- icon: 'fontawesome/brands/linkedin'
link: 'https://www.linkedin.com/company/edgexfoundry'
analytics:
provider: google
property: G-38531ZZHBN
extra_css:
- assets/stylesheets/version-select.css
- assets/stylesheets/branding.css
- assets/stylesheets/edgey.css
- assets/stylesheets/newexample.css
- assets/stylesheets/extra.css
plugins:
- search
- swagger-ui-tag
- macros:
include_yaml:
- template_macros.yaml
on_error_fail: true
- htmlproofer:
enabled: !ENV [ENABLED_HTMLPROOFER, false]
raise_error: true
raise_error_excludes:
400: ['https://help.axis.com/en-us/axis-os-hardening-guide#onvif-replay-attack-protection']
403: ['https://www.collinsdictionary.com/us/dictionary/english/unit-of-measurement',
'https://www.pcmag.com/encyclopedia/term/run-native','https://www.vmware.com/topics/glossary/content/kubernetes-cluster.html',
'https://app.getpostman.com/','https://www.raspberrypi.com/products/raspberry-pi-3-model-b/',
'https://www.raspberrypi.com/software/']
404: ['https://support.google.com/accounts/answer/185833?hl=en',
'https://support.google.com/accounts/answer/6010255?hl=en']
429: ['*']
-1: ['https://www.rfc-editor.org/rfc/rfc7519',
'https://tools.ietf.org/html/rfc5869','https://docs.iotaap.io/docs-rest/','https://unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_rev3_Annex2e.pdf']
500: [https://packages.ubuntu.com/bionic/build-essential]