From e7a0bebdb5dc4b436b8b610bcb4f01afc33152e0 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Sun, 10 May 2026 17:27:05 +0300 Subject: chore: remove RST swap mechanism, archive rst-*.rst under docs/_rst_legacy/ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The swap mechanism (RST-as-fallback for migrated MD pages) is dormant — docs/_rst_overrides.txt has been empty since the MyST flip trio landed. The mechanism's surface area is dead weight and the rst-*.rst shadows scattered across the source tree cause Context7's parser to misclassify the project as RST. Sibling PRs: - yuriy/remove-rst-swap-mechanism (rolling) - yuriy/remove-rst-swap-mechanism-circinus Changes: - Move 210 rst-*.rst shadow files into docs/_rst_legacy/ preserving subdirectory structure. They remain in the repo for reference; Sphinx excludes the folder via exclude_patterns. - Strip swap_sources.py invocation from docs/Makefile. - Strip rst-*.rst exclude entry and the _md_exclude.txt loader from docs/conf.py; replace with a single _rst_legacy exclude. - Delete scripts/swap_sources.py, tests/test_swap_sources.py, docs/_rst_overrides.txt. - Update AGENTS.md: drop the "RST override mechanism" section and the test-runner snippet for the deleted test. Note: .readthedocs.yml on sagitta has no jobs: block to remove (the swap was wired only at build-time via the Makefile chain on this branch). Verified: sphinx-build -b html with --keep-going produces identical warning set (409 unique — pre-existing cli.rst/aws.rst title-level warnings on this branch), identical sitemap entry count (215), identical llms.txt entry count (23), zero rst-* URLs in any artifact. 🤖 Generated by [robots](https://vyos.io) --- docs/configuration/container/rst-index.rst | 322 ----- docs/configuration/firewall/rst-bridge.rst | 401 ------ docs/configuration/firewall/rst-flowtables.rst | 189 --- docs/configuration/firewall/rst-global-options.rst | 147 --- docs/configuration/firewall/rst-groups.rst | 429 ------ docs/configuration/firewall/rst-index.rst | 180 --- docs/configuration/firewall/rst-ipv4.rst | 1237 ----------------- docs/configuration/firewall/rst-ipv6.rst | 1233 ----------------- docs/configuration/firewall/rst-zone.rst | 163 --- docs/configuration/highavailability/rst-index.rst | 481 ------- docs/configuration/interfaces/rst-bonding.rst | 645 --------- docs/configuration/interfaces/rst-bridge.rst | 339 ----- docs/configuration/interfaces/rst-dummy.rst | 84 -- docs/configuration/interfaces/rst-ethernet.rst | 305 ----- docs/configuration/interfaces/rst-geneve.rst | 87 -- docs/configuration/interfaces/rst-index.rst | 30 - docs/configuration/interfaces/rst-l2tpv3.rst | 191 --- docs/configuration/interfaces/rst-loopback.rst | 73 - docs/configuration/interfaces/rst-macsec.rst | 285 ---- docs/configuration/interfaces/rst-openvpn.rst | 867 ------------ docs/configuration/interfaces/rst-pppoe.rst | 403 ------ .../interfaces/rst-pseudo-ethernet.rst | 67 - docs/configuration/interfaces/rst-sstp-client.rst | 150 --- docs/configuration/interfaces/rst-tunnel.rst | 286 ---- .../interfaces/rst-virtual-ethernet.rst | 110 -- docs/configuration/interfaces/rst-vti.rst | 40 - docs/configuration/interfaces/rst-vxlan.rst | 349 ----- docs/configuration/interfaces/rst-wireguard.rst | 428 ------ docs/configuration/interfaces/rst-wireless.rst | 618 --------- docs/configuration/interfaces/rst-wwan.rst | 338 ----- docs/configuration/loadbalancing/rst-index.rst | 12 - .../loadbalancing/rst-reverse-proxy.rst | 442 ------- docs/configuration/loadbalancing/rst-wan.rst | 313 ----- docs/configuration/nat/rst-index.rst | 13 - docs/configuration/nat/rst-nat44.rst | 826 ------------ docs/configuration/nat/rst-nat64.rst | 81 -- docs/configuration/nat/rst-nat66.rst | 236 ---- docs/configuration/pki/rst-index.rst | 340 ----- docs/configuration/policy/rst-access-list.rst | 70 - docs/configuration/policy/rst-as-path-list.rst | 33 - docs/configuration/policy/rst-community-list.rst | 35 - docs/configuration/policy/rst-examples.rst | 213 --- .../configuration/policy/rst-extcommunity-list.rst | 40 - docs/configuration/policy/rst-index.rst | 54 - .../policy/rst-large-community-list.rst | 36 - docs/configuration/policy/rst-local-route.rst | 47 - docs/configuration/policy/rst-prefix-list.rst | 96 -- docs/configuration/policy/rst-route-map.rst | 384 ------ docs/configuration/policy/rst-route.rst | 274 ---- docs/configuration/protocols/rst-babel.rst | 210 --- docs/configuration/protocols/rst-bfd.rst | 199 --- docs/configuration/protocols/rst-bgp.rst | 1274 ------------------ docs/configuration/protocols/rst-failover.rst | 114 -- docs/configuration/protocols/rst-igmp-proxy.rst | 77 -- docs/configuration/protocols/rst-index.rst | 22 - docs/configuration/protocols/rst-isis.rst | 547 -------- docs/configuration/protocols/rst-mpls.rst | 259 ---- docs/configuration/protocols/rst-ospf.rst | 1391 -------------------- docs/configuration/protocols/rst-pim.rst | 266 ---- docs/configuration/protocols/rst-pim6.rst | 94 -- docs/configuration/protocols/rst-rip.rst | 257 ---- docs/configuration/protocols/rst-rpki.rst | 211 --- .../protocols/rst-segment-routing.rst | 357 ----- docs/configuration/protocols/rst-static.rst | 242 ---- docs/configuration/rst-index.rst | 24 - docs/configuration/service/rst-broadcast-relay.rst | 66 - docs/configuration/service/rst-config-sync.rst | 114 -- docs/configuration/service/rst-conntrack-sync.rst | 296 ----- docs/configuration/service/rst-console-server.rst | 120 -- docs/configuration/service/rst-dhcp-relay.rst | 205 --- docs/configuration/service/rst-dhcp-server.rst | 831 ------------ docs/configuration/service/rst-dns.rst | 417 ------ docs/configuration/service/rst-eventhandler.rst | 127 -- docs/configuration/service/rst-https.rst | 83 -- docs/configuration/service/rst-ids.rst | 179 --- docs/configuration/service/rst-index.rst | 32 - docs/configuration/service/rst-ipoe-server.rst | 450 ------- docs/configuration/service/rst-lldp.rst | 142 -- docs/configuration/service/rst-mdns.rst | 123 -- docs/configuration/service/rst-monitoring.rst | 149 --- docs/configuration/service/rst-ntp.rst | 114 -- docs/configuration/service/rst-pppoe-server.rst | 684 ---------- docs/configuration/service/rst-router-advert.rst | 128 -- docs/configuration/service/rst-salt-minion.rst | 53 - docs/configuration/service/rst-snmp.rst | 276 ---- docs/configuration/service/rst-ssh.rst | 250 ---- docs/configuration/service/rst-tftp-server.rst | 80 -- docs/configuration/service/rst-webproxy.rst | 445 ------- docs/configuration/system/rst-acceleration.rst | 157 --- docs/configuration/system/rst-conntrack.rst | 187 --- docs/configuration/system/rst-console.rst | 46 - docs/configuration/system/rst-default-route.rst | 40 - docs/configuration/system/rst-flow-accounting.rst | 216 --- docs/configuration/system/rst-frr.rst | 38 - docs/configuration/system/rst-host-name.rst | 68 - docs/configuration/system/rst-index.rst | 35 - docs/configuration/system/rst-ip.rst | 107 -- docs/configuration/system/rst-ipv6.rst | 205 --- docs/configuration/system/rst-lcd.rst | 45 - docs/configuration/system/rst-login.rst | 425 ------ docs/configuration/system/rst-name-server.rst | 74 -- docs/configuration/system/rst-option.rst | 169 --- docs/configuration/system/rst-proxy.rst | 28 - docs/configuration/system/rst-sflow.rst | 61 - docs/configuration/system/rst-sysctl.rst | 12 - docs/configuration/system/rst-syslog.rst | 389 ------ docs/configuration/system/rst-task-scheduler.rst | 40 - docs/configuration/system/rst-time-zone.rst | 18 - docs/configuration/system/rst-updates.rst | 37 - docs/configuration/trafficpolicy/rst-index.rst | 1341 ------------------- docs/configuration/vpn/ipsec/rst-index.rst | 20 - docs/configuration/vpn/ipsec/rst-ipsec_general.rst | 308 ----- .../vpn/ipsec/rst-remoteaccess_ipsec.rst | 183 --- .../vpn/ipsec/rst-site2site_ipsec.rst | 729 ---------- .../vpn/ipsec/rst-troubleshooting_ipsec.rst | 323 ----- docs/configuration/vpn/rst-dmvpn.rst | 335 ----- docs/configuration/vpn/rst-index.rst | 25 - docs/configuration/vpn/rst-l2tp.rst | 578 -------- docs/configuration/vpn/rst-openconnect.rst | 300 ----- docs/configuration/vpn/rst-pptp.rst | 552 -------- docs/configuration/vpn/rst-rsa-keys.rst | 107 -- docs/configuration/vpn/rst-sstp.rst | 657 --------- docs/configuration/vrf/rst-index.rst | 568 -------- 123 files changed, 33353 deletions(-) delete mode 100644 docs/configuration/container/rst-index.rst delete mode 100644 docs/configuration/firewall/rst-bridge.rst delete mode 100644 docs/configuration/firewall/rst-flowtables.rst delete mode 100644 docs/configuration/firewall/rst-global-options.rst delete mode 100644 docs/configuration/firewall/rst-groups.rst delete mode 100644 docs/configuration/firewall/rst-index.rst delete mode 100644 docs/configuration/firewall/rst-ipv4.rst delete mode 100644 docs/configuration/firewall/rst-ipv6.rst delete mode 100644 docs/configuration/firewall/rst-zone.rst delete mode 100644 docs/configuration/highavailability/rst-index.rst delete mode 100644 docs/configuration/interfaces/rst-bonding.rst delete mode 100644 docs/configuration/interfaces/rst-bridge.rst delete mode 100644 docs/configuration/interfaces/rst-dummy.rst delete mode 100644 docs/configuration/interfaces/rst-ethernet.rst delete mode 100644 docs/configuration/interfaces/rst-geneve.rst delete mode 100644 docs/configuration/interfaces/rst-index.rst delete mode 100644 docs/configuration/interfaces/rst-l2tpv3.rst delete mode 100644 docs/configuration/interfaces/rst-loopback.rst delete mode 100644 docs/configuration/interfaces/rst-macsec.rst delete mode 100644 docs/configuration/interfaces/rst-openvpn.rst delete mode 100644 docs/configuration/interfaces/rst-pppoe.rst delete mode 100644 docs/configuration/interfaces/rst-pseudo-ethernet.rst delete mode 100644 docs/configuration/interfaces/rst-sstp-client.rst delete mode 100644 docs/configuration/interfaces/rst-tunnel.rst delete mode 100644 docs/configuration/interfaces/rst-virtual-ethernet.rst delete mode 100644 docs/configuration/interfaces/rst-vti.rst delete mode 100644 docs/configuration/interfaces/rst-vxlan.rst delete mode 100644 docs/configuration/interfaces/rst-wireguard.rst delete mode 100644 docs/configuration/interfaces/rst-wireless.rst delete mode 100644 docs/configuration/interfaces/rst-wwan.rst delete mode 100644 docs/configuration/loadbalancing/rst-index.rst delete mode 100644 docs/configuration/loadbalancing/rst-reverse-proxy.rst delete mode 100644 docs/configuration/loadbalancing/rst-wan.rst delete mode 100644 docs/configuration/nat/rst-index.rst delete mode 100644 docs/configuration/nat/rst-nat44.rst delete mode 100644 docs/configuration/nat/rst-nat64.rst delete mode 100644 docs/configuration/nat/rst-nat66.rst delete mode 100644 docs/configuration/pki/rst-index.rst delete mode 100644 docs/configuration/policy/rst-access-list.rst delete mode 100644 docs/configuration/policy/rst-as-path-list.rst delete mode 100644 docs/configuration/policy/rst-community-list.rst delete mode 100644 docs/configuration/policy/rst-examples.rst delete mode 100644 docs/configuration/policy/rst-extcommunity-list.rst delete mode 100644 docs/configuration/policy/rst-index.rst delete mode 100644 docs/configuration/policy/rst-large-community-list.rst delete mode 100644 docs/configuration/policy/rst-local-route.rst delete mode 100644 docs/configuration/policy/rst-prefix-list.rst delete mode 100644 docs/configuration/policy/rst-route-map.rst delete mode 100644 docs/configuration/policy/rst-route.rst delete mode 100644 docs/configuration/protocols/rst-babel.rst delete mode 100644 docs/configuration/protocols/rst-bfd.rst delete mode 100644 docs/configuration/protocols/rst-bgp.rst delete mode 100644 docs/configuration/protocols/rst-failover.rst delete mode 100644 docs/configuration/protocols/rst-igmp-proxy.rst delete mode 100644 docs/configuration/protocols/rst-index.rst delete mode 100644 docs/configuration/protocols/rst-isis.rst delete mode 100644 docs/configuration/protocols/rst-mpls.rst delete mode 100644 docs/configuration/protocols/rst-ospf.rst delete mode 100644 docs/configuration/protocols/rst-pim.rst delete mode 100644 docs/configuration/protocols/rst-pim6.rst delete mode 100644 docs/configuration/protocols/rst-rip.rst delete mode 100644 docs/configuration/protocols/rst-rpki.rst delete mode 100644 docs/configuration/protocols/rst-segment-routing.rst delete mode 100644 docs/configuration/protocols/rst-static.rst delete mode 100644 docs/configuration/rst-index.rst delete mode 100644 docs/configuration/service/rst-broadcast-relay.rst delete mode 100644 docs/configuration/service/rst-config-sync.rst delete mode 100644 docs/configuration/service/rst-conntrack-sync.rst delete mode 100644 docs/configuration/service/rst-console-server.rst delete mode 100644 docs/configuration/service/rst-dhcp-relay.rst delete mode 100644 docs/configuration/service/rst-dhcp-server.rst delete mode 100644 docs/configuration/service/rst-dns.rst delete mode 100644 docs/configuration/service/rst-eventhandler.rst delete mode 100644 docs/configuration/service/rst-https.rst delete mode 100644 docs/configuration/service/rst-ids.rst delete mode 100644 docs/configuration/service/rst-index.rst delete mode 100644 docs/configuration/service/rst-ipoe-server.rst delete mode 100644 docs/configuration/service/rst-lldp.rst delete mode 100644 docs/configuration/service/rst-mdns.rst delete mode 100644 docs/configuration/service/rst-monitoring.rst delete mode 100644 docs/configuration/service/rst-ntp.rst delete mode 100644 docs/configuration/service/rst-pppoe-server.rst delete mode 100644 docs/configuration/service/rst-router-advert.rst delete mode 100644 docs/configuration/service/rst-salt-minion.rst delete mode 100644 docs/configuration/service/rst-snmp.rst delete mode 100644 docs/configuration/service/rst-ssh.rst delete mode 100644 docs/configuration/service/rst-tftp-server.rst delete mode 100644 docs/configuration/service/rst-webproxy.rst delete mode 100644 docs/configuration/system/rst-acceleration.rst delete mode 100644 docs/configuration/system/rst-conntrack.rst delete mode 100644 docs/configuration/system/rst-console.rst delete mode 100644 docs/configuration/system/rst-default-route.rst delete mode 100644 docs/configuration/system/rst-flow-accounting.rst delete mode 100644 docs/configuration/system/rst-frr.rst delete mode 100644 docs/configuration/system/rst-host-name.rst delete mode 100644 docs/configuration/system/rst-index.rst delete mode 100644 docs/configuration/system/rst-ip.rst delete mode 100644 docs/configuration/system/rst-ipv6.rst delete mode 100644 docs/configuration/system/rst-lcd.rst delete mode 100644 docs/configuration/system/rst-login.rst delete mode 100644 docs/configuration/system/rst-name-server.rst delete mode 100644 docs/configuration/system/rst-option.rst delete mode 100644 docs/configuration/system/rst-proxy.rst delete mode 100644 docs/configuration/system/rst-sflow.rst delete mode 100644 docs/configuration/system/rst-sysctl.rst delete mode 100644 docs/configuration/system/rst-syslog.rst delete mode 100644 docs/configuration/system/rst-task-scheduler.rst delete mode 100644 docs/configuration/system/rst-time-zone.rst delete mode 100644 docs/configuration/system/rst-updates.rst delete mode 100644 docs/configuration/trafficpolicy/rst-index.rst delete mode 100644 docs/configuration/vpn/ipsec/rst-index.rst delete mode 100644 docs/configuration/vpn/ipsec/rst-ipsec_general.rst delete mode 100644 docs/configuration/vpn/ipsec/rst-remoteaccess_ipsec.rst delete mode 100644 docs/configuration/vpn/ipsec/rst-site2site_ipsec.rst delete mode 100644 docs/configuration/vpn/ipsec/rst-troubleshooting_ipsec.rst delete mode 100644 docs/configuration/vpn/rst-dmvpn.rst delete mode 100644 docs/configuration/vpn/rst-index.rst delete mode 100644 docs/configuration/vpn/rst-l2tp.rst delete mode 100644 docs/configuration/vpn/rst-openconnect.rst delete mode 100644 docs/configuration/vpn/rst-pptp.rst delete mode 100644 docs/configuration/vpn/rst-rsa-keys.rst delete mode 100644 docs/configuration/vpn/rst-sstp.rst delete mode 100644 docs/configuration/vrf/rst-index.rst (limited to 'docs/configuration') diff --git a/docs/configuration/container/rst-index.rst b/docs/configuration/container/rst-index.rst deleted file mode 100644 index 69e599a4..00000000 --- a/docs/configuration/container/rst-index.rst +++ /dev/null @@ -1,322 +0,0 @@ -:lastproofread: 2022-06-10 - -######### -Container -######### - -The VyOS container implementation is based on `Podman` as -a deamonless container engine. - -************* -Configuration -************* - -.. cfgcmd:: set container name image - - Sets the image name in the hub registry - - .. code-block:: none - - set container name mysql-server image mysql:8.0 - - If a registry is not specified, Docker.io will be used as the container - registry unless an alternative registry is specified using - **set container registry ** or the registry is included - in the image name - - .. code-block:: none - - set container name mysql-server image quay.io/mysql:8.0 - -.. cfgcmd:: set container name entrypoint - - Override the default entrypoint from the image for a container. - -.. cfgcmd:: set container name command - - Override the default command from the image for a container. - -.. cfgcmd:: set container name arguments - - Set the command arguments for a container. - -.. cfgcmd:: set container name host-name - - Set the host name for a container. - -.. cfgcmd:: set container name allow-host-pid - - The container and the host share the same process namespace. - This means that processes running on the host are visible inside the - container, and processes inside the container are visible on the host. - - The command translates to "--pid host" when the container is created. - -.. cfgcmd:: set container name allow-host-networks - - Allow host networking in a container. The network stack of the container is - not isolated from the host and will use the host IP. - - The command translates to "--net host" when the container is created. - - .. note:: **allow-host-networks** cannot be used with **network** - -.. cfgcmd:: set container name network - - Attaches user-defined network to a container. - Only one network must be specified and must already exist. - -.. cfgcmd:: set container name network address
- - Optionally set a specific static IPv4 or IPv6 address for the container. - This address must be within the named network prefix. - - .. note:: The first IP in the container network is reserved by the - engine and cannot be used - -.. cfgcmd:: set container name description - - Set a container description - -.. cfgcmd:: set container name environment value - - Add custom environment variables. - Multiple environment variables are allowed. - The following commands translate to "-e key=value" when the container - is created. - - .. code-block:: none - - set container name mysql-server environment MYSQL_DATABASE value 'zabbix' - set container name mysql-server environment MYSQL_USER value 'zabbix' - set container name mysql-server environment MYSQL_PASSWORD value 'zabbix_pwd' - set container name mysql-server environment MYSQL_ROOT_PASSWORD value 'root_pwd' - -.. cfgcmd:: set container name port source -.. cfgcmd:: set container name port destination -.. cfgcmd:: set container name port protocol - - Publish a port for the container. - - .. code-block:: none - - set container name zabbix-web-nginx-mysql port http source 80 - set container name zabbix-web-nginx-mysql port http destination 8080 - set container name zabbix-web-nginx-mysql port http protocol tcp - -.. cfgcmd:: set container name volume source -.. cfgcmd:: set container name volume destination - - Mount a volume into the container - - .. code-block:: none - - set container name coredns volume 'corefile' source /config/coredns/Corefile - set container name coredns volume 'corefile' destination /etc/Corefile - -.. cfgcmd:: set container name volume mode - - Volume is either mounted as rw (read-write - default) or ro (read-only) - -.. cfgcmd:: set container name uid -.. cfgcmd:: set container name gid - - Set the User ID or Group ID of the container - -.. cfgcmd:: set container name restart [no | on-failure | always] - - Set the restart behavior of the container. - - - **no**: Do not restart containers on exit - - **on-failure**: Restart containers when they exit with a non-zero - exit code, retrying indefinitely (default) - - **always**: Restart containers when they exit, regardless of status, - retrying indefinitely - -.. cfgcmd:: set container name cpu-quota - - This specifies the number of CPU resources the container can use. - - Default is 0 for unlimited. - For example, 1.25 limits the container to use up to 1.25 cores - worth of CPU time. - This can be a decimal number with up to three decimal places. - - The command translates to "--cpus=" when the container is created. - -.. cfgcmd:: set container name memory - - Constrain the memory available to the container. - - Default is 512 MB. Use 0 MB for unlimited memory. - -.. cfgcmd:: set container name device source -.. cfgcmd:: set container name device destination - - Add a host device to the container. - -.. cfgcmd:: set container name capability - - Set container capabilities or permissions. - - - **net-admin**: Network operations (interface, firewall, routing tables) - - **net-bind-service**: Bind a socket to privileged ports - (port numbers less than 1024) - - **net-raw**: Permission to create raw network sockets - - **setpcap**: Capability sets (from bounded or inherited set) - - **sys-admin**: Administration operations (quotactl, mount, sethostname, - setdomainame) - - **sys-time**: Permission to set system clock - -.. cfgcmd:: set container name sysctl parameter value - - Set container sysctl values. - - The subset of possible parameters are: - - - Kernel Parameters: kernel.msgmax, kernel.msgmnb, kernel.msgmni, kernel.sem, - kernel.shmall, kernel.shmmax, kernel.shmmni, kernel.shm_rmid_forced - - Parameters beginning with fs.mqueue.* - - Parameters beginning with net.* (only if user-defined network is used) - -.. cfgcmd:: set container name label