Skip to content
Merged
1 change: 1 addition & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,7 @@ def get_version():
r'https://jenkins.aetherproject.org/.*',
r'https://gerrit.opencord.org/.*',
r'https://wiki.opennetworking.org/.*',
r'https?://opennetworking\.org/.*',
]

linkcheck_timeout = 3
Expand Down
54 changes: 54 additions & 0 deletions configuration/config_upf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,60 @@ Below you may find some of the upf override configuration.

Bess default values `can be found here <https://github.com/omec-project/sdcore-helm-charts/blob/main/bess-upf/values.yaml>`_

PFCP Dump Examples
------------------

This contains ``values.yaml`` snippets to enable the PFCP raw-dump
feature for debugging parse errors in the ``pfcp-agent`` container.

Use transient storage (empty dir)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: yaml

upfDump:
enabled: true
dir: /var/log/upf/pfcp_dumps
upfName: my-upf-instance
maxBytes: 104857600 # 100 MiB total per-instance
maxFiles: 1000
toLog: false
persistence:
enabled: false

This will mount an ``emptyDir`` into the pod at ``/var/log/upf/pfcp_dumps`` and
the runtime will prune files when the directory exceeds ``maxBytes`` or
``maxFiles``.

Use persistent storage (PVC)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: yaml

upfDump:
enabled: true
dir: /var/log/upf/pfcp_dumps
upfName: upf-01
maxBytes: 1073741824 # 1 GiB
maxFiles: 10000
toLog: false
persistence:
enabled: true
size: 10Gi
storageClass: fast-ssd

This configuration will cause the chart to create a PersistentVolumeClaim named
``<release>-pfcp-dump-pvc`` and mount it into the ``pfcp-agent`` container at
the configured ``dir``.

Notes
^^^^^

- ``maxBytes`` and ``maxFiles`` are enforced by the UPF process (pruning).
Set either to ``0`` to disable that limit.
- ``toLog=true`` will also emit base64-encoded dumps to application logs — be
careful in high-throughput environments.

UPF Address Pool
-----------------

Expand Down
1 change: 1 addition & 0 deletions dict.txt
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ eNBID
eNBs
eNodeB
eb
emptyDir
eno
epc
equipments
Expand Down
Loading