diff --git a/conf.py b/conf.py index 356fdb7..844c5f5 100644 --- a/conf.py +++ b/conf.py @@ -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 diff --git a/configuration/config_upf.rst b/configuration/config_upf.rst index 91cb155..7cca30c 100644 --- a/configuration/config_upf.rst +++ b/configuration/config_upf.rst @@ -9,6 +9,60 @@ Below you may find some of the upf override configuration. Bess default values `can be found here `_ +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 +``-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 ----------------- diff --git a/dict.txt b/dict.txt index 88cc09d..0eba609 100644 --- a/dict.txt +++ b/dict.txt @@ -120,6 +120,7 @@ eNBID eNBs eNodeB eb +emptyDir eno epc equipments