File tree Expand file tree Collapse file tree 1 file changed +72
-0
lines changed Expand file tree Collapse file tree 1 file changed +72
-0
lines changed Original file line number Diff line number Diff line change 1+ # Local Operator Console (LOC) API
2+
3+ This document explains the Local Operator Console(LOC) from the API point of view.
4+
5+ This document is similarly structured as PROFILE.md, because the topic is very similar.
6+
7+ ## Server endpoint
8+
9+ EVE periodically sends a ` CompoundEdgeDevConfigRequest ` to the Local Operator Console.
10+ EVE can find the URL to the LOC in ` loc_url ` which is part of the
11+ ` EdgeDevConfig ` that EVE received from the controller.
12+
13+ ## Endpoints
14+
15+ In the following ` $UUID ` is the uuid of the edge node contacting LOC.
16+
17+ ### Certs
18+ ``` http
19+ GET /api/v2/edgedevice/certs
20+ ```
21+
22+ Returns the controller certificates.
23+
24+ ### Config
25+
26+ ``` http
27+ POST /api/v2/edgedevice/id/$UUID/config
28+ ```
29+
30+ Returns the signed config from the controller.
31+
32+ ### Compound Config
33+
34+ ``` http
35+ POST /api/v2/edgedevice/id/$UUID/compound-config
36+ ```
37+
38+ Returns edge device config as part of the compound config. It also includes:
39+
40+ * current Unix timestamp in nano seconds precision
41+ * device command
42+ * app commands
43+ * radio config
44+
45+ The device command can be:
46+
47+ * shutdown of the device
48+ * shutdown and poweroff of the device
49+ * reboot of the device
50+ * run collect-info and upload the tarball to the configured datastore via POST/PUT
51+
52+ The app commands can be:
53+
54+ * restart of the app
55+ * purge of the app
56+
57+ ### Edge Metrics
58+
59+ ``` http
60+ POST /api/v2/edgedevice/id/$UUID/metrics
61+ ```
62+
63+ This is where the metrics are sent. Similar to the controller.
64+
65+ ### Edge Info
66+
67+ ``` http
68+ POST /api/v2/edgedevice/id/$UUID/info
69+ ```
70+
71+ This is where the info messages are sent. Similar to the controller.
72+
You can’t perform that action at this time.
0 commit comments