Skip to content

Commit ce93b3c

Browse files
committed
docs(configuration): inline PFCP dump examples into config_upf and remove separate file
Signed-off-by: Arnav Kapoor <[email protected]>
1 parent 588bcfd commit ce93b3c

File tree

2 files changed

+57
-2
lines changed

2 files changed

+57
-2
lines changed

configuration/config_upf.rst

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,63 @@ Below you may find some of the upf override configuration.
1010
Bess default values `can be found here <https://github.com/omec-project/sdcore-helm-charts/blob/main/bess-upf/values.yaml>`_
1111

1212
For an example of enabling PFCP raw-dump (values.yaml snippets) for the
13-
``pfcp-agent`` see :doc:`pfcp-dump-examples`.
13+
``pfcp-agent`` see the "PFCP Dump Examples" section below.
14+
15+
16+
PFCP Dump Examples
17+
------------------
18+
19+
This file contains example ``values.yaml`` snippets to enable the PFCP raw-dump
20+
feature for debugging parse errors in the ``pfcp-agent`` container.
21+
22+
23+
Use transient storage (empty dir)
24+
--------------------------------------------------
25+
26+
.. code-block:: yaml
27+
28+
upfDump:
29+
enabled: true
30+
dir: /var/log/upf/pfcp_dumps
31+
upfName: my-upf-instance
32+
maxBytes: 104857600 # 100 MiB total per-instance
33+
maxFiles: 1000
34+
toLog: false
35+
persistence:
36+
enabled: false
37+
38+
This will mount an ``emptyDir`` into the pod at ``/var/log/upf/pfcp_dumps`` and
39+
the runtime will prune files when the directory exceeds ``maxBytes`` or
40+
``maxFiles``.
41+
42+
Use persistent storage (PVC)
43+
-----------------------------------------------
44+
45+
.. code-block:: yaml
46+
47+
upfDump:
48+
enabled: true
49+
dir: /var/log/upf/pfcp_dumps
50+
upfName: upf-01
51+
maxBytes: 1073741824 # 1 GiB
52+
maxFiles: 10000
53+
toLog: false
54+
persistence:
55+
enabled: true
56+
size: 10Gi
57+
storageClass: fast-ssd
58+
59+
This configuration will cause the chart to create a PersistentVolumeClaim named
60+
``<release>-pfcp-dump-pvc`` and mount it into the ``pfcp-agent`` container at
61+
the configured ``dir``.
62+
63+
Notes
64+
-----
65+
66+
- ``maxBytes`` and ``maxFiles`` are enforced by the UPF process (pruning).
67+
Set either to ``0`` to disable that limit.
68+
- ``toLog=true`` will also emit base64-encoded dumps to application logs — be
69+
careful in high-throughput environments.
1470

1571
UPF Address Pool
1672
-----------------

index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ can be found on the `SD-Core Wiki
7070
configuration/config_rest.rst
7171
configuration/config_simapp.rst
7272
configuration/application_filtering.rst
73-
configuration/pfcp-dump-examples.rst
7473
configuration/qos_config.rst
7574
configuration/config_upf.rst
7675

0 commit comments

Comments
 (0)