From 7990a56c08af707d462ae971aaf80b12307eebdf Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 24 Aug 2023 13:12:03 +0100 Subject: [PATCH 1/6] Update README.MD to reflect new folder structure --- code/API_definitions/README.MD | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/code/API_definitions/README.MD b/code/API_definitions/README.MD index 80c37844..a56a37c7 100644 --- a/code/API_definitions/README.MD +++ b/code/API_definitions/README.MD @@ -1,20 +1,13 @@ -These APIs are contributed by 5GFF: +The Edge Cloud suite of APIs is split into 4 categories, based on the intents listed [here](https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/Harmonisation%20of%20APIs/describing%20and%20harmonising%20the%20Edge%20APIs.md). -# MEC Experience Management and Exposure API -This API allows a developer to: -- discover available MEC platforms, ranked by proximity to a UE. -- read the state (availability and capabilities) of an operator's various MEC platforms. -- register a service profile (a description of the developer's edge service) with the MEC operator -- register the deployed service endpoints with the MEC operator, which allows the closest service endpoint to be discovered at runtime +# Discovery +Discover the Edge site with the shortest network path to an end user terminal,find out which is the optimal Edge site for your specifc application, register your Edge-hosted application endpoints for rapid connectivity to the optimal Edge site. -The API will also support the following capabilities: -- events(such as change of status of a MEC platform or another event which could affect their service) -- subscription to notification of events. +Workload Orchestration +Lifecycle management of the Edge resources and servers for your applications -Since events and subscription notifications can apply to many CAMARA APIs, that part will be defined in the Commonalities working group to ensure consistency. +# Resource Management +Information about the resources (compute, storage, networking etc) at a given Edge site -# Simple Discovery API -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. - -# Traffic Influence API -The Traffic Influence API hides the complexity of the network providing the developer with the possibility to modify the connection policies of UEs and EAS in terms of how the traffic flows. For a 5G network, the UPF connected to the target Data Network can be updated with new traffic steering rules, for a set of users and for a specific time period. Furthermore, in a UE mobility scenario, the PDU Session Anchor, may be relocated to a different UPF considering the requirements provided by the AF. +# Traffic Influence +Influence traffic routing to ensure optimal network perfromance based on user mobility, application demand, best edge site. From 781f6b5020c352c38172452c3237bb4d8a980da6 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 24 Aug 2023 13:31:52 +0100 Subject: [PATCH 2/6] Rename README.MD to README.md --- code/API_definitions/{README.MD => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename code/API_definitions/{README.MD => README.md} (100%) diff --git a/code/API_definitions/README.MD b/code/API_definitions/README.md similarity index 100% rename from code/API_definitions/README.MD rename to code/API_definitions/README.md From b5e0dde78166211814a968cd959a2e83f473f693 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 17 Oct 2023 13:34:03 +0100 Subject: [PATCH 3/6] Changed resource management description Changed resource management description per @gunjald comment --- code/API_definitions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/README.md b/code/API_definitions/README.md index a56a37c7..a95b9b58 100644 --- a/code/API_definitions/README.md +++ b/code/API_definitions/README.md @@ -7,7 +7,7 @@ Workload Orchestration Lifecycle management of the Edge resources and servers for your applications # Resource Management -Information about the resources (compute, storage, networking etc) at a given Edge site +Management (CRUD) of the edge resources by the application providers for the consumption by edge applications. # Traffic Influence Influence traffic routing to ensure optimal network perfromance based on user mobility, application demand, best edge site. From 31957ed39037b6618bdff46a2086fddd9689d2c7 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 11 Jun 2024 14:52:07 +0100 Subject: [PATCH 4/6] Update code/API_definitions/README.md Made Workload Orchestration a section heading Co-authored-by: Nicola Cadenelli --- code/API_definitions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/README.md b/code/API_definitions/README.md index a95b9b58..9319edeb 100644 --- a/code/API_definitions/README.md +++ b/code/API_definitions/README.md @@ -3,7 +3,7 @@ The Edge Cloud suite of APIs is split into 4 categories, based on the intents li # Discovery Discover the Edge site with the shortest network path to an end user terminal,find out which is the optimal Edge site for your specifc application, register your Edge-hosted application endpoints for rapid connectivity to the optimal Edge site. -Workload Orchestration +# Workload Orchestration Lifecycle management of the Edge resources and servers for your applications # Resource Management From 7ee6aa1006115862e787716d4120c3d3bf33ea44 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 11 Jun 2024 14:53:23 +0100 Subject: [PATCH 5/6] Update README.md Changed "Edge Site" to "Edge Cloud Zone" --- code/API_definitions/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/README.md b/code/API_definitions/README.md index 9319edeb..5f1f0b1a 100644 --- a/code/API_definitions/README.md +++ b/code/API_definitions/README.md @@ -1,7 +1,7 @@ The Edge Cloud suite of APIs is split into 4 categories, based on the intents listed [here](https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/Harmonisation%20of%20APIs/describing%20and%20harmonising%20the%20Edge%20APIs.md). # Discovery -Discover the Edge site with the shortest network path to an end user terminal,find out which is the optimal Edge site for your specifc application, register your Edge-hosted application endpoints for rapid connectivity to the optimal Edge site. +Discover the Edge Cloud Zone with the shortest network path to an end user terminal, find out which is the optimalEdge Cloud Zone for your specifc application, register your Edge-hosted application endpoints for rapid connectivity to the optimal Edge Cloud Zone. # Workload Orchestration Lifecycle management of the Edge resources and servers for your applications @@ -10,4 +10,4 @@ Lifecycle management of the Edge resources and servers for your applications Management (CRUD) of the edge resources by the application providers for the consumption by edge applications. # Traffic Influence -Influence traffic routing to ensure optimal network perfromance based on user mobility, application demand, best edge site. +Influence traffic routing to ensure optimal network perfromance based on user mobility, application demand, best Edge Cloud Zone. From fda259d186ba5427c168d90d0b755038cbf8943c Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Wed, 9 Oct 2024 13:45:43 +0100 Subject: [PATCH 6/6] Update README.md typos, changed best to optimal --- code/API_definitions/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/README.md b/code/API_definitions/README.md index 5f1f0b1a..a0f987f7 100644 --- a/code/API_definitions/README.md +++ b/code/API_definitions/README.md @@ -1,7 +1,7 @@ The Edge Cloud suite of APIs is split into 4 categories, based on the intents listed [here](https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/Harmonisation%20of%20APIs/describing%20and%20harmonising%20the%20Edge%20APIs.md). # Discovery -Discover the Edge Cloud Zone with the shortest network path to an end user terminal, find out which is the optimalEdge Cloud Zone for your specifc application, register your Edge-hosted application endpoints for rapid connectivity to the optimal Edge Cloud Zone. +Discover the Edge Cloud Zone with the shortest network path to an end user terminal, find out which is the optimal Edge Cloud Zone for your specifc application, register your Edge-hosted application endpoints for rapid connectivity to the optimal Edge Cloud Zone. # Workload Orchestration Lifecycle management of the Edge resources and servers for your applications @@ -10,4 +10,4 @@ Lifecycle management of the Edge resources and servers for your applications Management (CRUD) of the edge resources by the application providers for the consumption by edge applications. # Traffic Influence -Influence traffic routing to ensure optimal network perfromance based on user mobility, application demand, best Edge Cloud Zone. +Influence traffic routing to ensure optimal network performance based on user mobility, application demand, optimal Edge Cloud Zone.