Global Intents Flow graphs

[sergiofranciscoortiz]

This issue is to try to bring some clarity on dependencies and order of the intents included in https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/Harmonisation%20of%20APIs/describing%20and%20harmonising%20the%20Edge%20APIs.md
Currently there are 26 intents, to picture them in flow graphs, the following 4 types are suggested:

Intent group	Comments	Intents order
Discovery	Depend on MEC availability	23,1,2,3,4
Provisioning	Depend on Discovery intents	24,12,7,8,10,13,5,9,16
Runtime	Depends on Provisioning	21,19,20,25,6,26,17
Termination	Depend on Provisioning	18,15,11,14

Please note that there are not strict dependencies for each intent it is just a way to put some context. It would be more clear with flow graphs:

1. MEC Discovery

sequenceDiagram
    participant app
	participant dev
    participant operator
    participant hyperscaler
Note over operator: Provisioning intents.<br/> (Intent 23) I can publish an (ordered, filtered) list of my MECs, their coverage, capabilities and status
Note over operator,hyperscaler: Interaction needed to retrieve data from hyperscalers
	operator->>dev: List returned with following details: <br/> (Intent 1) Ordered by location and filtering by status <br/> (Intent 2) Capabilities/resources available at an operator’s MEC <br/> (Intent 3) Geographycal region covered
    app->>operator: GET closest MEC Platform (before provisioning)
    operator->>app: (Intent 4) Closest MEC returned in terms of Network path

Loading

2. MEC Provisioning

sequenceDiagram
    participant app
	participant dev
    participant operator
    participant hyperscaler
Note over operator: Provisioning intents.<br/> (Intent 24) I can map an application’s requirements to the best MEC for hosting it
    dev->>operator: (Intent 12) POST Reserve compute, storage and network resources
    operator->>dev: Confirm resources reservation
    dev->>operator: (Intent 7) Upload artifact, container or VM Images
     opt Upload to hyperscaler
     operator->>hyperscaler: Upload artifact
    end
    operator->>dev: Upload result 
    dev->>operator: (Intent 8) GET artifact details
    operator->>dev: Return artifact details
    dev->>operator: (Intent 10) POST Link artifact with apps for onboarding
    operator->>dev: Return artifact details
    dev->>operator: POST Provision my application using previously reserved resources (Intent 13) <br/> (Intent 5a) Just in the optimal MEC following criteria  <br/> (Intent 5b) Minimal set of  MEC meet criteria <br/> (Intent 5c) All MEC that meet criteria
    opt Provision in hyperscaler
     operator->>hyperscaler: Provision app instance
    end
    operator->>dev: Inform provision result and provide MEC data
    dev->>operator: (Intent 9) GET applications linked to an artifact 
    operator->>dev: Return app list linked to an artifact
    dev->>operator: (Intent 16) GET onboarded applications details
    operator->>dev: Return app onboarded applications

Loading

3. MEC Runtime

sequenceDiagram
    participant app
	participant dev
    participant operator
    participant hyperscaler

	Note over app,operator: Runtime
    app->>operator: (Intent 21) GET optimal MEC Platform 
    alt Closest network path
    opt If not running instances
        operator->>operator: Trigger app provision
        operator->>hyperscaler: Trigger app provision
    end
    operator->>app: (Intent 19) Closest MEC returned in terms of Network path
    else Other criteria
     opt If not running instances
        operator->>operator: Trigger app provision
        operator->>hyperscaler: Trigger app provision
    end
    operator->>app: (Intent 20) MEC returned based on Cost, MEC load
    end
    Note over operator: I can inform the developer of any event which changes which MEC is optimal for their application and connected terminals
    operator->>app: (Intent 25) POST Event change of optimal MEC (mobility or other reason)
    opt If app supports mobility 
    app->>operator: (Intent 6) PATCH/UPDATE optimal MEC Platform (Mobility or other reason)
    operator->>operator: (Intent 26) Move running application to a new MEC
        opt New MEC is in hyperscaler
            operator->>hyperscaler: (Intent 26) Move running application to a new MEC
        end
    operator->>app: Response with info of new MEC
    end
    dev->>operator: (Intent 17) GET app instance consumption details
    operator->>dev: Return app instance consumption details

Loading

4. MEC Termination

sequenceDiagram
    participant app
	participant dev
    participant operator
    participant hyperscaler

	Note over dev,operator: Service Termination
    dev->>operator: (Intent 18) DELETE Running instance (in all MEC or in a subset)
    opt Remove in hyperscaler
      operator->>hyperscaler: Remove app instance
    end
    dev->>operator: (Intent 15) DELETE APP onboarded ( in all MEC or in a subset) 
    operator->>dev: Deletion result
    dev->>operator: (Intent 11) DELETE Artifact, files
    opt Remove in hyperscaler
      operator->>hyperscaler: Remove Artifact
    end
    operator->>dev: Deletion result
    dev->>operator: (Intent 14) DELETE resource reservation 
    operator->>dev: Deletion result

Loading