Skip to content

Conversation

@ALIIQBAL786
Copy link
Contributor

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:

  • documentation

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

 release-note
Added new harmonisation document:
"EdgeCloud-Intents-and-API-Mapping-Harmonisation.md" 
covering intents, API mappings, lifecycle flow, and inter-API dependencies.

Additional documentation

This section can be blank.

This PR adds a harmonised view document aligning CAMARA EdgeCloud APIs with earlier MEC intent mappings and GSMA Open Gateway harmonisation frameworks.

This document provides a harmonised view of EdgeCloud Intents and their corresponding CAMARA APIs, detailing the functional flow across the Edge Cloud lifecycle stages.
@JoseMConde
Copy link
Collaborator

Thanks @ALIIQBAL786 , great job, some comments related with the name of the API that manages the lifecycle of the Application.
Other thing, could be interesting to have also the intents that we don't cover right now with the existing APIs??

Updated API mappings for EdgeCloud intents to reflect changes in API names and relationships.
Made some changes in Application management API user story
Updated the EdgeCloud Lifecycle Intents table with new intents, descriptions, and mapped APIs, enhancing clarity and detail.
@ALIIQBAL786
Copy link
Contributor Author

All changes have been addressed.
@JoseMConde Please let me know if anything is missing in the section 4 (API Intent)

@JoseMConde
Copy link
Collaborator

Looks nice to me, if in the future something change, we can update the document. Thanks a lot @ALIIQBAL786 !!

JoseMConde
JoseMConde previously approved these changes Oct 21, 2025
@Kevsy
Copy link
Collaborator

Kevsy commented Oct 22, 2025

Indeed, great job @ALIIQBAL786 :)

One comment:

| Intent 1 | Discover EdgeCloud Zones | Identify available Edge Cloud Zones, regions, and topology. | Optimal Edge Discovery API |

| Intent 3 | Retrieve Zone Information | Obtain metadata, KPIs, or status of an Edge Cloud Zone. | Simple Edge Discovery API |

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)

@ALIIQBAL786
Copy link
Contributor Author

@Kevsy Thank you for the information. I will try to include these points in the document.

Updating descriptions intent 1 2 3
@ALIIQBAL786
Copy link
Contributor Author

All comments have been addressed.

@JoseMConde
Copy link
Collaborator

For me looks good, anything to add @Kevsy??

|---------------|----------------|----------------------------|--------------------------------|
| **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` |
Copy link
Collaborator

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}

Copy link
Contributor Author

@ALIIQBAL786 ALIIQBAL786 Nov 12, 2025

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.

| **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 |
Copy link
Collaborator

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?

Copy link
Contributor Author

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 |
Copy link
Collaborator

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

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?

Copy link
Collaborator

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

Copy link
Collaborator

@Kevsy Kevsy left a 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.

ALIIQBAL786 and others added 3 commits November 12, 2025 14:14
…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>
Copy link
Collaborator

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ALIIQBAL786 , LGTM

@ALIIQBAL786
Copy link
Contributor Author

ALIIQBAL786 commented Dec 11, 2025

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.

@JoseMConde
Copy link
Collaborator

Hi @ALIIQBAL786 ,
We talked about this PR in the last meeting, @Kevsy missed the last commits but I think he reviewed yesterday and everything is OK. So we can merge the PR if both of you agree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add EdgeCloud Intents and API Mapping Harmonisation Document

3 participants