Page MenuHomeVyOS Platform

vyos-api docs: add operational guidance for large configuration applies (batch sizes, geoip cost, body-size limit)
Open, LowPublic

Description

Doc page: https://docs.vyos.io/en/latest/automation/vyos-api.html

The API docs explain the endpoints but give no operational guidance for large applies (initial provisioning, firewall migrations). Things we learned the hard way doing ~450-op firewall applies on VyOS 1.5 rolling (see also the discussion on T7090):

  • Batch sizes: large multi-op /configure batches can overload the config daemon; modest batches with per-op retry are far safer.
  • GeoIP is expensive: source geoip country-code commits take many seconds each (T4299 measured 7–18s back in 2022); batching several geoip ops together is what wedged our router. One geoip/remote-group op per commit is the safe pattern.
  • Background operations: since vyos-1x#4953 (T7090) the REST API supports background configure operations — the docs should point bulk-apply users at them, plus confirm_time/commit-confirm as a safety net.
  • Request body limit: service https request-body-size-limit defaults to 1 MB — a large batched array or config-file load can hit it; worth mentioning next to the endpoint docs.

Suggested doc addition: a short "Bulk configuration over the API" subsection covering these four points.

Details

Version
docs.vyos.io latest (observed on VyOS 1.5 rolling)
Is it a breaking change?
Perfectly compatible
Issue type
Documentation update