README.md 2.45 KB
Newer Older
nikaeinn's avatar
nikaeinn committed
1
# MOSAIC5G Ecosystem 
nikaeinn's avatar
nikaeinn committed
2
M5G is an ecosystem of opensource platforms and use-cases for 4G-5G R&D to build a service delivery platform across reusable software components. 
nikaeinn's avatar
nikaeinn committed
3

nikaeinn's avatar
nikaeinn committed
4
Mosaic-5G is composed of the following submodules:
nikaeinn's avatar
nikaeinn committed
5

nikaeinn's avatar
nikaeinn committed
6
* The network Store 
nikaeinn's avatar
nikaeinn committed
7 8
* The JOX juju orchestrator
* The LL-MEC low latency MEC platform
nikaeinn's avatar
nikaeinn committed
9
* The FlexRAN and FlexCN real-time master controller
nikaeinn's avatar
nikaeinn committed
10 11
* The FlexRAN agent-r for monolitic and disaggregated RAN
* The FlexCN agent-c for  monolitic and disaggregated CN
nikaeinn's avatar
nikaeinn committed
12 13

This repository is designed to serve as a meta repository from where each 
nikaeinn's avatar
nikaeinn committed
14
submodules can be pulled. To get the code, 
nikaeinn's avatar
nikaeinn committed
15
* Create account at [gitlab.eurecom.fr](http://gitlab.eurecom.fr)
nikaeinn's avatar
nikaeinn committed
16
* Subscribe to [**Mosaic5G**](mailto:mosaic5g@lists.eurecom.fr) by clicking [subscribe](mailto:mailto:mosaic5g@lists.eurecom.fr?subject=subscribe mosaic5g YourGitAccount YourFirstName YourLastName) and replacing the following placeholders "YourGitAccount" "YourFirstName" "YourLastName"
nikaeinn's avatar
nikaeinn committed
17
* Clone this repository: 
nikaeinn's avatar
nikaeinn committed
18 19 20 21 22

```
git clone http://gitlab.eurecom.fr/mosaic5g/mosaic5g.git
```

nikaeinn's avatar
nikaeinn committed
23
* Run
nikaeinn's avatar
nikaeinn committed
24 25 26 27 28 29

```
git submodule init
```

Then choose to load the appropriate submodule depending on the deployment node 
nikaeinn's avatar
nikaeinn committed
30
(agent or controller). For more information about submodules, have a look at https://subfictional.com/fun-with-git-submodules/
nikaeinn's avatar
nikaeinn committed
31

nikaeinn's avatar
nikaeinn committed
32 33 34
## Store 
For the jox directory, simply run:
```
nikaeinn's avatar
nikaeinn committed
35
git submodule update store 
nikaeinn's avatar
nikaeinn committed
36 37 38 39
```
The source code of the jox  will be cloned from the appropriate repository
and can be found in the **store** directory.

nikaeinn's avatar
nikaeinn committed
40 41 42 43
## Jox juju orchestrator

For the jox directory, simply run:
```
nikaeinn's avatar
nikaeinn committed
44
git submodule update jox
nikaeinn's avatar
nikaeinn committed
45 46 47 48
```
The source code of the jox  will be cloned from the appropriate repository
and can be found in the **jox** directory.

nikaeinn's avatar
nikaeinn committed
49 50 51 52
## LL-MEC low latency MEC 

For the ll-mec, simply run:
```
nikaeinn's avatar
nikaeinn committed
53
git submodule update ll-mec
nikaeinn's avatar
nikaeinn committed
54 55 56 57 58
```
The source code of the ll-mec will be cloned and can be found in the 
**ll-mec** directory.

## FlexRAN and FlexCN real-time controller
nikaeinn's avatar
nikaeinn committed
59 60 61

For the FlexRAN controller simply run:
```
nikaeinn's avatar
nikaeinn committed
62
git submodule update controller
nikaeinn's avatar
nikaeinn committed
63 64 65 66 67
```
The source code of the controller will be cloned from the appropriate repository
and can be found in the **controller** directory.

## FlexRAN agent
nikaeinn's avatar
nikaeinn committed
68
For the FlexRAN agent-r simply run:
nikaeinn's avatar
nikaeinn committed
69
```
nikaeinn's avatar
nikaeinn committed
70
git submodule update agent-r
nikaeinn's avatar
nikaeinn committed
71 72
```
The source code of the agent will be cloned and can be found in the 
nikaeinn's avatar
nikaeinn committed
73
**agent-r** directory.
nikaeinn's avatar
nikaeinn committed
74

nikaeinn's avatar
nikaeinn committed
75
## FlexCN agent
nikaeinn's avatar
nikaeinn committed
76
For the FlexCN agent-c simply run:
nikaeinn's avatar
nikaeinn committed
77
```
nikaeinn's avatar
nikaeinn committed
78
git submodule update agent-c
nikaeinn's avatar
nikaeinn committed
79
```
nikaeinn's avatar
nikaeinn committed
80
The source code of the agent will be cloned and can be found in the 
nikaeinn's avatar
nikaeinn committed
81
**agent-c** directory.