summaryrefslogtreecommitdiff
path: root/docs/vpp/configuration/dataplane/ipsec.rst
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-06 20:42:32 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 20:42:32 +0300
commit5d6fa52b8985f8068314aba26878a1d7d5cb84e5 (patch)
tree99359ff282846e26b5c5fa2b9b176b35b172809f /docs/vpp/configuration/dataplane/ipsec.rst
parent631e454d674ad5111d2b56a6964ead461894a1f6 (diff)
downloadvyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.tar.gz
vyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.zip
feat: flip swap mechanism — MD as primary, RST as override (Phase 1)
This is the first of three phases inverting the per-page swap mechanism so MD becomes the canonical primary and RST becomes the rare override. Phase 1 — file renames + conf.py exclude_patterns flip only: - Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix) for the same 254 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty comment-only since no pages need the RST fallback right now - conf.py exclude_patterns flipped: rst-*.rst is now excluded by default instead of md-*.md - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce these names; for now no swap script runs because overrides list is empty) Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py with inverted rename direction, delete scripts/import_myst.py + tests, and update tests/test_swap_sources.py for the new semantics. Phase 3 will be the cleanup pass and ready-for-review flip. Generated by robots https://vyos.io
Diffstat (limited to 'docs/vpp/configuration/dataplane/ipsec.rst')
-rw-r--r--docs/vpp/configuration/dataplane/ipsec.rst72
1 files changed, 0 insertions, 72 deletions
diff --git a/docs/vpp/configuration/dataplane/ipsec.rst b/docs/vpp/configuration/dataplane/ipsec.rst
deleted file mode 100644
index 31734c86..00000000
--- a/docs/vpp/configuration/dataplane/ipsec.rst
+++ /dev/null
@@ -1,72 +0,0 @@
-:lastproofread: 2026-02-23
-
-.. _vpp_config_dataplane_ipsec:
-
-.. include:: /_include/need_improvement.txt
-
-#######################
-VPP IPsec Configuration
-#######################
-
-VPP supports IPsec (Internet Protocol Security) offloading from the
-kernel, which speeds up cryptographic operations by leveraging VPP's
-high-performance packet processing capabilities.
-
-IPsec does not require any specific configuration on VPP side. If both
-sources and destinations of the IPsec traffic are reachable via VPP
-interfaces, VPP will automatically offload the IPsec processing from
-the kernel. IPsec tunnels are configured in the VPN configuration
-section, see :ref:`ipsec_general`.
-
-IPsec Configuration Parameters
-==============================
-
-enable IPsec acceleration
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-When VPP is used for offloading IPsec, it creates a virtual interface to
-connect to peers. The interface type is always 'ipsec', which is used for
-IPsec tunnels.
-
-.. cfgcmd:: set vpp settings ipsec-acceleration
-
-Enabling this option allows VPP to handle IPsec traffic more efficiently by
-offloading processing from the kernel.
-
-netlink
-^^^^^^^
-
-VPP uses netlink to receive IPsec event messages from the kernel. Proper
-settings of the following parameters are crucial for ensuring that VPP can
-process all such messages:
-
-.. cfgcmd:: set vpp settings lcp netlink batch-delay-ms <milliseconds>
-
-This parameter specifies the delay in milliseconds between processing
-batch netlink messages.
-
-.. cfgcmd:: set vpp settings lcp netlink batch-size <number>
-
-This parameter specifies the maximum number of netlink messages to
-process in a single batch.
-
-.. cfgcmd:: set vpp settings lcp netlink rx-buffer-size <number>
-
-This parameter specifies the size of the receive buffer for netlink
-socket. If you expect to offload many IPsec tunnels or get frequent and
-intensive rekeying, you may need to increase this value.
-
-.. note::
-
- IPsec uses the same netlink parameters as LCP, so tuning them
- affects both LCP and IPsec processing.
-
-Potential Issues and Troubleshooting
-====================================
-
-Improper IPsec configuration can lead to various issues, including:
-
-- Failure to offload IPsec tunnels to VPP
-- Lost IPsec event messages due to insufficient netlink buffer size or
- batch settings
-- IPsec states or SAs are not synchronized between kernel and VPP