Start from your goal:
| I want to… | Read |
|---|---|
| understand what it is and how the pieces fit together | Architecture |
| test the core on one machine, without a radio | Tutorial 1 — First test with UERANSIM |
| build the complete network with a real radio | Installation |
| run the network day to day | Operation |
| solve a problem | Troubleshooting |
| change or extend the code | Development |
| Document | Content |
|---|---|
| architecture.md | machines and roles, components, networks (cluster, fiber, fronthaul), IPs, ports, folders, the path of a call |
| installation.md | requirements and installation order: core and dashboard → free5GC (optional) → OCUDU on Kubernetes |
| operation.md | after a boot, start/stop, switch core, subscribers, change the configuration, tests |
| troubleshooting.md | known cluster, core, radio and dashboard problems, with cause and fix |
| development.md | code map, the path of a configuration value, how to extend cores, gNB and dashboard |
| Document | Content |
|---|---|
| components/open5gs.md | default core: functions, installer, config.env reference, PLMN, slices, subscribers, versions |
| components/free5gc.md | optional core: installation, subscribers, phones, limitations |
| components/ueransim.md | simulated gNB and UE: how they are installed, nr-cli, tests |
| components/ocudu.md | real gNB on Kubernetes: image, RAN node, Deployment, one .yml per core, boot protection |
| components/dashboard.md | Innova Center Dashboard: tabs, configuration, agents, history, languages, API |
| hardware/e810-liteon.md | reference profile: Intel E810, PTP/GNSS, DPDK, XDP, LiteOn O-RU, n78 cell |
Step by step, from start to finish, with the expected result of each step.
| # | Tutorial | Time |
|---|---|---|
| 1 | First test with UERANSIM — install the core and see a UE browsing | 20 min |
| 2 | Dashboard tour — login, tabs and what each one shows | 15 min |
| 3 | OCUDU on Kubernetes — image, RAN node and the gNB as a pod | 1 h |
| 4 | Phone on the network — register the SIM, start the gNB and connect | 20 min |
| 5 | Switch core — install free5GC and switch from the dashboard | 30 min |
| 6 | Change PLMN, slices and IPs — edit and apply the configuration | 15 min |
| 7 | Change the gNB — edit the .yml or rebuild OCUDU |
30 min |
| 8 | Record and compare experiments — measure two setups in the dashboard | 20 min |
- Core machine = the k3s server (in the reference setup,
torre2). RAN machine = the k3s node with the radio (in the reference setup,innovaserver). Each command says which machine it runs on. sudoonly where stated. The other commands run as a regular user, inside the repository folder.- Example values (IPs, interface names,
.yml) are those of the reference setup; adjust them to yours.