-
Notifications
You must be signed in to change notification settings - Fork 51
Update and rename Edge.Cloud.Lifecycle.Management.User.Story.md to Ed… #402
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
82 changes: 0 additions & 82 deletions
82
...ts/API_Documentation/User Stories/Edge.Cloud.Lifecycle.Management.User.Story.md
This file was deleted.
Oops, something went wrong.
59 changes: 59 additions & 0 deletions
59
...ocuments/API_Documentation/User Stories/EdgeApplicationManagement_User_Story.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| ## Actors, Roles, and Scope | ||
| | Actor | Role | Scope | | ||
| |-------|------|-------| | ||
| |Application Provider (AP) |API Consumer | API Requester | | ||
| |Edge Service Provider (ESP)|Edge Cloud Provider|API Publisher | | ||
| |MNO|Communications Service Provider|API Publisher | | ||
| |User Client(UC)|API Consumer|API Requester | | ||
|
|
||
| Note: the role of Edge Service Provider may be played by different entities, for example: MNOs, Hyperscalers, etc | ||
|
|
||
|
|
||
|
|
||
| | Item | Description | Support Qualifier | | ||
| |----|----|----| | ||
| |Summary|Network operators offers a Multi-access Edge Computing platform in a given territory with several levels of abstraction being the Edge Cloud Zone the lowest one. Network operators offers a service through EdgeCloud APIs that permits application providers to deploy instances of an application in one or several Edge Cloud Zones, and to Applications Users the posibility to chose the most appropriate Edge Cloud Zone available at a given moment| M | | ||
| |Pre-conditions|The AP has a resource usage agreement with the Operator Platform| M | | ||
| |Begins when|The Application Provider (AP) invokes the Edge Application Management API to submit an application with references to obtain all needed data for their instantiation (container images or VM images and manifests describing required resources by an application)| M | | ||
| |Step 1|The ESP stores the app information and returns an Id for reference (terminates with a notification to the AP if error)| M | | ||
| |Step 2|The Application Provider (AP) request information of currently available Edge Cloud Zones and their status | M| | ||
| |Step 3|The MNO provides the availables Edge Cloud Zones where the AP could instantiate the Application| M | | ||
| |Step 4|The AP instantiates the application in one Edge Cloud Zone or in Severals| M| | ||
| |Step 5|The ESP response to the AP appInstance created| M | | ||
| |Step 6|The AP may request updated information of existing app instances of a given app. Possible status for app instantiation includes "ready" also information for endpoint info is provided for the app instance| O | | ||
| |Step 7|App instance may provide service for end users | O | | ||
| |Step 8|The AP request termination of one app instance (optionally all app instances in a given region) | M | | ||
| |Step 9|The ESP validates the request (terminates with a notification to the UE if content is not valid e.g. given appId does not exist)| M| | ||
| |Step 10|The ESP response to the AP and starts the termination of the app instance, moving its status to terminating| M| | ||
| |Ends when|The UC connects to the EAS| M | | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Flow | ||
| ```mermaid | ||
| sequenceDiagram | ||
| participant AP | ||
| participant MNO | ||
| participant ESP(Operator/Hyperscaler) | ||
|
|
||
| Note over AP,MNO: PRE App on device attached <br/> to operator network | ||
| Note over AP,MNO: PRE App developer registered, <br/> authenticated and authorised | ||
| Note over MNO,MNO: Edge Application Management API | ||
| AP->>ESP(Operator/Hyperscaler): POST/ AP Invokes Edge Application Management API to submit an application with references to obtain all needed data for their instantiation(appManifest) | ||
| ESP(Operator/Hyperscaler)->>AP: The Operator stores the app information and returns an Id for reference(appId) | ||
| alt app has a local mapping of server endpoints to Edge Cloud Zones | ||
| AP->>MNO: GET/edge-cloud-zones AP request information about available Edge cloud zones | ||
| MNO->>AP: Returns the name of the available Edge cloud zones for the Application | ||
| AP->>ESP(Operator/Hyperscaler):POST/ The AP request to instantiate the App in one or several Edge Clod Zones(Deployment). | ||
| ESP(Operator/Hyperscaler)->>AP:Returns the appInstance created | ||
| AP->>MNO: GET /app (appId) Information about app(appId) instantiated | ||
| MNO->>AP: Returns the application instance information | ||
| AP->>MNO: DELETE /app (appId) DELETE Running instance for a given appId. | ||
| alt delete only the instance related with the appId | ||
| MNO->>ESP(Operator/Hyperscaler): Delete instance | ||
| ESP(Operator/Hyperscaler)->>MNO: Instance deleted | ||
| MNO->>AP: Application instance deleted | ||
| end | ||
| end | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.