Skip to content

Commit 5eae333

Browse files
committed
docs(configuration): add PFCP dump examples and link from config_upf
1 parent 9e878f9 commit 5eae333

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

configuration/config_upf.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ Below you may find some of the upf override configuration.
99

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

12+
For an example of enabling PFCP raw-dump (values.yaml snippets) for the
13+
``pfcp-agent`` see :doc:`pfcp-dump-examples`.
14+
1215
UPF Address Pool
1316
-----------------
1417

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
PFCP Dump Examples
2+
===================
3+
4+
This file contains example ``values.yaml`` snippets to enable the PFCP raw-dump
5+
feature for debugging parse errors in the ``pfcp-agent`` container.
6+
7+
8+
Use transient storage (emptyDir) — good for testing/local/dev
9+
-----------------------------------------------------------
10+
11+
.. code-block:: yaml
12+
13+
upfDump:
14+
enabled: true
15+
dir: /var/log/upf/pfcp_dumps
16+
upfName: my-upf-instance
17+
maxBytes: 104857600 # 100 MiB total per-instance
18+
maxFiles: 1000
19+
toLog: false
20+
persistence:
21+
enabled: false
22+
23+
This will mount an ``emptyDir`` into the pod at ``/var/log/upf/pfcp_dumps`` and
24+
the runtime will prune files when the directory exceeds ``maxBytes`` or
25+
``maxFiles``.
26+
27+
Use persistent storage (PVC) — for production/long-term capture
28+
-------------------------------------------------------------
29+
30+
.. code-block:: yaml
31+
32+
upfDump:
33+
enabled: true
34+
dir: /var/log/upf/pfcp_dumps
35+
upfName: upf-01
36+
maxBytes: 1073741824 # 1 GiB
37+
maxFiles: 10000
38+
toLog: false
39+
persistence:
40+
enabled: true
41+
size: 10Gi
42+
storageClass: fast-ssd
43+
44+
This configuration will cause the chart to create a PersistentVolumeClaim named
45+
``<release>-pfcp-dump-pvc`` and mount it into the ``pfcp-agent`` container at
46+
the configured ``dir``.
47+
48+
Notes
49+
-----
50+
51+
- ``maxBytes`` and ``maxFiles`` are enforced by the UPF process (pruning).
52+
Set either to ``0`` to disable that limit.
53+
- ``toLog=true`` will also emit base64-encoded dumps to application logs — be
54+
careful in high-throughput environments.

0 commit comments

Comments
 (0)