5G-Monarch is a network slice monitoring architecture for cloud native 5G network deployments. This repository contains the source code and configuration files for setting up 5G-MonArch, in conjunction with a 5G network deployment.
The figure above shows the conceptual architecture of Monarch. Monarch is designed for cloud-native 5G deployments and focuses on network slice monitoring and per-slice KPI computation.
- 5G-Monarch
- Hardware Requirements
- Prerequisites
- Quick Start
- Visualizing network slices KPIs using Monarch
- Citation
- Contributions
- Supported OS: Ubuntu 22.04 LTS (recommended) or Ubuntu 20.04 LTS
- Minimum Specifications: 8 cores, 16 GB RAM
The open5gs-k8s repository contains the source code and configuration files for deploying a 5G network using Open5GS on Kubernetes. Please follow the detailed instructions in the open5gs-k8s repository to set up your 5G network.
Note
To enable metrics collection for monitoring purposes, select the Deployment with Monarch option while deploying open5gs-k8s.
After deploying the 5G network, ensure that two network slices have been successfully configured by performing a ping test to verify connectivity. This step confirms that the network is functioning correctly and is ready for Monarch deployment.
To quickly set up the Monarch system, follow these steps:
git clone https://github.com/niloysh/5g-monarch.git
cd 5g-monarch
./deploy-all.sh
This script will deploy all core and external components needed for Monarch in a single step.
For a step-by-step deployment process, including individual component setup and configuration, refer to the deployment slides.
The dashboard below shows Monarch being used to monitor network slices for a cloud-gaming use-case during a demo at the University of Waterloo.
If you use the code in this repository in your research work or project, please consider citing the following publication.
N. Saha, N. Shahriar, R. Boutaba and A. Saleh. (2023). MonArch: Network Slice Monitoring Architecture for Cloud Native 5G Deployments. In Proceedings of the IEEE/IFIP Network Operations and Management Symposium (NOMS). Miami, Florida, USA, 08 - 12 May, 2023.
Contributions, improvements to documentation, and bug-fixes are always welcome! See first-contributions.