VyOS readthedocs (mirror of https://github.com/vyos/vyos-documentation.git) https://git.amelek.net/vyos/vyos-documentation.git/atom?h=mergify%2Fbp%2Fcircinus%2Fpr-2233 2026-09-17T14:23:22+00:00 2026-09-17T14:23:22+00:00 結友 miagetegorann@gmail.com 2026-09-15T10:47:32+00:00 urn:sha1:55e422a5f36ea7558dbb418a4b2f51b944e4b5b8 * docs: vpp: document that kernel prerequisites need their own commit and reboot VPP depends on hugepages and, since T8460, on isolated CPUs. Both are configured under "system option kernel", take effect only after a reboot, and are validated by VPP against the running kernel. Because "vpp" is committed at priority 295 and "system option" at 9999, the two can never be applied in the same commit - the VPP part is always rejected with "Not enough free memory to start VPP!" or "Not enough isolated CPU cores available", both of which point back at the very command the user just issued. This is independent of the NIC: the checks that fail take no interface or PCI information and run before the NIC validation. It was reproduced both with an unsupported NIC and with a validated one. Such a commit is also partial: the "system option kernel" part is applied even though the commit is reported as failed, while the "set vpp ..." statements are discarded and have to be re-entered after the reboot. The "Optimal Configuration Example" showed exactly this failing one-shot form, mixing "set system option kernel ..." and "set vpp settings ..." in a single block. Split it into the two stages that actually work and state why, and add hugepages to it so the example covers every prerequisite. Also: * add a short "Kernel Configuration" item to the requirements page, which is what a first-time user reads and which had no pointer to the kernel settings at all * document the isolated-CPU requirement on the cpu-cores page, which did not mention "isolate-cpus" * add the missing 1af4:1041 (virtio modern ID) row to the validated NIC table - it is present in SUPPORTED_PCI_IDS but was absent here * correct the allow-unsupported-nics note, which said the check is bypassed "for the specified devices". There are no specified devices: _is_device_allowed() returns True for every interface as soon as the option is set, including interfaces attached later. That wording is a leftover from the per-PCI-ID form originally proposed in T8315, which was merged as a single boolean. Verified by building the docs; the three changed pages produce no Sphinx warnings. Claude-Session: https://claude.ai/code/session_01EQsKVSw5hhDu7jPq1YzQvj * docs: vpp: correct what a failed VPP commit leaves behind Two corrections to the pages added earlier in this PR. The partial-commit note claimed that the "set vpp ..." statements are "discarded". They are not. Verified on VyOS 2026.03: after the commit fails, "compare" still shows them staged in the configuration session. [vpp settings] + resource-allocation { + memory { + main-heap-size "6G" + } + } What actually happens is worse than the previous wording suggested and worth stating precisely: the statements are neither applied nor written by "save", because "save" writes the running configuration - which "system_option.py" has already updated with the kernel options while the VPP part was rejected. The session does not survive the reboot, so the VPP statements are lost there rather than at commit time. The isolated-CPU requirement was also described as if it only applied once "cpu-cores" is raised. It applies at the default of "cpu-cores 1" as well: verify_vpp_cpu_cores() rejects the commit whenever fewer CPUs are isolated than requested, and VPP takes its main core from the isolated set. The project's own test_01_vpp_basic relies on this - it never sets "cpu-cores" and still expects "main-core" to be taken from /sys/devices/system/cpu/isolated. Without this, a reader doing a minimal setup would conclude that CPU isolation is optional for them. Claude-Session: https://claude.ai/code/session_016gXeKHVBq2N8qRAMQkrdM6 (cherry picked from commit 93f84b050c90cb2d21d5216fc9d54fbcd118f407) 2026-09-04T09:12:35+00:00 Viacheslav Hletenko v.gletenko@vyos.io 2026-09-04T09:12:35+00:00 urn:sha1:7cb5b936588f24a2169dfa121ee83b0f55119907 docs: add Google Cloud HA VPN BGP example (backport #2139) 2026-09-04T08:59:25+00:00 Jeleel Muibi jeleel-muibi@users.noreply.github.com 2026-07-09T19:27:52+00:00 urn:sha1:e29537eaec541b1a898b4c6c59b970d665c23e91 (cherry picked from commit 7662f4c3684fbc684228e0bda2ef4594f49a0e9a) 2026-09-04T08:59:25+00:00 Jeleel Muibi jeleel-muibi@users.noreply.github.com 2026-07-09T19:25:14+00:00 urn:sha1:9077903dba7244e61f592eac6ba1e00224047c6f (cherry picked from commit 6c3f55ab592927fdbe67739b33707eac02d2f57e) 2026-09-04T08:59:24+00:00 Jeleel Muibi jeleel-muibi@users.noreply.github.com 2026-07-09T19:21:55+00:00 urn:sha1:15223ed5dbc700f4f5ea70ee56f22432ab5c7c85 (cherry picked from commit 367585ea4de297f375c30424b78dd9dedab09874) 2026-09-04T08:59:24+00:00 Jeleel Muibi jeleel-muibi@users.noreply.github.com 2026-07-09T19:13:21+00:00 urn:sha1:e4859ad3e1c5251fdfa0805c925c687b085c2ca1 (cherry picked from commit 42b8198e4323c89490df80c0058ad890849172bf) 2026-09-03T09:43:44+00:00 Viacheslav Hletenko v.gletenko@vyos.io 2026-09-03T09:43:44+00:00 urn:sha1:600383ab44ea1e833267e6e626c6bd23fbde0985 kdump: T8868: Add documentation for kernel crash dump feature (backport #2153) 2026-09-01T13:07:05+00:00 Oleksandr Kuchmystyi o.kuchmystyi@vyos.io 2026-07-15T09:12:25+00:00 urn:sha1:13e111893130f44e1da1136a13aadb2e010de5b6 Introduced the kdump section detailing its purpose and functionalities. (cherry picked from commit ba9eb9b336f3664c87761e9000b3ef963cb2ce48) 2026-08-31T13:29:02+00:00 Christian Breunig christian@breunig.cc 2026-08-31T13:29:02+00:00 urn:sha1:551d4ad464e1e8abb1ac796cdb16cd7874c0046e T9265: Update documentation for container image build (backport #2226) 2026-08-31T11:36:42+00:00 Christian Breunig christian@breunig.cc 2026-08-30T13:36:42+00:00 urn:sha1:65c36ea6029652123ceee6d163aede23d1b46560 (cherry picked from commit 9a39835d9096bbdab37c97950ce3010ad2bc1402)