Skip to content

Commit 9e878f9

Browse files
committed
docs: add PFCP dump examples
1 parent cca2678 commit 9e878f9

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

pfcp-dump-examples.md

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

0 commit comments

Comments
 (0)