README.md 2.41 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
15
16
17
18
19
20
21
22
23
24
25
submodules can be pulled. To get the code, 
1. Create account at (gitlab.eurecom.fr)[http://gitlab.eurecom.fr'> gitlab.eurecom.fr]
1. Subscribe to [**Mosaic5G**](mailto:mosaic5g@lists.eurecom.fr): 
  for the users of OpenairInterface.
  [\[subscribe\]](mailto:mailto:mosaic5g@lists.eurecom.fr?subject=subscribe mosaic5g YourGitAccount YourFirstName YourLastName)
2. Clone this repository: 

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

3. Run
nikaeinn's avatar
nikaeinn committed
26
27
28
29
30
31

```
git submodule init
```

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

nikaeinn's avatar
nikaeinn committed
34
35
36
## Store 
For the jox directory, simply run:
```
nikaeinn's avatar
nikaeinn committed
37
git submodule update store 
nikaeinn's avatar
nikaeinn committed
38
39
40
41
```
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
42
43
44
45
## Jox juju orchestrator

For the jox directory, simply run:
```
nikaeinn's avatar
nikaeinn committed
46
git submodule update jox
nikaeinn's avatar
nikaeinn committed
47
48
49
50
```
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
51
52
53
54
## LL-MEC low latency MEC 

For the ll-mec, simply run:
```
nikaeinn's avatar
nikaeinn committed
55
git submodule update ll-mec
nikaeinn's avatar
nikaeinn committed
56
57
58
59
60
```
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
61
62
63

For the FlexRAN controller simply run:
```
nikaeinn's avatar
nikaeinn committed
64
git submodule update controller
nikaeinn's avatar
nikaeinn committed
65
66
67
68
69
```
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
70
For the FlexRAN agent-r simply run:
nikaeinn's avatar
nikaeinn committed
71
```
nikaeinn's avatar
nikaeinn committed
72
git submodule update agent-r
nikaeinn's avatar
nikaeinn committed
73
74
```
The source code of the agent will be cloned and can be found in the 
nikaeinn's avatar
nikaeinn committed
75
**agent-r** directory.
nikaeinn's avatar
nikaeinn committed
76

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