Skip to content

Commit 59e4860

Browse files
authored
Update README.md to align with Governance
Now uses template proposed in Governance issue 124
1 parent 3fcdf65 commit 59e4860

File tree

1 file changed

+19
-34
lines changed

1 file changed

+19
-34
lines changed

README.md

+19-34
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,31 @@
1-
# CAMARA Edge Cloud
1+
# Edge Cloud
22

3-
This repository produces APIs allowing interaction with a network's 'edge cloud'. These are compute, storage and other resources placed in the operator network at different zones.
3+
Repository to describe, develop, document, and test the §repo_name§ API family
44

55
## Scope
66

7-
* Service APIs for “Edge Cloud”:
8-
* Discover the closest edge cloud zone to a given device.
9-
* Provide and manage application images to be deployed on resources within the operator network.
10-
* Use reserved compute resources within the operator network for the deployment of applications on VMs or containers.
11-
* Influence the traffic routing from the user device toward the Edge instance of the Application.
12-
* NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G.
7+
* Service APIs for “Edge Cloud” (see APIBacklog.md)
8+
* It provides the customer with the ability to:
9+
..* Discover the closest edge cloud zone to a given device.
10+
..* Provide and manage application images to be deployed on resources within the operator network.
11+
..* Use reserved compute resources within the operator network for the deployment of applications on VMs or containers.
12+
..* Influence the traffic routing from the user device toward the Edge instance of the Application.
13+
..* NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G.
1314
* Describe, develop, document and test the APIs (with 1-2 Telcos)
1415
* Started: 5th July 2022
15-
* Location: virtually
1616

17-
# APIs
17+
# Contributing
1818

19-
YAML for all APIs can be found under [API_Definitions](https://github.com/camaraproject/EdgeCloud/tree/main/code/API_definitions)
19+
* Meetings
20+
..* Meeting link: [Registration](https://www.google.com/url?q=https://zoom-lfx.platform.linuxfoundation.org/meeting/94237809115?password%3D05fb6d8a-a913-47d8-b003-db75ecdaa5d9&sa=D&source=calendar&ust=1711304713775725&usg=AOvVaw2KsTGn2S2i4Bu5V-nusuUI)
21+
..* Schedule: Tuesdays 1400-1500 UTC, every two weeks.
22+
..* Minutes: [Access](https://wiki.camaraproject.org/display/CAM/Edge+Cloud)
2023

21-
## Simple Discovery API
22-
This API queries the network to find the closest Edge Cloud Zone to a given user device. 'Closest' means 'shortest network path', and hosting an application server on the closest Edge Cloud Zone will typically provide the lowest latency for that user device.
24+
# Release Information
2325

24-
## Traffic Influence API
25-
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.
26+
# Contributing
2627

27-
## Edge Cloud LCM (Lifecycle management)
28-
(todo: add text)
29-
30-
# Meetings
31-
* Meetings are held virtually
32-
* Schedule: Tuesdays 16h-17 CET, every two weeks.
33-
* Meeting link: [LFX Zoom](https://www.google.com/url?q=https://zoom-lfx.platform.linuxfoundation.org/meeting/94237809115?password%3D05fb6d8a-a913-47d8-b003-db75ecdaa5d9&sa=D&source=calendar&ust=1711304713775725&usg=AOvVaw2KsTGn2S2i4Bu5V-nusuUI)
34-
* Minutes of previous meetings [link](https://wiki.camaraproject.org/display/CAM/Edge+Cloud)
35-
36-
# Contributorship and mailing list
37-
38-
To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit [https://lists.camaraproject.org/g/sp-edc](https://lists.camaraproject.org/g/sp-edc).
39-
40-
A message to all Contributors of this Sub Project can be sent using [[email protected]]([email protected]).
41-
42-
CAMARA sp-edge-cloud: [Slack Channel(https://camara-project.slack.com/archives/C062PJNGW9F)
43-
44-
# Results
45-
* Sub Project is in progress
28+
* Meetings
29+
..* Subscribe / unsubscribe to the mailing list of this Sub Project [https://lists.camaraproject.org/g/sp-edc](https://lists.camaraproject.org/g/sp-edc).
4630

31+
..* A message to the community of this Sub Project can be sent using [[email protected]]([email protected]).

0 commit comments

Comments
 (0)