summaryrefslogtreecommitdiff
path: root/docs/vpp/configuration/dataplane/cpu.md
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-06 21:05:20 +0300
committerGitHub <noreply@github.com>2026-05-06 21:05:20 +0300
commit7cf51e1c2901f6d1b01e9bff194f7188bc29e417 (patch)
treeafe2bc5b4426837530f2b4e0ab9840c81337a4c2 /docs/vpp/configuration/dataplane/cpu.md
parent631e454d674ad5111d2b56a6964ead461894a1f6 (diff)
parent97d12b42d997627be6f33528ba2625bd0378de74 (diff)
downloadvyos-documentation-7cf51e1c2901f6d1b01e9bff194f7188bc29e417.tar.gz
vyos-documentation-7cf51e1c2901f6d1b01e9bff194f7188bc29e417.zip
Merge pull request #1899 from vyos/feat/myst-as-primary-current
feat: MD as primary, RST as override — Phase 1 (rename + exclude flip on current)
Diffstat (limited to 'docs/vpp/configuration/dataplane/cpu.md')
-rw-r--r--docs/vpp/configuration/dataplane/cpu.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/vpp/configuration/dataplane/cpu.md b/docs/vpp/configuration/dataplane/cpu.md
new file mode 100644
index 00000000..d92f6587
--- /dev/null
+++ b/docs/vpp/configuration/dataplane/cpu.md
@@ -0,0 +1,71 @@
+---
+lastproofread: '2026-02-23'
+---
+
+(vpp-config-dataplane-cpu)=
+
+```{include} /_include/need_improvement.txt
+```
+
+
+# VPP Dataplane CPU Configuration
+
+VPP can utilize multiple CPU cores for better packet processing
+performance. Proper CPU configuration is essential for optimal
+throughput and low latency.
+
+VPP CPU assignment is handled automatically. You specify how many CPU
+cores VPP may use, and the system distributes them between the main
+thread and worker threads.
+
+:::{important}
+Review the system configuration settings page before changing CPU
+settings: {doc}`system`.
+:::
+
+If you don't configure CPU settings, VPP uses a single core for the
+main thread and doesn't create worker threads.
+
+## CPU Configuration Parameters
+
+### `cpu-cores`
+
+This parameter defines the total number of CPU cores allocated to VPP.
+
+```{cfgcmd} set vpp settings resource-allocation cpu-cores \<core-number\>
+```
+
+The system automatically assigns cores using the following rules:
+
+> - The first two CPU cores are always reserved for the operating system and
+> other services.
+> - The main VPP thread is assigned to the first available core after the
+> reserved ones.
+> - The remaining allocated cores are used for worker threads.
+
+For example:
+
+> - If cpu-cores is set to 1, VPP runs only a main thread.
+>
+> - If cpu-cores is set to 4, VPP uses:
+>
+> > - 1 core for the main thread
+> > - 3 cores for worker threads
+
+Choose a value based on available hardware resources and expected
+traffic load. Too few cores may limit performance, while too many can
+negatively impact other system services.
+
+## Potential Issues and Troubleshooting
+
+Improper CPU configuration can lead to issues such as:
+
+- VPP underperformance when not enough cores are assigned, or kernel
+ underperformance when too many cores are assigned to VPP.
+- Resource conflicts with other processes and services.
+
+Indicators of such issues are:
+
+- VPP or kernel forwarding performance is lower than expected
+- Degraded performance of system components or services, such as DNS,
+ DHCP, and dynamic routing