# omec-project/sdcore-helm-charts architecture

> Architecture diagram of the GitHub repository omec-project/sdcore-helm-charts, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/omec-project/sdcore-helm-charts
- Repository: https://github.com/omec-project/sdcore-helm-charts

## Overview

##### Project type and purpose
- This repo is a collection of Helm charts (Kubernetes package manager) designed to deploy Aether SD-Core on a K8s cluster.
- It includes an umbrella chart (`sdcore-helm-charts`) that pulls in several sub-charts:
– 5G Control Plane (`5g-control-plane` / `omec-control-plane`)
– RAN Simulator (`5g-ran-sim`)
– Subscriber Provisioner (`omec-sub-provision`)
– User Plane (BESS-UPF) (`bess-upf`)
– Router service (`router`)
– Test applications (`5g-test-apps`)

##### File structure
- Top-level directories are individual Helm charts, each with:
- `Chart.yaml`, `values.yaml`, `templates/` (configmap, deployment, service, statefulset, scripts)
- The umbrella chart (`sdcore-helm-charts`) declares dependencies on those sub-charts.
- Each sub-chart follows the standard Helm pattern: templated `ConfigMap`s, `Secret`s, `Deployment`/`StatefulSet`, `Service`, plus `bin/*.tpl` startup scripts.
- CI/CD workflows (`.github/workflows`) automate linting, packaging, and pushing charts.

##### Insights from the README
- Emphasizes overriding `values.yaml` with Aether-OnRamp’s `sdcore-5g-values.yaml` for real deployments.
- The charts deploy all network functions required by 5G core (AMF, SMF, PCF, UDM, NRF, NSSF, etc.), plus user-plane and RAN simulator.
- OnRamp handles cluster networking for N2/N3/N6 interfaces; charts expect those to be configured.

– Clear labels: “Umbrella Chart”, “Control Plane Chart”, “RAN Sim Chart”, etc.
- Control-plane signaling (N2, N11, Nrf API calls)
- Data-plane flow (N3, N6)
- Provisioning calls (simapp → webui API)
- Blue for control-plane functions
- Green for data-plane (UPF)
- Orange for simulator/test apps
- Gray for Helm/templating layer
- Hexagons for external systems

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Umbrella Helm Chart
    subgraph "Helm Deployment Layer"
        direction TB
        Umbrella["Umbrella Chart Controller"]:::helm
    end

    %% Sub-charts dependency
    subgraph "Sub-Charts (Helm Dependencies)"
        direction TB
        CP["5G Control Plane Chart"]:::control
        OMEC_CP["OMEC Control Plane Chart"]:::control
        RAN["RAN Simulator Chart"]:::sim
        PROV["Subscriber Provisioner Chart"]:::sim
        UPF["User Plane (BESS-UPF) Chart"]:::dataplane
        ROUTER["Router Service Chart"]:::dataplane
        TEST["Test Applications Chart"]:::sim
    end

    %% Kubernetes Cluster
    subgraph "Kubernetes Cluster (Namespace: aether-5gc)"
        direction TB
        subgraph "Control Plane NF Pods"
            direction TB
            AMF["AMF"]:::control
            UDM["UDM"]:::control
            PCF["PCF"]:::control
            NRF["NRF"]:::control
            NSSF["NSSF"]:::control
            SMF["SMF"]:::control
        end

        subgraph "User Plane"
            direction TB
            UPF_Pod["BESS-UPF Pod"]:::dataplane
            ROUTER_Pod["Router Pod"]:::dataplane
        end

        RAN_Pod["RAN Sim Pod"]:::sim
        PROV_Pod["Provisioner Pod"]:::sim
        TEST_Pod["Test Apps Pod"]:::sim
    end

    %% External Systems
    gNB["gNB Devices"]:::external
    Internet["External Data Network"]:::external
    OnRamp["Aether OnRamp Networking"]:::external

    %% Helm dependencies arrows
    Umbrella -->|depends on| CP
    Umbrella -->|depends on| OMEC_CP
    Umbrella -->|depends on| RAN
    Umbrella -->|depends on| PROV
    Umbrella -->|depends on| UPF
    Umbrella -->|depends on| ROUTER
    Umbrella -->|depends on| TEST

    %% Control-plane signaling
    RAN_Pod -->|N2| AMF
    SMF -->|N4 Control| UPF_Pod
    AMF <-->|N11/Nrf API| UDM
    AMF <-->|N11/Nrf API| PCF
    AMF <-->|Nrf API| NRF
    AMF <-->|Nnssf API| NSSF

    %% Data-plane flow
    RAN_Pod -->|N3 Data| UPF_Pod
    UPF_Pod -->|N6 Data| ROUTER_Pod
    ROUTER_Pod -->|Egress| Internet

    %% Provisioning and Test
    PROV_Pod -->|REST API| AMF
    TEST_Pod -->|Test Traffic| RAN_Pod
    TEST_Pod -->|Test Traffic| UPF_Pod

    %% External Networking
    OnRamp -->|provides N2/N3/N6| RAN_Pod
    OnRamp -->|provides N2/N3/N6| UPF_Pod

    %% Click Events
    click Umbrella "https://github.com/omec-project/sdcore-helm-charts/blob/main/sdcore-helm-charts/Chart.yaml"
    click CP "https://github.com/omec-project/sdcore-helm-charts/blob/main/5g-control-plane/Chart.yaml"
    click CP "https://github.com/omec-project/sdcore-helm-charts/tree/main/5g-control-plane/templates/"
    click OMEC_CP "https://github.com/omec-project/sdcore-helm-charts/blob/main/omec-control-plane/Chart.yaml"
    click OMEC_CP "https://github.com/omec-project/sdcore-helm-charts/tree/main/omec-control-plane/templates/"
    click RAN "https://github.com/omec-project/sdcore-helm-charts/blob/main/5g-ran-sim/Chart.yaml"
    click RAN "https://github.com/omec-project/sdcore-helm-charts/tree/main/5g-ran-sim/templates/"
    click PROV "https://github.com/omec-project/sdcore-helm-charts/blob/main/omec-sub-provision/Chart.yaml"
    click PROV "https://github.com/omec-project/sdcore-helm-charts/tree/main/omec-sub-provision/templates/"
    click UPF "https://github.com/omec-project/sdcore-helm-charts/blob/main/bess-upf/Chart.yaml"
    click UPF "https://github.com/omec-project/sdcore-helm-charts/tree/main/bess-upf/templates/"
    click ROUTER "https://github.com/omec-project/sdcore-helm-charts/blob/main/router/Chart.yaml"
    click ROUTER "https://github.com/omec-project/sdcore-helm-charts/tree/main/router/templates/"
    click TEST "https://github.com/omec-project/sdcore-helm-charts/blob/main/5g-test-apps/Chart.yaml"
    click TEST "https://github.com/omec-project/sdcore-helm-charts/tree/main/5g-test-apps/templates/"
    click CI1 "https://github.com/omec-project/sdcore-helm-charts/blob/main/.github/workflows/main.yml"
    click CI2 "https://github.com/omec-project/sdcore-helm-charts/blob/main/.github/workflows/push.yml"

    %% Styles
    classDef helm fill:#dddddd,stroke:#888888,color:#333333;
    classDef control fill:#aaddff,stroke:#0066aa,color:#004477;
    classDef dataplane fill:#aaffaa,stroke:#00aa00,color:#007700;
    classDef sim fill:#ffdd99,stroke:#dd8800,color:#aa5500;
    classDef external fill:#eeeeee,stroke:#777777,color:#555555;
```
