summaryrefslogtreecommitdiff
path: root/docs/vpp/configuration/nat
diff options
context:
space:
mode:
authorzdc <zdc@users.noreply.github.com>2025-09-25 14:44:23 +0300
committerGitHub <noreply@github.com>2025-09-25 12:44:23 +0100
commit6b2e69a687b76d5fbcf61e3f05cae66c47f88612 (patch)
tree03b4e6daadaaae6280ce91d66f6f8fcd581ffe0d /docs/vpp/configuration/nat
parent9da339ebf8ff5eac73f2933d3051102919975a32 (diff)
downloadvyos-documentation-6b2e69a687b76d5fbcf61e3f05cae66c47f88612.tar.gz
vyos-documentation-6b2e69a687b76d5fbcf61e3f05cae66c47f88612.zip
vpp: Enhanced memory, buffers, and CGNAT documentation, added troubleshooting (#1687)
* vpp: Enhanced memory and buffer configuration documentation - Added physmem configuration section with practical examples and troubleshooting - Clarified relationship between physmem and buffer allocation with cross-references - Improved VPP logging documentation with detailed log location descriptions - Fixed formatting issues in system configuration * vpp: Added CGNAT memory requirements Expanded CGNAT settings page with information about: - Memory requirements - Hardcoded simultaneous sessions limit * vpp: Added troubleshooting page Added page with basic steps for troubleshooting: - Capturing packets (PCAP) - Tracing packets - Additional diagnostics information from VPP - Automatic collection of most details with Python script --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
Diffstat (limited to 'docs/vpp/configuration/nat')
-rw-r--r--docs/vpp/configuration/nat/cgnat.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/vpp/configuration/nat/cgnat.rst b/docs/vpp/configuration/nat/cgnat.rst
index 6f97d209..d941f8ba 100644
--- a/docs/vpp/configuration/nat/cgnat.rst
+++ b/docs/vpp/configuration/nat/cgnat.rst
@@ -59,6 +59,23 @@ Sets the inside prefix (private IP range) that will be translated.
Sets the outside prefix (public IP range) that will be used for translation.
+.. important::
+
+ **Memory Requirements**
+
+ CGNAT memory usage scales with the number of internal customers.
+
+ **Each 256 customers** (equivalent to a /24 subnet) requires approximately **4 MB of main heap memory**. This memory is used for maintaining customer-to-port mappings and session state information.
+
+ Ensure your VPP main heap size is configured appropriately based on your expected customer count. See :ref:`VPP Memory Configuration <vpp_config_dataplane_memory>` for details on adjusting main heap size.
+
+Session Limitations
+-------------------
+
+CGNAT has built-in session limitations to ensure fair resource allocation:
+
+**Each customer (internal IP address) is limited to a maximum of 1000 simultaneous sessions**, even if more than 1000 ports are allocated to that customer. This limitation applies to all types of sessions (TCP, UDP, ICMP).
+
Timeouts Configuration
----------------------