README.md 2.21 KB
Newer Older
nikaeinn's avatar
nikaeinn committed
1
# Subscribe and Get the 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. Follow the instructions below to get the modules and build your platform.
nikaeinn's avatar
nikaeinn committed
15 16


nikaeinn's avatar
nikaeinn committed
17
1. Create a gitlab account at [gitlab.eurecom.fr](http://gitlab.eurecom.fr) page, and follow the instructions to create a user acount.
nikaeinn's avatar
nikaeinn committed
18

nikaeinn's avatar
nikaeinn committed
19
1. Subscribe to [**Mosaic5G**](mailto:mosaic5g@lists.eurecom.fr) by clicking at [subscribe](mailto:mailto:mosaic5g@lists.eurecom.fr?subject=subscribe mosaic5g YourGitAccount YourFirstName YourLastName) and replace the following placeholders "YourGitAccount" "YourFirstName" "YourLastName"
nikaeinn's avatar
nikaeinn committed
20

nikaeinn's avatar
nikaeinn committed
21
1. Clone this repository:  `git clone http://gitlab.eurecom.fr/mosaic5g/mosaic5g.git`
nikaeinn's avatar
nikaeinn committed
22

nikaeinn's avatar
nikaeinn committed
23 24 25
1. Build your service delivery platform
    * From Snap: `./build_m5g `
    * From Source: `./build_m5g `
nikaeinn's avatar
nikaeinn committed
26

nikaeinn's avatar
nikaeinn committed
27 28


nikaeinn's avatar
nikaeinn committed
29
    The above modules can be also manually updated as explaing below. You may also check the build_m5g script 
nikaeinn's avatar
nikaeinn committed
30

nikaeinn's avatar
nikaeinn committed
31 32 33 34 35 36 37 38
    1. Inititialize all the Mosaic5G modules:  ```git submodule init``` 
    1. Load manually the appropriate submodule depending on the deployment node (e.g. ll-mec, agent-r, controller). The source code of each  submodule will be cloned from the appropriate repository and can be found in its respective directory. For more information about git submodules, have a look at https://subfictional.com/fun-with-git-submodules/
        * **Network store**:        ```git submodule update store; ```
        * **JoX Juju Orchestrator** : ```git submodule update jox ```
        * **LowLatency MEC**:  ```git submodule update ll-mec```
        * **FlexRAN Realtime Controller**: ```git submodule update controller```
        * **FlexRAN RAN Agent**: ```git submodule update agent-r```
        * **FlexRAN CN Agent**: ```git submodule update agent-c```