|
1 | 1 | # Edge Discovery APIs
|
2 | 2 |
|
3 | 3 | ## Simple Discovery API
|
4 |
| -This API allows a client application to discover the closest MEC platform to the UE hosting the client application. 'Closest' means 'shorteset network path' as that will give the shortest propogation distance, which is a major factor in latency. |
| 4 | + |
| 5 | +This API allows a client application to discover the closest MEC platform to the UE hosting the client application. 'Closest' means 'shortest network path' as that will give the shortest propagation distance, which is a major factor in latency. |
5 | 6 |
|
6 | 7 | ## MEC Experience Management and Exposure API
|
| 8 | + |
7 | 9 | This API allows a developer to:
|
| 10 | + |
8 | 11 | - discover available MEC platforms, ranked by proximity to a UE.
|
9 | 12 | - read the state (availability and capabilities) of an operator's various MEC platforms.
|
10 |
| -- register a service profile (a description of the developer's edge service) with the MEC operator |
11 |
| -- register the deployed service endpoints with the MEC operator, which allows the closest service endpoint to be discovered at runtime |
| 13 | +- register a service profile (a description of the developer's edge service) with the MEC operator. |
| 14 | +- register the deployed service endpoints with the MEC operator, which allows the closest service endpoint to be discovered at runtime. |
12 | 15 |
|
13 |
| -The API will also support the following capabilities: |
14 |
| -- events(such as change of status of a MEC platform or another event which could affect their service) |
| 16 | +The API will also support the following capabilities: |
| 17 | + |
| 18 | +- events(such as change of status of a MEC platform or another event which could affect their service). |
15 | 19 | - subscription to notification of events.
|
16 | 20 |
|
17 |
| -# Mapping to the list of intents |
| 21 | +## Mapping to the list of intents |
18 | 22 |
|
19 | 23 | These APIs fulfil the ['discovery' intents](https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/Harmonisation%20of%20APIs/describing%20and%20harmonising%20the%20Edge%20APIs.md)
|
20 | 24 |
|
21 |
| -*Simple Edge Discovery* fulfils a single intent, "4. I can discover the closest MEC platform to a specific terminal (closest in terms of shortest network path)" |
| 25 | +*Simple Edge Discovery* fulfils a single intent, "4. I can discover the closest MEC platform to a specific terminal (closest in terms of shortest network path)" |
22 | 26 |
|
23 | 27 | *MEC Exposure and Experience Management* is a more comprehensive discovery API and fulfils the following intents:
|
24 | 28 |
|
25 | 29 | ### Developer intents
|
26 |
| -#### Provisioning intents |
27 |
| -1. “I can retrieve a list of the operator’s MECs and their status, ordering the results by location and filtering by status (active/inactive/unknown)” |
28 |
| -2. "I can discover the capabilities/resources available at an operator’s MEC: CPU, Memory, Storage, GPU" |
29 |
| -3. "I can discover the geographical regions covered by the operators MECs" |
30 |
| -4. "I can discover the closest MEC platform to a specific terminal (closest in terms of shortest network path)" |
31 | 30 |
|
32 |
| -16. “I can ask the operator to provide the details of all the onboarded applications” |
33 |
| -17. "I can ask the operator to inform about the application instance details e.g., communication endpoints, resource consumed etc" |
| 31 | +#### Provisioning intents |
| 32 | + |
| 33 | +1. "I can retrieve a list of the operator’s MECs and their status, ordering the results by location and filtering by status (active/inactive/unknown)" |
| 34 | +2. "I can discover the capabilities/resources available at an operator’s MEC: CPU, Memory, Storage, GPU" |
| 35 | +3. "I can discover the geographical regions covered by the operators MECs" |
| 36 | +4. "I can discover the closest MEC platform to a specific terminal (closest in terms of shortest network path)" |
34 | 37 |
|
| 38 | +16. "I can ask the operator to provide the details of all the on-boarded applications" |
| 39 | +17. "I can ask the operator to inform about the application instance details e.g., communication endpoints, resource consumed etc" |
35 | 40 |
|
36 |
| -#### Runtime intents |
37 |
| -19. "I can discover the closest MEC platform to a particular terminal (closest in terms of shortest network path)" |
38 |
| -20. "I can discover the optimal MEC platform for my application and a particular terminal, taking into account connectivity, shortest network path, cost, network load etc." (`A`) |
39 |
| -21. "I can discover the optimal application service endpoint for a specific terminal, taking into account mobility events, connectivity, shortest network path, cost, network load, MEC platform load etc." |
| 41 | +#### Runtime intents |
| 42 | + |
| 43 | +19. "I can discover the closest MEC platform to a particular terminal (closest in terms of shortest network path)" |
| 44 | +20. "I can discover the optimal MEC platform for my application and a particular terminal, taking into account connectivity, shortest network path, cost, network load etc." (`A`) |
| 45 | +21. "I can discover the optimal application service endpoint for a specific terminal, taking into account mobility events, connectivity, shortest network path, cost, network load, MEC platform load etc." |
40 | 46 |
|
41 | 47 | ### Operator intents
|
| 48 | + |
42 | 49 | #### Provisioning intents
|
43 |
| -23. “I can publish an (ordered, filtered) list of my MECs, their coverage, capabilities and status” _(aligns with 1,2,3 in the developer intents)_ |
44 |
| -24. “I can map an application’s requirements to the best MEC for hosting it, based on application demands for CPU,Memory,Storage,GPU,bandwith,Network forecast, mobility” _(aligns with 4,5,8,9)_ |
45 |
| -#### Runtime intents |
46 |
| -25. “I can inform the developer of any event which changes which MEC is optimal for their application and connected terminals” _(aligns with 6)_ |
47 | 50 |
|
48 |
| -## Notes: |
| 51 | +23. "I can publish an (ordered, filtered) list of my MECs, their coverage, capabilities and status" *(aligns with 1,2,3 in the developer intents)* |
| 52 | +24. "I can map an application’s requirements to the best MEC for hosting it, based on application demands for CPU, Memory, Storage, GPU, bandwidth, Network forecast, mobility" *(aligns with 4,5,8,9)* |
| 53 | + |
| 54 | +#### Runtime intents |
| 55 | + |
| 56 | +25. "I can inform the developer of any event which changes which MEC is optimal for their application and connected terminals" *(aligns with 6)* |
| 57 | + |
| 58 | +## Notes |
49 | 59 |
|
50 |
| -`A` this may not be the closest MEC, rather the 'best MEC for this job' which accounts for current MEC or network load, MEC copmute power and features etc. |
| 60 | +`A` this may not be the closest MEC, rather the 'best MEC for this job' which accounts for current MEC or network load, MEC compute power and features etc. |
0 commit comments