-
Notifications
You must be signed in to change notification settings - Fork 49
Add EdgeCloud Intents and API Mapping document #395
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add EdgeCloud Intents and API Mapping document #395
Conversation
This document provides a harmonised view of EdgeCloud Intents and their corresponding CAMARA APIs, detailing the functional flow across the Edge Cloud lifecycle stages.
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
|
Thanks @ALIIQBAL786 , great job, some comments related with the name of the API that manages the lifecycle of the Application. |
Updated API mappings for EdgeCloud intents to reflect changes in API names and relationships.
Made some changes in Application management API user story
…pplication.Management.User.Story.md
Updated the EdgeCloud Lifecycle Intents table with new intents, descriptions, and mapped APIs, enhancing clarity and detail.
|
All changes have been addressed. |
|
Looks nice to me, if in the future something change, we can update the document. Thanks a lot @ALIIQBAL786 !! |
|
Indeed, great job @ALIIQBAL786 :) One comment:
The intent for Simple Edge Discovery is 'Discover the closest edge zone'. The intent for Simple Edge Discovery is 'Discover the best edge zone for my application'. So an operator implementing Simple Edge Discovery just needs to calculate the edge zone with the shortest network path to the user device. An operator implementing Optimal Edge Discovery adds context to that calculation (which edge zone can meet the application's compute/storage/networking demands) |
|
@Kevsy Thank you for the information. I will try to include these points in the document. |
Updating descriptions intent 1 2 3
|
All comments have been addressed. |
|
For me looks good, anything to add @Kevsy?? |
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
| |---------------|----------------|----------------------------|--------------------------------| | ||
| | **Intent 1** | Discover EdgeCloud Zones | Discover the closest Edge Cloud Zone to a user device based purely on network topology (shortest network path). | `Optimal Edge Discovery API` | | ||
| | **Intent 2** | List Available Regions / Capabilities | Discover the best Edge Cloud Zone for an application, considering compute, storage, and network performance requirements beyond distance. | Planned extension of Optimal Edge Discovery | | ||
| | **Intent 3** | Retrieve Zone Information | Obtain metadata, KPIs, and current resource availability of a specific Edge Cloud Zone. | `Simple Edge Discovery API` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not within scope of SimpleEdgeDiscovery - I think we may need to discuss a new collection endpoint of /edge-cloud-zones within Optimal Edge Discovery. That collection would represent the array of Edge Cloud Zones available to the API Publisher. The state of an individual Edge Cloud Zone in that collection could then be read with GET /edge-cloud-zones/{EdgeCloudZoneId}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Kevsy Thank you for the correction.
I am thinking that we can create an issue in Optimal Edge Discovery API for this.
For now, we can "Planned enhancement within Optimal Edge Discovery" for this intent.
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
| | **Intent 14** | Configure Network Policies | Manage slicing/routing preferences for traffic flows. | Evolution of Traffic Influence | | ||
| | **Intent 15** | Monitor Application Performance | Retrieve runtime telemetry: latency, usage, etc. | Future – Edge Telemetry API (proposed) | | ||
| | **Intent 16** | Retrieve Edge Metrics / Zone Health | Query Edge Zone health and operational metrics. | Under discussion – EdgeCloud Monitoring API | | ||
| | **Intent 17** | Automate Policy or Scaling Actions | Enable closed-loop orchestration and scaling triggers. | Future – Edge Orchestration Intent API | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How would this differ from a Kubernetes Resource Management API - e.g. Linux Foundation's Platform Mesh? Or is the intention to make an abstraction above that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This intent may operate as an abstraction layer on top of existing functions, enabling the inclusion of network resources within the orchestration workflow.
| | **Intent 18** | Terminate Application | Decommission instances and release resources. | `Edge Cloud Lifecycle Management API` | | ||
| | **Intent 19** | Deregister Application Endpoints | Remove obsolete endpoints from registry. | `Application Endpoint Registration API` | | ||
| | **Intent 20** | Audit and Logging | Track API operations, logs, and service usage. | Commonalities Cross-API Logging proposal | | ||
| | **Intent 21** | Federated Edge Discovery | Discover edge zones from partner operators/hyperscalers. | Proposed – Edge Federation Discovery API | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure we would need a separate API for this. If we can represent Edge Cloud Zones in the responses for SimpleEdgeDiscovery and OptimalEdgeDiscovery then it will be trivial not include zones that can be reached via federation (see also my comment above regarding an Edge Cloud Zone collection resource, which can also model this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It makes sense because CAMARA wants to abstract extra details about telecom complexity and it may be difficult for the developer to distinguish between the APIs which are purely based on telco concept.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, Should I add SimpleEdgeDiscovery and OptimalEdgeDiscovery in this intent?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think so - we can discuss on this week's call
documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
Outdated
Show resolved
Hide resolved
Kevsy
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ALIIQBAL786 , some comments / suggestions above for consideration.
…pping-Harmonisation.md Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
…pping-Harmonisation.md Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Kevsy
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ALIIQBAL786 , LGTM
|
Dear @Kevsy, @JoseMConde, Apologies for missing the last EdgeCloud meeting. I’m not sure what decisions were made during the meeting, but there are still some unresolved comments on this PR. Please let me know if any actions are needed from my side. |
|
Hi @ALIIQBAL786 , |
This document provides a harmonised view of EdgeCloud Intents and their corresponding CAMARA APIs, detailing the functional flow across the Edge Cloud lifecycle stages.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Introduces the EdgeCloud-Intents-and-API-Mapping-Harmonisation.md document under documentation/SupportingDocuments/.
Maps EdgeCloud Intents (from discovery → deployment → runtime → termination) to their corresponding CAMARA APIs.
Provides a harmonised lifecycle flow with Mermaid sequence and flow diagrams.
Adds Sections 7–11, covering harmonization analysis, data model and API dependencies
Serves as a reference for future alignment across CAMARA EdgeCloud subprojects and Open Gateway initiatives.
Which issue(s) this PR fixes:
Fixes #394
Special notes for reviewers:
Based on prior MEC & Deployment proposals (2022), updated with current CAMARA APIs (Optimal Edge Discovery, Application Endpoint Registration/Discovery, Traffic Influence).
Structured per Commonalities WG User Story Template.
Please review alignment and terminology consistency with other documentation in:
/Edge.Cloud.Lifecycle.Management.User.Story.md
/Application.Endpoint.Registration.User.Story.md
/Application.Endpoint.Discovery.User.Story.md
Changelog input
Additional documentation
This section can be blank.