How niloysh/open5gs-k8s works
Project type and purpose
• This is a Kubernetes-based deployment project (“open5gs-k8s”) for Open5GS, an open-source 5G Core network.
• It provides microservices manifests (in open5gs/), an all-in-one variant (open5gs-aio/), a WebUI (open5gs-webui/), MongoDB manifests (mongodb/), network attachments for Multus (networks5g/), RAN simulation via UERANSIM (ueransim/), multi-slice overlays (msd/), and Python CLI tools (mongo-tools/).
File structure
• Top-level directories:
• open5gs/, open5gs-aio/: core network function (NF) deployments
• open5gs-webui/: Web UI deployment
• mongodb/: persistent subscriber DB
• networks5g/: Multus CNI NADs for N2, N3, N4 interfaces
• ueransim/: simulated gNB & UE manifests
• msd/: Kustomize multi-slice overlays (slice‐specific SMF/UPF)
• mongo-tools/: Python scripts for admin/subscriber management
• bin/: helper scripts for logs & shells
• Kubernetes config is managed with Kustomize (kustomization.yaml files in each directory).
• The project uses Dockerfiles for custom NF images, and shell scripts to deploy/tear down the core and RAN.
README insights
• The README spells out a microservices architecture: each NF (AMF, SMF, UPF, UDM, UDR, NRF, NSSF, AUSF, BSF, PCF, SCP) runs as its own pod.
• Two deployment modes: Standard vs. “Monarch” (monitoring overlay).
• Network attachments define three logical networks (n2, n3, n4) via Multus + OVS-CNI.
• A WebUI and Python CLI/scripts manipulate MongoDB subscriber data.