Commit 239c2bc3 authored by nikaeinn's avatar nikaeinn
Browse files

Update README.md

parent 8389fef6
# MOSAIC5G Ecosystem
# Subscribe and Get the MOSAIC5G Ecosystem
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.
Mosaic-5G is composed of the following submodules:
......@@ -11,71 +11,29 @@ Mosaic-5G is composed of the following submodules:
* The FlexCN agent-c for monolitic and disaggregated CN
This repository is designed to serve as a meta repository from where each
submodules can be pulled. To get the code,
* Create account at [gitlab.eurecom.fr](http://gitlab.eurecom.fr)
* 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"
* Clone this repository:
submodules can be pulled. Follow the instructions below to get the modules and build your platform.
```
git clone http://gitlab.eurecom.fr/mosaic5g/mosaic5g.git
```
* Run
1. Create a gitlab account at [gitlab.eurecom.fr](http://gitlab.eurecom.fr) page, and follow the instructions to create a user acount.
```
git submodule init
```
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"
Then choose to load the appropriate submodule depending on the deployment node
(agent or controller). For more information about submodules, have a look at https://subfictional.com/fun-with-git-submodules/
1. Clone this repository: `git clone http://gitlab.eurecom.fr/mosaic5g/mosaic5g.git`
## Store
For the jox directory, simply run:
```
git submodule update store
```
The source code of the jox will be cloned from the appropriate repository
and can be found in the **store** directory.
1. Build your service delivery platform
* From Snap: `./build_m5g `
* From Source: `./build_m5g `
## Jox juju orchestrator
For the jox directory, simply run:
```
git submodule update jox
```
The source code of the jox will be cloned from the appropriate repository
and can be found in the **jox** directory.
## LL-MEC low latency MEC
The above modules can be also manually updated as explaing below. You may also check the build_m5g script
For the ll-mec, simply run:
```
git submodule update ll-mec
```
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
For the FlexRAN controller simply run:
```
git submodule update controller
```
The source code of the controller will be cloned from the appropriate repository
and can be found in the **controller** directory.
## FlexRAN agent
For the FlexRAN agent-r simply run:
```
git submodule update agent-r
```
The source code of the agent will be cloned and can be found in the
**agent-r** directory.
## FlexCN agent
For the FlexCN agent-c simply run:
```
git submodule update agent-c
```
The source code of the agent will be cloned and can be found in the
**agent-c** directory.
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```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment