README.md 2.12 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 14 15 16 17 18 19 20 21

This repository is designed to serve as a meta repository from where each 
submodules can be pulled. To get the code, simply clone this repository and 
from its main directory run

```
git submodule init
```

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

nikaeinn's avatar
nikaeinn committed
24 25 26
## Store 
For the jox directory, simply run:
```
nikaeinn's avatar
nikaeinn committed
27
git submodule update store --remote
nikaeinn's avatar
nikaeinn committed
28 29 30 31
```
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
32 33 34 35
## Jox juju orchestrator

For the jox directory, simply run:
```
nikaeinn's avatar
nikaeinn committed
36
git submodule update jox --remote
nikaeinn's avatar
nikaeinn committed
37 38 39 40
```
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
41 42 43 44
## LL-MEC low latency MEC 

For the ll-mec, simply run:
```
nikaeinn's avatar
nikaeinn committed
45
git submodule update ll-mec --remote
nikaeinn's avatar
nikaeinn committed
46 47 48 49 50
```
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
51 52 53

For the FlexRAN controller simply run:
```
nikaeinn's avatar
nikaeinn committed
54
git submodule update controller --remote
nikaeinn's avatar
nikaeinn committed
55 56 57 58 59
```
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
60
For the FlexRAN agent-r simply run:
nikaeinn's avatar
nikaeinn committed
61
```
nikaeinn's avatar
nikaeinn committed
62
git submodule update agent-r --remote
nikaeinn's avatar
nikaeinn committed
63 64
```
The source code of the agent will be cloned and can be found in the 
nikaeinn's avatar
nikaeinn committed
65
**agent-r** directory.
nikaeinn's avatar
nikaeinn committed
66

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