From 5d6fa52b8985f8068314aba26878a1d7d5cb84e5 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Wed, 6 May 2026 20:42:32 +0300 Subject: feat: flip swap mechanism — MD as primary, RST as override (Phase 1) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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-.md to docs/**/.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/.rst to docs/**/rst-.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 --- docs/configuration/container/index.md | 479 ++++++ docs/configuration/container/index.rst | 417 ------ docs/configuration/container/md-index.md | 479 ------ docs/configuration/container/rst-index.rst | 417 ++++++ docs/configuration/firewall/bridge.md | 685 +++++++++ docs/configuration/firewall/bridge.rst | 573 ------- docs/configuration/firewall/flowtables.md | 176 +++ docs/configuration/firewall/flowtables.rst | 188 --- docs/configuration/firewall/global-options.md | 186 +++ docs/configuration/firewall/global-options.rst | 182 --- docs/configuration/firewall/groups.md | 477 ++++++ docs/configuration/firewall/groups.rst | 457 ------ docs/configuration/firewall/index.md | 278 ++++ docs/configuration/firewall/index.rst | 267 ---- docs/configuration/firewall/ipv4.md | 1517 +++++++++++++++++++ docs/configuration/firewall/ipv4.rst | 1305 ---------------- docs/configuration/firewall/ipv6.md | 1567 ++++++++++++++++++++ docs/configuration/firewall/ipv6.rst | 1302 ---------------- docs/configuration/firewall/md-bridge.md | 685 --------- docs/configuration/firewall/md-flowtables.md | 176 --- docs/configuration/firewall/md-global-options.md | 186 --- docs/configuration/firewall/md-groups.md | 477 ------ docs/configuration/firewall/md-index.md | 278 ---- docs/configuration/firewall/md-ipv4.md | 1517 ------------------- docs/configuration/firewall/md-ipv6.md | 1567 -------------------- docs/configuration/firewall/md-zone.md | 201 --- docs/configuration/firewall/rst-bridge.rst | 573 +++++++ docs/configuration/firewall/rst-flowtables.rst | 188 +++ docs/configuration/firewall/rst-global-options.rst | 182 +++ docs/configuration/firewall/rst-groups.rst | 457 ++++++ docs/configuration/firewall/rst-index.rst | 267 ++++ docs/configuration/firewall/rst-ipv4.rst | 1305 ++++++++++++++++ docs/configuration/firewall/rst-ipv6.rst | 1302 ++++++++++++++++ docs/configuration/firewall/rst-zone.rst | 205 +++ docs/configuration/firewall/zone.md | 201 +++ docs/configuration/firewall/zone.rst | 205 --- docs/configuration/highavailability/index.md | 561 +++++++ docs/configuration/highavailability/index.rst | 545 ------- docs/configuration/highavailability/md-index.md | 561 ------- docs/configuration/highavailability/rst-index.rst | 545 +++++++ docs/configuration/index.md | 23 + docs/configuration/index.rst | 24 - docs/configuration/interfaces/bonding.md | 764 ++++++++++ docs/configuration/interfaces/bonding.rst | 767 ---------- docs/configuration/interfaces/bridge.md | 431 ++++++ docs/configuration/interfaces/bridge.rst | 424 ------ docs/configuration/interfaces/dummy.md | 87 ++ docs/configuration/interfaces/dummy.rst | 87 -- docs/configuration/interfaces/ethernet.md | 515 +++++++ docs/configuration/interfaces/ethernet.rst | 468 ------ docs/configuration/interfaces/geneve.md | 105 ++ docs/configuration/interfaces/geneve.rst | 100 -- docs/configuration/interfaces/index.md | 26 + docs/configuration/interfaces/index.rst | 28 - docs/configuration/interfaces/l2tpv3.md | 170 +++ docs/configuration/interfaces/l2tpv3.rst | 167 --- docs/configuration/interfaces/loopback.md | 67 + docs/configuration/interfaces/loopback.rst | 65 - docs/configuration/interfaces/macsec.md | 319 ++++ docs/configuration/interfaces/macsec.rst | 322 ---- docs/configuration/interfaces/md-bonding.md | 764 ---------- docs/configuration/interfaces/md-bridge.md | 431 ------ docs/configuration/interfaces/md-dummy.md | 87 -- docs/configuration/interfaces/md-ethernet.md | 515 ------- docs/configuration/interfaces/md-geneve.md | 105 -- docs/configuration/interfaces/md-index.md | 26 - docs/configuration/interfaces/md-l2tpv3.md | 170 --- docs/configuration/interfaces/md-loopback.md | 67 - docs/configuration/interfaces/md-macsec.md | 319 ---- .../interfaces/md-openvpn-examples.md | 769 ---------- docs/configuration/interfaces/md-openvpn.md | 614 -------- docs/configuration/interfaces/md-pppoe.md | 419 ------ .../configuration/interfaces/md-pseudo-ethernet.md | 52 - docs/configuration/interfaces/md-sstp-client.md | 170 --- docs/configuration/interfaces/md-tunnel.md | 309 ---- .../interfaces/md-virtual-ethernet.md | 119 -- docs/configuration/interfaces/md-vti.md | 121 -- docs/configuration/interfaces/md-vxlan.md | 373 ----- docs/configuration/interfaces/md-wireguard.md | 434 ------ docs/configuration/interfaces/md-wireless.md | 923 ------------ docs/configuration/interfaces/md-wwan.md | 355 ----- docs/configuration/interfaces/openvpn-examples.md | 769 ++++++++++ docs/configuration/interfaces/openvpn-examples.rst | 929 ------------ docs/configuration/interfaces/openvpn.md | 614 ++++++++ docs/configuration/interfaces/openvpn.rst | 521 ------- docs/configuration/interfaces/pppoe.md | 419 ++++++ docs/configuration/interfaces/pppoe.rst | 391 ----- docs/configuration/interfaces/pseudo-ethernet.md | 52 + docs/configuration/interfaces/pseudo-ethernet.rst | 54 - docs/configuration/interfaces/rst-bonding.rst | 767 ++++++++++ docs/configuration/interfaces/rst-bridge.rst | 424 ++++++ docs/configuration/interfaces/rst-dummy.rst | 87 ++ docs/configuration/interfaces/rst-ethernet.rst | 468 ++++++ docs/configuration/interfaces/rst-geneve.rst | 100 ++ docs/configuration/interfaces/rst-index.rst | 28 + docs/configuration/interfaces/rst-l2tpv3.rst | 167 +++ docs/configuration/interfaces/rst-loopback.rst | 65 + docs/configuration/interfaces/rst-macsec.rst | 322 ++++ .../interfaces/rst-openvpn-examples.rst | 929 ++++++++++++ docs/configuration/interfaces/rst-openvpn.rst | 521 +++++++ docs/configuration/interfaces/rst-pppoe.rst | 391 +++++ .../interfaces/rst-pseudo-ethernet.rst | 54 + docs/configuration/interfaces/rst-sstp-client.rst | 158 ++ docs/configuration/interfaces/rst-tunnel.rst | 308 ++++ .../interfaces/rst-virtual-ethernet.rst | 117 ++ docs/configuration/interfaces/rst-vti.rst | 115 ++ docs/configuration/interfaces/rst-vxlan.rst | 358 +++++ docs/configuration/interfaces/rst-wireguard.rst | 439 ++++++ docs/configuration/interfaces/rst-wireless.rst | 931 ++++++++++++ docs/configuration/interfaces/rst-wwan.rst | 342 +++++ docs/configuration/interfaces/sstp-client.md | 170 +++ docs/configuration/interfaces/sstp-client.rst | 158 -- docs/configuration/interfaces/tunnel.md | 309 ++++ docs/configuration/interfaces/tunnel.rst | 308 ---- docs/configuration/interfaces/virtual-ethernet.md | 119 ++ docs/configuration/interfaces/virtual-ethernet.rst | 117 -- docs/configuration/interfaces/vti.md | 121 ++ docs/configuration/interfaces/vti.rst | 115 -- docs/configuration/interfaces/vxlan.md | 373 +++++ docs/configuration/interfaces/vxlan.rst | 358 ----- docs/configuration/interfaces/wireguard.md | 434 ++++++ docs/configuration/interfaces/wireguard.rst | 439 ------ docs/configuration/interfaces/wireless.md | 923 ++++++++++++ docs/configuration/interfaces/wireless.rst | 931 ------------ docs/configuration/interfaces/wwan.md | 355 +++++ docs/configuration/interfaces/wwan.rst | 342 ----- docs/configuration/loadbalancing/haproxy.md | 510 +++++++ docs/configuration/loadbalancing/haproxy.rst | 509 ------- docs/configuration/loadbalancing/index.md | 15 + docs/configuration/loadbalancing/index.rst | 14 - docs/configuration/loadbalancing/md-haproxy.md | 510 ------- docs/configuration/loadbalancing/md-index.md | 15 - docs/configuration/loadbalancing/md-wan.md | 306 ---- docs/configuration/loadbalancing/rst-haproxy.rst | 509 +++++++ docs/configuration/loadbalancing/rst-index.rst | 14 + docs/configuration/loadbalancing/rst-wan.rst | 315 ++++ docs/configuration/loadbalancing/wan.md | 306 ++++ docs/configuration/loadbalancing/wan.rst | 315 ---- docs/configuration/md-index.md | 23 - docs/configuration/nat/cgnat.md | 200 +++ docs/configuration/nat/cgnat.rst | 196 --- docs/configuration/nat/index.md | 13 + docs/configuration/nat/index.rst | 14 - docs/configuration/nat/md-cgnat.md | 200 --- docs/configuration/nat/md-index.md | 13 - docs/configuration/nat/md-nat44.md | 788 ---------- docs/configuration/nat/md-nat64.md | 73 - docs/configuration/nat/md-nat66.md | 243 --- docs/configuration/nat/nat44.md | 788 ++++++++++ docs/configuration/nat/nat44.rst | 826 ----------- docs/configuration/nat/nat64.md | 73 + docs/configuration/nat/nat64.rst | 85 -- docs/configuration/nat/nat66.md | 243 +++ docs/configuration/nat/nat66.rst | 256 ---- docs/configuration/nat/rst-cgnat.rst | 196 +++ docs/configuration/nat/rst-index.rst | 14 + docs/configuration/nat/rst-nat44.rst | 826 +++++++++++ docs/configuration/nat/rst-nat64.rst | 85 ++ docs/configuration/nat/rst-nat66.rst | 256 ++++ docs/configuration/pki/index.md | 583 ++++++++ docs/configuration/pki/index.rst | 488 ------ docs/configuration/pki/md-index.md | 583 -------- docs/configuration/pki/rst-index.rst | 488 ++++++ docs/configuration/policy/access-list.md | 70 + docs/configuration/policy/access-list.rst | 70 - docs/configuration/policy/as-path-list.md | 29 + docs/configuration/policy/as-path-list.rst | 33 - docs/configuration/policy/community-list.md | 29 + docs/configuration/policy/community-list.rst | 35 - docs/configuration/policy/examples.md | 205 +++ docs/configuration/policy/examples.rst | 213 --- docs/configuration/policy/extcommunity-list.md | 33 + docs/configuration/policy/extcommunity-list.rst | 40 - docs/configuration/policy/index.md | 53 + docs/configuration/policy/index.rst | 54 - docs/configuration/policy/large-community-list.md | 29 + docs/configuration/policy/large-community-list.rst | 36 - docs/configuration/policy/local-route.md | 100 ++ docs/configuration/policy/local-route.rst | 87 -- docs/configuration/policy/md-access-list.md | 70 - docs/configuration/policy/md-as-path-list.md | 29 - docs/configuration/policy/md-community-list.md | 29 - docs/configuration/policy/md-examples.md | 205 --- docs/configuration/policy/md-extcommunity-list.md | 33 - docs/configuration/policy/md-index.md | 53 - .../policy/md-large-community-list.md | 29 - docs/configuration/policy/md-local-route.md | 100 -- docs/configuration/policy/md-prefix-list.md | 152 -- docs/configuration/policy/md-route-map.md | 439 ------ docs/configuration/policy/md-route.md | 424 ------ docs/configuration/policy/prefix-list.md | 152 ++ docs/configuration/policy/prefix-list.rst | 112 -- docs/configuration/policy/route-map.md | 439 ++++++ docs/configuration/policy/route-map.rst | 383 ----- docs/configuration/policy/route.md | 424 ++++++ docs/configuration/policy/route.rst | 306 ---- 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 | 87 ++ docs/configuration/policy/rst-prefix-list.rst | 112 ++ docs/configuration/policy/rst-route-map.rst | 383 +++++ docs/configuration/policy/rst-route.rst | 306 ++++ docs/configuration/protocols/arp.md | 72 + docs/configuration/protocols/arp.rst | 64 - docs/configuration/protocols/babel.md | 296 ++++ docs/configuration/protocols/babel.rst | 278 ---- docs/configuration/protocols/bfd.md | 205 +++ docs/configuration/protocols/bfd.rst | 199 --- docs/configuration/protocols/bgp.md | 1414 ++++++++++++++++++ docs/configuration/protocols/bgp.rst | 1281 ---------------- docs/configuration/protocols/failover.md | 237 +++ docs/configuration/protocols/failover.rst | 224 --- docs/configuration/protocols/igmp-proxy.md | 79 + docs/configuration/protocols/igmp-proxy.rst | 77 - docs/configuration/protocols/index.md | 25 + docs/configuration/protocols/index.rst | 26 - docs/configuration/protocols/isis.md | 746 ++++++++++ docs/configuration/protocols/isis.rst | 747 ---------- docs/configuration/protocols/md-arp.md | 72 - docs/configuration/protocols/md-babel.md | 296 ---- docs/configuration/protocols/md-bfd.md | 205 --- docs/configuration/protocols/md-bgp.md | 1414 ------------------ docs/configuration/protocols/md-failover.md | 237 --- docs/configuration/protocols/md-igmp-proxy.md | 79 - docs/configuration/protocols/md-index.md | 25 - docs/configuration/protocols/md-isis.md | 746 ---------- docs/configuration/protocols/md-mpls.md | 285 ---- docs/configuration/protocols/md-multicast.md | 31 - docs/configuration/protocols/md-openfabric.md | 242 --- docs/configuration/protocols/md-ospf.md | 1504 ------------------- docs/configuration/protocols/md-pim.md | 282 ---- docs/configuration/protocols/md-pim6.md | 100 -- docs/configuration/protocols/md-rip.md | 294 ---- docs/configuration/protocols/md-rpki.md | 210 --- docs/configuration/protocols/md-segment-routing.md | 359 ----- docs/configuration/protocols/md-static.md | 298 ---- .../protocols/md-traffic-engineering.md | 54 - docs/configuration/protocols/mpls.md | 285 ++++ docs/configuration/protocols/mpls.rst | 259 ---- docs/configuration/protocols/multicast.md | 31 + docs/configuration/protocols/multicast.rst | 34 - docs/configuration/protocols/openfabric.md | 242 +++ docs/configuration/protocols/openfabric.rst | 237 --- docs/configuration/protocols/ospf.md | 1504 +++++++++++++++++++ docs/configuration/protocols/ospf.rst | 1386 ----------------- docs/configuration/protocols/pim.md | 282 ++++ docs/configuration/protocols/pim.rst | 281 ---- docs/configuration/protocols/pim6.md | 100 ++ docs/configuration/protocols/pim6.rst | 94 -- docs/configuration/protocols/rip.md | 294 ++++ docs/configuration/protocols/rip.rst | 257 ---- docs/configuration/protocols/rpki.md | 210 +++ docs/configuration/protocols/rpki.rst | 211 --- docs/configuration/protocols/rst-arp.rst | 64 + docs/configuration/protocols/rst-babel.rst | 278 ++++ docs/configuration/protocols/rst-bfd.rst | 199 +++ docs/configuration/protocols/rst-bgp.rst | 1281 ++++++++++++++++ docs/configuration/protocols/rst-failover.rst | 224 +++ docs/configuration/protocols/rst-igmp-proxy.rst | 77 + docs/configuration/protocols/rst-index.rst | 26 + docs/configuration/protocols/rst-isis.rst | 747 ++++++++++ docs/configuration/protocols/rst-mpls.rst | 259 ++++ docs/configuration/protocols/rst-multicast.rst | 34 + docs/configuration/protocols/rst-openfabric.rst | 237 +++ docs/configuration/protocols/rst-ospf.rst | 1386 +++++++++++++++++ docs/configuration/protocols/rst-pim.rst | 281 ++++ 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 | 301 ++++ .../protocols/rst-traffic-engineering.rst | 51 + docs/configuration/protocols/segment-routing.md | 359 +++++ docs/configuration/protocols/segment-routing.rst | 357 ----- docs/configuration/protocols/static.md | 298 ++++ docs/configuration/protocols/static.rst | 301 ---- .../configuration/protocols/traffic-engineering.md | 54 + .../protocols/traffic-engineering.rst | 51 - docs/configuration/rst-index.rst | 24 + docs/configuration/service/broadcast-relay.md | 70 + docs/configuration/service/broadcast-relay.rst | 66 - docs/configuration/service/config-sync.md | 164 ++ docs/configuration/service/config-sync.rst | 160 -- docs/configuration/service/conntrack-sync.md | 321 ++++ docs/configuration/service/conntrack-sync.rst | 302 ---- docs/configuration/service/console-server.md | 139 ++ docs/configuration/service/console-server.rst | 120 -- docs/configuration/service/dhcp-relay.md | 205 +++ docs/configuration/service/dhcp-relay.rst | 205 --- docs/configuration/service/dhcp-server.md | 1178 +++++++++++++++ docs/configuration/service/dhcp-server.rst | 1087 -------------- docs/configuration/service/dns.md | 582 ++++++++ docs/configuration/service/dns.rst | 511 ------- docs/configuration/service/eventhandler.md | 129 ++ docs/configuration/service/eventhandler.rst | 159 -- docs/configuration/service/https.md | 138 ++ docs/configuration/service/https.rst | 124 -- docs/configuration/service/index.md | 29 + docs/configuration/service/index.rst | 31 - docs/configuration/service/ipoe-server.md | 512 +++++++ docs/configuration/service/ipoe-server.rst | 450 ------ docs/configuration/service/lldp.md | 154 ++ docs/configuration/service/lldp.rst | 148 -- docs/configuration/service/md-broadcast-relay.md | 70 - docs/configuration/service/md-config-sync.md | 164 -- docs/configuration/service/md-conntrack-sync.md | 321 ---- docs/configuration/service/md-console-server.md | 139 -- docs/configuration/service/md-dhcp-relay.md | 205 --- docs/configuration/service/md-dhcp-server.md | 1178 --------------- docs/configuration/service/md-dns.md | 582 -------- docs/configuration/service/md-eventhandler.md | 129 -- docs/configuration/service/md-https.md | 138 -- docs/configuration/service/md-index.md | 29 - docs/configuration/service/md-ipoe-server.md | 512 ------- docs/configuration/service/md-lldp.md | 154 -- docs/configuration/service/md-mdns.md | 131 -- docs/configuration/service/md-monitoring.md | 334 ----- docs/configuration/service/md-ntp.md | 202 --- docs/configuration/service/md-pppoe-server.md | 753 ---------- docs/configuration/service/md-router-advert.md | 121 -- docs/configuration/service/md-salt-minion.md | 51 - docs/configuration/service/md-snmp.md | 258 ---- docs/configuration/service/md-ssh.md | 366 ----- docs/configuration/service/md-suricata.md | 93 -- docs/configuration/service/md-tftp-server.md | 78 - docs/configuration/service/md-webproxy.md | 459 ------ docs/configuration/service/mdns.md | 131 ++ docs/configuration/service/mdns.rst | 124 -- docs/configuration/service/monitoring.md | 334 +++++ docs/configuration/service/monitoring.rst | 289 ---- docs/configuration/service/ntp.md | 202 +++ docs/configuration/service/ntp.rst | 197 --- docs/configuration/service/pppoe-server.md | 753 ++++++++++ docs/configuration/service/pppoe-server.rst | 685 --------- docs/configuration/service/router-advert.md | 121 ++ docs/configuration/service/router-advert.rst | 130 -- docs/configuration/service/rst-broadcast-relay.rst | 66 + docs/configuration/service/rst-config-sync.rst | 160 ++ docs/configuration/service/rst-conntrack-sync.rst | 302 ++++ docs/configuration/service/rst-console-server.rst | 120 ++ docs/configuration/service/rst-dhcp-relay.rst | 205 +++ docs/configuration/service/rst-dhcp-server.rst | 1087 ++++++++++++++ docs/configuration/service/rst-dns.rst | 511 +++++++ docs/configuration/service/rst-eventhandler.rst | 159 ++ docs/configuration/service/rst-https.rst | 124 ++ docs/configuration/service/rst-index.rst | 31 + docs/configuration/service/rst-ipoe-server.rst | 450 ++++++ docs/configuration/service/rst-lldp.rst | 148 ++ docs/configuration/service/rst-mdns.rst | 124 ++ docs/configuration/service/rst-monitoring.rst | 289 ++++ docs/configuration/service/rst-ntp.rst | 197 +++ docs/configuration/service/rst-pppoe-server.rst | 685 +++++++++ docs/configuration/service/rst-router-advert.rst | 130 ++ docs/configuration/service/rst-salt-minion.rst | 53 + docs/configuration/service/rst-snmp.rst | 276 ++++ docs/configuration/service/rst-ssh.rst | 334 +++++ docs/configuration/service/rst-suricata.rst | 101 ++ docs/configuration/service/rst-tftp-server.rst | 80 + docs/configuration/service/rst-webproxy.rst | 445 ++++++ docs/configuration/service/salt-minion.md | 51 + docs/configuration/service/salt-minion.rst | 53 - docs/configuration/service/snmp.md | 258 ++++ docs/configuration/service/snmp.rst | 276 ---- docs/configuration/service/ssh.md | 366 +++++ docs/configuration/service/ssh.rst | 334 ----- docs/configuration/service/suricata.md | 93 ++ docs/configuration/service/suricata.rst | 101 -- docs/configuration/service/tftp-server.md | 78 + docs/configuration/service/tftp-server.rst | 80 - docs/configuration/service/webproxy.md | 459 ++++++ docs/configuration/service/webproxy.rst | 445 ------ docs/configuration/system/acceleration.md | 158 ++ docs/configuration/system/acceleration.rst | 157 -- docs/configuration/system/conntrack.md | 218 +++ docs/configuration/system/conntrack.rst | 210 --- docs/configuration/system/console.md | 59 + docs/configuration/system/console.rst | 57 - docs/configuration/system/default-route.md | 40 + docs/configuration/system/default-route.rst | 40 - docs/configuration/system/flow-accounting.md | 209 +++ docs/configuration/system/flow-accounting.rst | 203 --- docs/configuration/system/frr.md | 45 + docs/configuration/system/frr.rst | 43 - docs/configuration/system/host-name.md | 70 + docs/configuration/system/host-name.rst | 68 - docs/configuration/system/index.md | 34 + docs/configuration/system/index.rst | 36 - docs/configuration/system/ip.md | 126 ++ docs/configuration/system/ip.rst | 120 -- docs/configuration/system/ipv6.md | 193 +++ docs/configuration/system/ipv6.rst | 178 --- docs/configuration/system/lcd.md | 41 + docs/configuration/system/lcd.rst | 45 - docs/configuration/system/login.md | 604 ++++++++ docs/configuration/system/login.rst | 597 -------- docs/configuration/system/md-acceleration.md | 158 -- docs/configuration/system/md-conntrack.md | 218 --- docs/configuration/system/md-console.md | 59 - docs/configuration/system/md-default-route.md | 40 - docs/configuration/system/md-flow-accounting.md | 209 --- docs/configuration/system/md-frr.md | 45 - docs/configuration/system/md-host-name.md | 70 - docs/configuration/system/md-index.md | 34 - docs/configuration/system/md-ip.md | 126 -- docs/configuration/system/md-ipv6.md | 193 --- docs/configuration/system/md-lcd.md | 41 - docs/configuration/system/md-login.md | 604 -------- docs/configuration/system/md-name-server.md | 65 - docs/configuration/system/md-option.md | 190 --- docs/configuration/system/md-proxy.md | 27 - docs/configuration/system/md-sflow.md | 66 - docs/configuration/system/md-sysctl.md | 16 - docs/configuration/system/md-syslog.md | 450 ------ docs/configuration/system/md-task-scheduler.md | 45 - docs/configuration/system/md-time-zone.md | 17 - docs/configuration/system/md-updates.md | 36 - docs/configuration/system/md-watchdog.md | 212 --- docs/configuration/system/name-server.md | 65 + docs/configuration/system/name-server.rst | 74 - docs/configuration/system/option.md | 190 +++ docs/configuration/system/option.rst | 179 --- docs/configuration/system/proxy.md | 27 + docs/configuration/system/proxy.rst | 28 - docs/configuration/system/rst-acceleration.rst | 157 ++ docs/configuration/system/rst-conntrack.rst | 210 +++ docs/configuration/system/rst-console.rst | 57 + docs/configuration/system/rst-default-route.rst | 40 + docs/configuration/system/rst-flow-accounting.rst | 203 +++ docs/configuration/system/rst-frr.rst | 43 + docs/configuration/system/rst-host-name.rst | 68 + docs/configuration/system/rst-index.rst | 36 + docs/configuration/system/rst-ip.rst | 120 ++ docs/configuration/system/rst-ipv6.rst | 178 +++ docs/configuration/system/rst-lcd.rst | 45 + docs/configuration/system/rst-login.rst | 597 ++++++++ docs/configuration/system/rst-name-server.rst | 74 + docs/configuration/system/rst-option.rst | 179 +++ docs/configuration/system/rst-proxy.rst | 28 + docs/configuration/system/rst-sflow.rst | 65 + docs/configuration/system/rst-sysctl.rst | 16 + docs/configuration/system/rst-syslog.rst | 432 ++++++ docs/configuration/system/rst-task-scheduler.rst | 40 + docs/configuration/system/rst-time-zone.rst | 18 + docs/configuration/system/rst-updates.rst | 39 + docs/configuration/system/rst-watchdog.rst | 208 +++ docs/configuration/system/sflow.md | 66 + docs/configuration/system/sflow.rst | 65 - docs/configuration/system/sysctl.md | 16 + docs/configuration/system/sysctl.rst | 16 - docs/configuration/system/syslog.md | 450 ++++++ docs/configuration/system/syslog.rst | 432 ------ docs/configuration/system/task-scheduler.md | 45 + docs/configuration/system/task-scheduler.rst | 40 - docs/configuration/system/time-zone.md | 17 + docs/configuration/system/time-zone.rst | 18 - docs/configuration/system/updates.md | 36 + docs/configuration/system/updates.rst | 39 - docs/configuration/system/watchdog.md | 212 +++ docs/configuration/system/watchdog.rst | 208 --- docs/configuration/trafficpolicy/index.md | 1299 ++++++++++++++++ docs/configuration/trafficpolicy/index.rst | 1361 ----------------- docs/configuration/trafficpolicy/md-index.md | 1299 ---------------- docs/configuration/trafficpolicy/rst-index.rst | 1361 +++++++++++++++++ docs/configuration/vpn/dmvpn.md | 431 ++++++ docs/configuration/vpn/dmvpn.rst | 436 ------ docs/configuration/vpn/index.md | 14 + docs/configuration/vpn/index.rst | 16 - docs/configuration/vpn/ipsec/index.md | 11 + docs/configuration/vpn/ipsec/index.rst | 15 - docs/configuration/vpn/ipsec/ipsec_general.md | 407 +++++ docs/configuration/vpn/ipsec/ipsec_general.rst | 407 ----- docs/configuration/vpn/ipsec/md-index.md | 11 - docs/configuration/vpn/ipsec/md-ipsec_general.md | 407 ----- .../vpn/ipsec/md-remoteaccess_ipsec.md | 186 --- docs/configuration/vpn/ipsec/md-site2site_ipsec.md | 780 ---------- .../vpn/ipsec/md-troubleshooting_ipsec.md | 313 ---- docs/configuration/vpn/ipsec/remoteaccess_ipsec.md | 186 +++ .../configuration/vpn/ipsec/remoteaccess_ipsec.rst | 187 --- docs/configuration/vpn/ipsec/rst-index.rst | 15 + docs/configuration/vpn/ipsec/rst-ipsec_general.rst | 407 +++++ .../vpn/ipsec/rst-remoteaccess_ipsec.rst | 187 +++ .../vpn/ipsec/rst-site2site_ipsec.rst | 763 ++++++++++ .../vpn/ipsec/rst-troubleshooting_ipsec.rst | 330 +++++ docs/configuration/vpn/ipsec/site2site_ipsec.md | 780 ++++++++++ docs/configuration/vpn/ipsec/site2site_ipsec.rst | 763 ---------- .../vpn/ipsec/troubleshooting_ipsec.md | 313 ++++ .../vpn/ipsec/troubleshooting_ipsec.rst | 330 ----- docs/configuration/vpn/l2tp.md | 624 ++++++++ docs/configuration/vpn/l2tp.rst | 579 -------- docs/configuration/vpn/md-dmvpn.md | 431 ------ docs/configuration/vpn/md-index.md | 14 - docs/configuration/vpn/md-l2tp.md | 624 -------- docs/configuration/vpn/md-openconnect.md | 330 ----- docs/configuration/vpn/md-pptp.md | 594 -------- docs/configuration/vpn/md-rsa-keys.md | 114 -- docs/configuration/vpn/md-sstp.md | 698 --------- docs/configuration/vpn/openconnect.md | 330 +++++ docs/configuration/vpn/openconnect.rst | 374 ----- docs/configuration/vpn/pptp.md | 594 ++++++++ docs/configuration/vpn/pptp.rst | 553 ------- docs/configuration/vpn/rsa-keys.md | 114 ++ docs/configuration/vpn/rsa-keys.rst | 123 -- docs/configuration/vpn/rst-dmvpn.rst | 436 ++++++ docs/configuration/vpn/rst-index.rst | 16 + docs/configuration/vpn/rst-l2tp.rst | 579 ++++++++ docs/configuration/vpn/rst-openconnect.rst | 374 +++++ docs/configuration/vpn/rst-pptp.rst | 553 +++++++ docs/configuration/vpn/rst-rsa-keys.rst | 123 ++ docs/configuration/vpn/rst-sstp.rst | 658 ++++++++ docs/configuration/vpn/sstp.md | 698 +++++++++ docs/configuration/vpn/sstp.rst | 658 -------- docs/configuration/vrf/index.md | 646 ++++++++ docs/configuration/vrf/index.rst | 590 -------- docs/configuration/vrf/md-index.md | 646 -------- docs/configuration/vrf/rst-index.rst | 590 ++++++++ 520 files changed, 78468 insertions(+), 78468 deletions(-) create mode 100644 docs/configuration/container/index.md delete mode 100644 docs/configuration/container/index.rst delete mode 100644 docs/configuration/container/md-index.md create mode 100644 docs/configuration/container/rst-index.rst create mode 100644 docs/configuration/firewall/bridge.md delete mode 100644 docs/configuration/firewall/bridge.rst create mode 100644 docs/configuration/firewall/flowtables.md delete mode 100644 docs/configuration/firewall/flowtables.rst create mode 100644 docs/configuration/firewall/global-options.md delete mode 100644 docs/configuration/firewall/global-options.rst create mode 100644 docs/configuration/firewall/groups.md delete mode 100644 docs/configuration/firewall/groups.rst create mode 100644 docs/configuration/firewall/index.md delete mode 100644 docs/configuration/firewall/index.rst create mode 100644 docs/configuration/firewall/ipv4.md delete mode 100644 docs/configuration/firewall/ipv4.rst create mode 100644 docs/configuration/firewall/ipv6.md delete mode 100644 docs/configuration/firewall/ipv6.rst delete mode 100644 docs/configuration/firewall/md-bridge.md delete mode 100644 docs/configuration/firewall/md-flowtables.md delete mode 100644 docs/configuration/firewall/md-global-options.md delete mode 100644 docs/configuration/firewall/md-groups.md delete mode 100644 docs/configuration/firewall/md-index.md delete mode 100644 docs/configuration/firewall/md-ipv4.md delete mode 100644 docs/configuration/firewall/md-ipv6.md delete mode 100644 docs/configuration/firewall/md-zone.md create mode 100644 docs/configuration/firewall/rst-bridge.rst create mode 100644 docs/configuration/firewall/rst-flowtables.rst create mode 100644 docs/configuration/firewall/rst-global-options.rst create mode 100644 docs/configuration/firewall/rst-groups.rst create mode 100644 docs/configuration/firewall/rst-index.rst create mode 100644 docs/configuration/firewall/rst-ipv4.rst create mode 100644 docs/configuration/firewall/rst-ipv6.rst create mode 100644 docs/configuration/firewall/rst-zone.rst create mode 100644 docs/configuration/firewall/zone.md delete mode 100644 docs/configuration/firewall/zone.rst create mode 100644 docs/configuration/highavailability/index.md delete mode 100644 docs/configuration/highavailability/index.rst delete mode 100644 docs/configuration/highavailability/md-index.md create mode 100644 docs/configuration/highavailability/rst-index.rst create mode 100644 docs/configuration/index.md delete mode 100644 docs/configuration/index.rst create mode 100644 docs/configuration/interfaces/bonding.md delete mode 100644 docs/configuration/interfaces/bonding.rst create mode 100644 docs/configuration/interfaces/bridge.md delete mode 100644 docs/configuration/interfaces/bridge.rst create mode 100644 docs/configuration/interfaces/dummy.md delete mode 100644 docs/configuration/interfaces/dummy.rst create mode 100644 docs/configuration/interfaces/ethernet.md delete mode 100644 docs/configuration/interfaces/ethernet.rst create mode 100644 docs/configuration/interfaces/geneve.md delete mode 100644 docs/configuration/interfaces/geneve.rst create mode 100644 docs/configuration/interfaces/index.md delete mode 100644 docs/configuration/interfaces/index.rst create mode 100644 docs/configuration/interfaces/l2tpv3.md delete mode 100644 docs/configuration/interfaces/l2tpv3.rst create mode 100644 docs/configuration/interfaces/loopback.md delete mode 100644 docs/configuration/interfaces/loopback.rst create mode 100644 docs/configuration/interfaces/macsec.md delete mode 100644 docs/configuration/interfaces/macsec.rst delete mode 100644 docs/configuration/interfaces/md-bonding.md delete mode 100644 docs/configuration/interfaces/md-bridge.md delete mode 100644 docs/configuration/interfaces/md-dummy.md delete mode 100644 docs/configuration/interfaces/md-ethernet.md delete mode 100644 docs/configuration/interfaces/md-geneve.md delete mode 100644 docs/configuration/interfaces/md-index.md delete mode 100644 docs/configuration/interfaces/md-l2tpv3.md delete mode 100644 docs/configuration/interfaces/md-loopback.md delete mode 100644 docs/configuration/interfaces/md-macsec.md delete mode 100644 docs/configuration/interfaces/md-openvpn-examples.md delete mode 100644 docs/configuration/interfaces/md-openvpn.md delete mode 100644 docs/configuration/interfaces/md-pppoe.md delete mode 100644 docs/configuration/interfaces/md-pseudo-ethernet.md delete mode 100644 docs/configuration/interfaces/md-sstp-client.md delete mode 100644 docs/configuration/interfaces/md-tunnel.md delete mode 100644 docs/configuration/interfaces/md-virtual-ethernet.md delete mode 100644 docs/configuration/interfaces/md-vti.md delete mode 100644 docs/configuration/interfaces/md-vxlan.md delete mode 100644 docs/configuration/interfaces/md-wireguard.md delete mode 100644 docs/configuration/interfaces/md-wireless.md delete mode 100644 docs/configuration/interfaces/md-wwan.md create mode 100644 docs/configuration/interfaces/openvpn-examples.md delete mode 100644 docs/configuration/interfaces/openvpn-examples.rst create mode 100644 docs/configuration/interfaces/openvpn.md delete mode 100644 docs/configuration/interfaces/openvpn.rst create mode 100644 docs/configuration/interfaces/pppoe.md delete mode 100644 docs/configuration/interfaces/pppoe.rst create mode 100644 docs/configuration/interfaces/pseudo-ethernet.md delete mode 100644 docs/configuration/interfaces/pseudo-ethernet.rst create mode 100644 docs/configuration/interfaces/rst-bonding.rst create mode 100644 docs/configuration/interfaces/rst-bridge.rst create mode 100644 docs/configuration/interfaces/rst-dummy.rst create mode 100644 docs/configuration/interfaces/rst-ethernet.rst create mode 100644 docs/configuration/interfaces/rst-geneve.rst create mode 100644 docs/configuration/interfaces/rst-index.rst create mode 100644 docs/configuration/interfaces/rst-l2tpv3.rst create mode 100644 docs/configuration/interfaces/rst-loopback.rst create mode 100644 docs/configuration/interfaces/rst-macsec.rst create mode 100644 docs/configuration/interfaces/rst-openvpn-examples.rst create mode 100644 docs/configuration/interfaces/rst-openvpn.rst create mode 100644 docs/configuration/interfaces/rst-pppoe.rst create mode 100644 docs/configuration/interfaces/rst-pseudo-ethernet.rst create mode 100644 docs/configuration/interfaces/rst-sstp-client.rst create mode 100644 docs/configuration/interfaces/rst-tunnel.rst create mode 100644 docs/configuration/interfaces/rst-virtual-ethernet.rst create mode 100644 docs/configuration/interfaces/rst-vti.rst create mode 100644 docs/configuration/interfaces/rst-vxlan.rst create mode 100644 docs/configuration/interfaces/rst-wireguard.rst create mode 100644 docs/configuration/interfaces/rst-wireless.rst create mode 100644 docs/configuration/interfaces/rst-wwan.rst create mode 100644 docs/configuration/interfaces/sstp-client.md delete mode 100644 docs/configuration/interfaces/sstp-client.rst create mode 100644 docs/configuration/interfaces/tunnel.md delete mode 100644 docs/configuration/interfaces/tunnel.rst create mode 100644 docs/configuration/interfaces/virtual-ethernet.md delete mode 100644 docs/configuration/interfaces/virtual-ethernet.rst create mode 100644 docs/configuration/interfaces/vti.md delete mode 100644 docs/configuration/interfaces/vti.rst create mode 100644 docs/configuration/interfaces/vxlan.md delete mode 100644 docs/configuration/interfaces/vxlan.rst create mode 100644 docs/configuration/interfaces/wireguard.md delete mode 100644 docs/configuration/interfaces/wireguard.rst create mode 100644 docs/configuration/interfaces/wireless.md delete mode 100644 docs/configuration/interfaces/wireless.rst create mode 100644 docs/configuration/interfaces/wwan.md delete mode 100644 docs/configuration/interfaces/wwan.rst create mode 100644 docs/configuration/loadbalancing/haproxy.md delete mode 100644 docs/configuration/loadbalancing/haproxy.rst create mode 100644 docs/configuration/loadbalancing/index.md delete mode 100644 docs/configuration/loadbalancing/index.rst delete mode 100644 docs/configuration/loadbalancing/md-haproxy.md delete mode 100644 docs/configuration/loadbalancing/md-index.md delete mode 100644 docs/configuration/loadbalancing/md-wan.md create mode 100644 docs/configuration/loadbalancing/rst-haproxy.rst create mode 100644 docs/configuration/loadbalancing/rst-index.rst create mode 100644 docs/configuration/loadbalancing/rst-wan.rst create mode 100644 docs/configuration/loadbalancing/wan.md delete mode 100644 docs/configuration/loadbalancing/wan.rst delete mode 100644 docs/configuration/md-index.md create mode 100644 docs/configuration/nat/cgnat.md delete mode 100644 docs/configuration/nat/cgnat.rst create mode 100644 docs/configuration/nat/index.md delete mode 100644 docs/configuration/nat/index.rst delete mode 100644 docs/configuration/nat/md-cgnat.md delete mode 100644 docs/configuration/nat/md-index.md delete mode 100644 docs/configuration/nat/md-nat44.md delete mode 100644 docs/configuration/nat/md-nat64.md delete mode 100644 docs/configuration/nat/md-nat66.md create mode 100644 docs/configuration/nat/nat44.md delete mode 100644 docs/configuration/nat/nat44.rst create mode 100644 docs/configuration/nat/nat64.md delete mode 100644 docs/configuration/nat/nat64.rst create mode 100644 docs/configuration/nat/nat66.md delete mode 100644 docs/configuration/nat/nat66.rst create mode 100644 docs/configuration/nat/rst-cgnat.rst create mode 100644 docs/configuration/nat/rst-index.rst create mode 100644 docs/configuration/nat/rst-nat44.rst create mode 100644 docs/configuration/nat/rst-nat64.rst create mode 100644 docs/configuration/nat/rst-nat66.rst create mode 100644 docs/configuration/pki/index.md delete mode 100644 docs/configuration/pki/index.rst delete mode 100644 docs/configuration/pki/md-index.md create mode 100644 docs/configuration/pki/rst-index.rst create mode 100644 docs/configuration/policy/access-list.md delete mode 100644 docs/configuration/policy/access-list.rst create mode 100644 docs/configuration/policy/as-path-list.md delete mode 100644 docs/configuration/policy/as-path-list.rst create mode 100644 docs/configuration/policy/community-list.md delete mode 100644 docs/configuration/policy/community-list.rst create mode 100644 docs/configuration/policy/examples.md delete mode 100644 docs/configuration/policy/examples.rst create mode 100644 docs/configuration/policy/extcommunity-list.md delete mode 100644 docs/configuration/policy/extcommunity-list.rst create mode 100644 docs/configuration/policy/index.md delete mode 100644 docs/configuration/policy/index.rst create mode 100644 docs/configuration/policy/large-community-list.md delete mode 100644 docs/configuration/policy/large-community-list.rst create mode 100644 docs/configuration/policy/local-route.md delete mode 100644 docs/configuration/policy/local-route.rst delete mode 100644 docs/configuration/policy/md-access-list.md delete mode 100644 docs/configuration/policy/md-as-path-list.md delete mode 100644 docs/configuration/policy/md-community-list.md delete mode 100644 docs/configuration/policy/md-examples.md delete mode 100644 docs/configuration/policy/md-extcommunity-list.md delete mode 100644 docs/configuration/policy/md-index.md delete mode 100644 docs/configuration/policy/md-large-community-list.md delete mode 100644 docs/configuration/policy/md-local-route.md delete mode 100644 docs/configuration/policy/md-prefix-list.md delete mode 100644 docs/configuration/policy/md-route-map.md delete mode 100644 docs/configuration/policy/md-route.md create mode 100644 docs/configuration/policy/prefix-list.md delete mode 100644 docs/configuration/policy/prefix-list.rst create mode 100644 docs/configuration/policy/route-map.md delete mode 100644 docs/configuration/policy/route-map.rst create mode 100644 docs/configuration/policy/route.md delete mode 100644 docs/configuration/policy/route.rst create mode 100644 docs/configuration/policy/rst-access-list.rst create mode 100644 docs/configuration/policy/rst-as-path-list.rst create mode 100644 docs/configuration/policy/rst-community-list.rst create mode 100644 docs/configuration/policy/rst-examples.rst create mode 100644 docs/configuration/policy/rst-extcommunity-list.rst create mode 100644 docs/configuration/policy/rst-index.rst create mode 100644 docs/configuration/policy/rst-large-community-list.rst create mode 100644 docs/configuration/policy/rst-local-route.rst create mode 100644 docs/configuration/policy/rst-prefix-list.rst create mode 100644 docs/configuration/policy/rst-route-map.rst create mode 100644 docs/configuration/policy/rst-route.rst create mode 100644 docs/configuration/protocols/arp.md delete mode 100644 docs/configuration/protocols/arp.rst create mode 100644 docs/configuration/protocols/babel.md delete mode 100644 docs/configuration/protocols/babel.rst create mode 100644 docs/configuration/protocols/bfd.md delete mode 100644 docs/configuration/protocols/bfd.rst create mode 100644 docs/configuration/protocols/bgp.md delete mode 100644 docs/configuration/protocols/bgp.rst create mode 100644 docs/configuration/protocols/failover.md delete mode 100644 docs/configuration/protocols/failover.rst create mode 100644 docs/configuration/protocols/igmp-proxy.md delete mode 100644 docs/configuration/protocols/igmp-proxy.rst create mode 100644 docs/configuration/protocols/index.md delete mode 100644 docs/configuration/protocols/index.rst create mode 100644 docs/configuration/protocols/isis.md delete mode 100644 docs/configuration/protocols/isis.rst delete mode 100644 docs/configuration/protocols/md-arp.md delete mode 100644 docs/configuration/protocols/md-babel.md delete mode 100644 docs/configuration/protocols/md-bfd.md delete mode 100644 docs/configuration/protocols/md-bgp.md delete mode 100644 docs/configuration/protocols/md-failover.md delete mode 100644 docs/configuration/protocols/md-igmp-proxy.md delete mode 100644 docs/configuration/protocols/md-index.md delete mode 100644 docs/configuration/protocols/md-isis.md delete mode 100644 docs/configuration/protocols/md-mpls.md delete mode 100644 docs/configuration/protocols/md-multicast.md delete mode 100644 docs/configuration/protocols/md-openfabric.md delete mode 100644 docs/configuration/protocols/md-ospf.md delete mode 100644 docs/configuration/protocols/md-pim.md delete mode 100644 docs/configuration/protocols/md-pim6.md delete mode 100644 docs/configuration/protocols/md-rip.md delete mode 100644 docs/configuration/protocols/md-rpki.md delete mode 100644 docs/configuration/protocols/md-segment-routing.md delete mode 100644 docs/configuration/protocols/md-static.md delete mode 100644 docs/configuration/protocols/md-traffic-engineering.md create mode 100644 docs/configuration/protocols/mpls.md delete mode 100644 docs/configuration/protocols/mpls.rst create mode 100644 docs/configuration/protocols/multicast.md delete mode 100644 docs/configuration/protocols/multicast.rst create mode 100644 docs/configuration/protocols/openfabric.md delete mode 100644 docs/configuration/protocols/openfabric.rst create mode 100644 docs/configuration/protocols/ospf.md delete mode 100644 docs/configuration/protocols/ospf.rst create mode 100644 docs/configuration/protocols/pim.md delete mode 100644 docs/configuration/protocols/pim.rst create mode 100644 docs/configuration/protocols/pim6.md delete mode 100644 docs/configuration/protocols/pim6.rst create mode 100644 docs/configuration/protocols/rip.md delete mode 100644 docs/configuration/protocols/rip.rst create mode 100644 docs/configuration/protocols/rpki.md delete mode 100644 docs/configuration/protocols/rpki.rst create mode 100644 docs/configuration/protocols/rst-arp.rst create mode 100644 docs/configuration/protocols/rst-babel.rst create mode 100644 docs/configuration/protocols/rst-bfd.rst create mode 100644 docs/configuration/protocols/rst-bgp.rst create mode 100644 docs/configuration/protocols/rst-failover.rst create mode 100644 docs/configuration/protocols/rst-igmp-proxy.rst create mode 100644 docs/configuration/protocols/rst-index.rst create mode 100644 docs/configuration/protocols/rst-isis.rst create mode 100644 docs/configuration/protocols/rst-mpls.rst create mode 100644 docs/configuration/protocols/rst-multicast.rst create mode 100644 docs/configuration/protocols/rst-openfabric.rst create mode 100644 docs/configuration/protocols/rst-ospf.rst create mode 100644 docs/configuration/protocols/rst-pim.rst create mode 100644 docs/configuration/protocols/rst-pim6.rst create mode 100644 docs/configuration/protocols/rst-rip.rst create mode 100644 docs/configuration/protocols/rst-rpki.rst create mode 100644 docs/configuration/protocols/rst-segment-routing.rst create mode 100644 docs/configuration/protocols/rst-static.rst create mode 100644 docs/configuration/protocols/rst-traffic-engineering.rst create mode 100644 docs/configuration/protocols/segment-routing.md delete mode 100644 docs/configuration/protocols/segment-routing.rst create mode 100644 docs/configuration/protocols/static.md delete mode 100644 docs/configuration/protocols/static.rst create mode 100644 docs/configuration/protocols/traffic-engineering.md delete mode 100644 docs/configuration/protocols/traffic-engineering.rst create mode 100644 docs/configuration/rst-index.rst create mode 100644 docs/configuration/service/broadcast-relay.md delete mode 100644 docs/configuration/service/broadcast-relay.rst create mode 100644 docs/configuration/service/config-sync.md delete mode 100644 docs/configuration/service/config-sync.rst create mode 100644 docs/configuration/service/conntrack-sync.md delete mode 100644 docs/configuration/service/conntrack-sync.rst create mode 100644 docs/configuration/service/console-server.md delete mode 100644 docs/configuration/service/console-server.rst create mode 100644 docs/configuration/service/dhcp-relay.md delete mode 100644 docs/configuration/service/dhcp-relay.rst create mode 100644 docs/configuration/service/dhcp-server.md delete mode 100644 docs/configuration/service/dhcp-server.rst create mode 100644 docs/configuration/service/dns.md delete mode 100644 docs/configuration/service/dns.rst create mode 100644 docs/configuration/service/eventhandler.md delete mode 100644 docs/configuration/service/eventhandler.rst create mode 100644 docs/configuration/service/https.md delete mode 100644 docs/configuration/service/https.rst create mode 100644 docs/configuration/service/index.md delete mode 100644 docs/configuration/service/index.rst create mode 100644 docs/configuration/service/ipoe-server.md delete mode 100644 docs/configuration/service/ipoe-server.rst create mode 100644 docs/configuration/service/lldp.md delete mode 100644 docs/configuration/service/lldp.rst delete mode 100644 docs/configuration/service/md-broadcast-relay.md delete mode 100644 docs/configuration/service/md-config-sync.md delete mode 100644 docs/configuration/service/md-conntrack-sync.md delete mode 100644 docs/configuration/service/md-console-server.md delete mode 100644 docs/configuration/service/md-dhcp-relay.md delete mode 100644 docs/configuration/service/md-dhcp-server.md delete mode 100644 docs/configuration/service/md-dns.md delete mode 100644 docs/configuration/service/md-eventhandler.md delete mode 100644 docs/configuration/service/md-https.md delete mode 100644 docs/configuration/service/md-index.md delete mode 100644 docs/configuration/service/md-ipoe-server.md delete mode 100644 docs/configuration/service/md-lldp.md delete mode 100644 docs/configuration/service/md-mdns.md delete mode 100644 docs/configuration/service/md-monitoring.md delete mode 100644 docs/configuration/service/md-ntp.md delete mode 100644 docs/configuration/service/md-pppoe-server.md delete mode 100644 docs/configuration/service/md-router-advert.md delete mode 100644 docs/configuration/service/md-salt-minion.md delete mode 100644 docs/configuration/service/md-snmp.md delete mode 100644 docs/configuration/service/md-ssh.md delete mode 100644 docs/configuration/service/md-suricata.md delete mode 100644 docs/configuration/service/md-tftp-server.md delete mode 100644 docs/configuration/service/md-webproxy.md create mode 100644 docs/configuration/service/mdns.md delete mode 100644 docs/configuration/service/mdns.rst create mode 100644 docs/configuration/service/monitoring.md delete mode 100644 docs/configuration/service/monitoring.rst create mode 100644 docs/configuration/service/ntp.md delete mode 100644 docs/configuration/service/ntp.rst create mode 100644 docs/configuration/service/pppoe-server.md delete mode 100644 docs/configuration/service/pppoe-server.rst create mode 100644 docs/configuration/service/router-advert.md delete mode 100644 docs/configuration/service/router-advert.rst create mode 100644 docs/configuration/service/rst-broadcast-relay.rst create mode 100644 docs/configuration/service/rst-config-sync.rst create mode 100644 docs/configuration/service/rst-conntrack-sync.rst create mode 100644 docs/configuration/service/rst-console-server.rst create mode 100644 docs/configuration/service/rst-dhcp-relay.rst create mode 100644 docs/configuration/service/rst-dhcp-server.rst create mode 100644 docs/configuration/service/rst-dns.rst create mode 100644 docs/configuration/service/rst-eventhandler.rst create mode 100644 docs/configuration/service/rst-https.rst create mode 100644 docs/configuration/service/rst-index.rst create mode 100644 docs/configuration/service/rst-ipoe-server.rst create mode 100644 docs/configuration/service/rst-lldp.rst create mode 100644 docs/configuration/service/rst-mdns.rst create mode 100644 docs/configuration/service/rst-monitoring.rst create mode 100644 docs/configuration/service/rst-ntp.rst create mode 100644 docs/configuration/service/rst-pppoe-server.rst create mode 100644 docs/configuration/service/rst-router-advert.rst create mode 100644 docs/configuration/service/rst-salt-minion.rst create mode 100644 docs/configuration/service/rst-snmp.rst create mode 100644 docs/configuration/service/rst-ssh.rst create mode 100644 docs/configuration/service/rst-suricata.rst create mode 100644 docs/configuration/service/rst-tftp-server.rst create mode 100644 docs/configuration/service/rst-webproxy.rst create mode 100644 docs/configuration/service/salt-minion.md delete mode 100644 docs/configuration/service/salt-minion.rst create mode 100644 docs/configuration/service/snmp.md delete mode 100644 docs/configuration/service/snmp.rst create mode 100644 docs/configuration/service/ssh.md delete mode 100644 docs/configuration/service/ssh.rst create mode 100644 docs/configuration/service/suricata.md delete mode 100644 docs/configuration/service/suricata.rst create mode 100644 docs/configuration/service/tftp-server.md delete mode 100644 docs/configuration/service/tftp-server.rst create mode 100644 docs/configuration/service/webproxy.md delete mode 100644 docs/configuration/service/webproxy.rst create mode 100644 docs/configuration/system/acceleration.md delete mode 100644 docs/configuration/system/acceleration.rst create mode 100644 docs/configuration/system/conntrack.md delete mode 100644 docs/configuration/system/conntrack.rst create mode 100644 docs/configuration/system/console.md delete mode 100644 docs/configuration/system/console.rst create mode 100644 docs/configuration/system/default-route.md delete mode 100644 docs/configuration/system/default-route.rst create mode 100644 docs/configuration/system/flow-accounting.md delete mode 100644 docs/configuration/system/flow-accounting.rst create mode 100644 docs/configuration/system/frr.md delete mode 100644 docs/configuration/system/frr.rst create mode 100644 docs/configuration/system/host-name.md delete mode 100644 docs/configuration/system/host-name.rst create mode 100644 docs/configuration/system/index.md delete mode 100644 docs/configuration/system/index.rst create mode 100644 docs/configuration/system/ip.md delete mode 100644 docs/configuration/system/ip.rst create mode 100644 docs/configuration/system/ipv6.md delete mode 100644 docs/configuration/system/ipv6.rst create mode 100644 docs/configuration/system/lcd.md delete mode 100644 docs/configuration/system/lcd.rst create mode 100644 docs/configuration/system/login.md delete mode 100644 docs/configuration/system/login.rst delete mode 100644 docs/configuration/system/md-acceleration.md delete mode 100644 docs/configuration/system/md-conntrack.md delete mode 100644 docs/configuration/system/md-console.md delete mode 100644 docs/configuration/system/md-default-route.md delete mode 100644 docs/configuration/system/md-flow-accounting.md delete mode 100644 docs/configuration/system/md-frr.md delete mode 100644 docs/configuration/system/md-host-name.md delete mode 100644 docs/configuration/system/md-index.md delete mode 100644 docs/configuration/system/md-ip.md delete mode 100644 docs/configuration/system/md-ipv6.md delete mode 100644 docs/configuration/system/md-lcd.md delete mode 100644 docs/configuration/system/md-login.md delete mode 100644 docs/configuration/system/md-name-server.md delete mode 100644 docs/configuration/system/md-option.md delete mode 100644 docs/configuration/system/md-proxy.md delete mode 100644 docs/configuration/system/md-sflow.md delete mode 100644 docs/configuration/system/md-sysctl.md delete mode 100644 docs/configuration/system/md-syslog.md delete mode 100644 docs/configuration/system/md-task-scheduler.md delete mode 100644 docs/configuration/system/md-time-zone.md delete mode 100644 docs/configuration/system/md-updates.md delete mode 100644 docs/configuration/system/md-watchdog.md create mode 100644 docs/configuration/system/name-server.md delete mode 100644 docs/configuration/system/name-server.rst create mode 100644 docs/configuration/system/option.md delete mode 100644 docs/configuration/system/option.rst create mode 100644 docs/configuration/system/proxy.md delete mode 100644 docs/configuration/system/proxy.rst create mode 100644 docs/configuration/system/rst-acceleration.rst create mode 100644 docs/configuration/system/rst-conntrack.rst create mode 100644 docs/configuration/system/rst-console.rst create mode 100644 docs/configuration/system/rst-default-route.rst create mode 100644 docs/configuration/system/rst-flow-accounting.rst create mode 100644 docs/configuration/system/rst-frr.rst create mode 100644 docs/configuration/system/rst-host-name.rst create mode 100644 docs/configuration/system/rst-index.rst create mode 100644 docs/configuration/system/rst-ip.rst create mode 100644 docs/configuration/system/rst-ipv6.rst create mode 100644 docs/configuration/system/rst-lcd.rst create mode 100644 docs/configuration/system/rst-login.rst create mode 100644 docs/configuration/system/rst-name-server.rst create mode 100644 docs/configuration/system/rst-option.rst create mode 100644 docs/configuration/system/rst-proxy.rst create mode 100644 docs/configuration/system/rst-sflow.rst create mode 100644 docs/configuration/system/rst-sysctl.rst create mode 100644 docs/configuration/system/rst-syslog.rst create mode 100644 docs/configuration/system/rst-task-scheduler.rst create mode 100644 docs/configuration/system/rst-time-zone.rst create mode 100644 docs/configuration/system/rst-updates.rst create mode 100644 docs/configuration/system/rst-watchdog.rst create mode 100644 docs/configuration/system/sflow.md delete mode 100644 docs/configuration/system/sflow.rst create mode 100644 docs/configuration/system/sysctl.md delete mode 100644 docs/configuration/system/sysctl.rst create mode 100644 docs/configuration/system/syslog.md delete mode 100644 docs/configuration/system/syslog.rst create mode 100644 docs/configuration/system/task-scheduler.md delete mode 100644 docs/configuration/system/task-scheduler.rst create mode 100644 docs/configuration/system/time-zone.md delete mode 100644 docs/configuration/system/time-zone.rst create mode 100644 docs/configuration/system/updates.md delete mode 100644 docs/configuration/system/updates.rst create mode 100644 docs/configuration/system/watchdog.md delete mode 100644 docs/configuration/system/watchdog.rst create mode 100644 docs/configuration/trafficpolicy/index.md delete mode 100644 docs/configuration/trafficpolicy/index.rst delete mode 100644 docs/configuration/trafficpolicy/md-index.md create mode 100644 docs/configuration/trafficpolicy/rst-index.rst create mode 100644 docs/configuration/vpn/dmvpn.md delete mode 100644 docs/configuration/vpn/dmvpn.rst create mode 100644 docs/configuration/vpn/index.md delete mode 100644 docs/configuration/vpn/index.rst create mode 100644 docs/configuration/vpn/ipsec/index.md delete mode 100644 docs/configuration/vpn/ipsec/index.rst create mode 100644 docs/configuration/vpn/ipsec/ipsec_general.md delete mode 100644 docs/configuration/vpn/ipsec/ipsec_general.rst delete mode 100644 docs/configuration/vpn/ipsec/md-index.md delete mode 100644 docs/configuration/vpn/ipsec/md-ipsec_general.md delete mode 100644 docs/configuration/vpn/ipsec/md-remoteaccess_ipsec.md delete mode 100644 docs/configuration/vpn/ipsec/md-site2site_ipsec.md delete mode 100644 docs/configuration/vpn/ipsec/md-troubleshooting_ipsec.md create mode 100644 docs/configuration/vpn/ipsec/remoteaccess_ipsec.md delete mode 100644 docs/configuration/vpn/ipsec/remoteaccess_ipsec.rst create mode 100644 docs/configuration/vpn/ipsec/rst-index.rst create mode 100644 docs/configuration/vpn/ipsec/rst-ipsec_general.rst create mode 100644 docs/configuration/vpn/ipsec/rst-remoteaccess_ipsec.rst create mode 100644 docs/configuration/vpn/ipsec/rst-site2site_ipsec.rst create mode 100644 docs/configuration/vpn/ipsec/rst-troubleshooting_ipsec.rst create mode 100644 docs/configuration/vpn/ipsec/site2site_ipsec.md delete mode 100644 docs/configuration/vpn/ipsec/site2site_ipsec.rst create mode 100644 docs/configuration/vpn/ipsec/troubleshooting_ipsec.md delete mode 100644 docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst create mode 100644 docs/configuration/vpn/l2tp.md delete mode 100644 docs/configuration/vpn/l2tp.rst delete mode 100644 docs/configuration/vpn/md-dmvpn.md delete mode 100644 docs/configuration/vpn/md-index.md delete mode 100644 docs/configuration/vpn/md-l2tp.md delete mode 100644 docs/configuration/vpn/md-openconnect.md delete mode 100644 docs/configuration/vpn/md-pptp.md delete mode 100644 docs/configuration/vpn/md-rsa-keys.md delete mode 100644 docs/configuration/vpn/md-sstp.md create mode 100644 docs/configuration/vpn/openconnect.md delete mode 100644 docs/configuration/vpn/openconnect.rst create mode 100644 docs/configuration/vpn/pptp.md delete mode 100644 docs/configuration/vpn/pptp.rst create mode 100644 docs/configuration/vpn/rsa-keys.md delete mode 100644 docs/configuration/vpn/rsa-keys.rst create mode 100644 docs/configuration/vpn/rst-dmvpn.rst create mode 100644 docs/configuration/vpn/rst-index.rst create mode 100644 docs/configuration/vpn/rst-l2tp.rst create mode 100644 docs/configuration/vpn/rst-openconnect.rst create mode 100644 docs/configuration/vpn/rst-pptp.rst create mode 100644 docs/configuration/vpn/rst-rsa-keys.rst create mode 100644 docs/configuration/vpn/rst-sstp.rst create mode 100644 docs/configuration/vpn/sstp.md delete mode 100644 docs/configuration/vpn/sstp.rst create mode 100644 docs/configuration/vrf/index.md delete mode 100644 docs/configuration/vrf/index.rst delete mode 100644 docs/configuration/vrf/md-index.md create mode 100644 docs/configuration/vrf/rst-index.rst (limited to 'docs/configuration') diff --git a/docs/configuration/container/index.md b/docs/configuration/container/index.md new file mode 100644 index 00000000..db46db38 --- /dev/null +++ b/docs/configuration/container/index.md @@ -0,0 +1,479 @@ +--- +lastproofread: '2024-07-03' +--- + +# Container + +The VyOS container implementation is based on [Podman](https://podman.io/) as +a daemonless 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 \ name-server \ + +Optionally set a custom name server. +If a container network is used with DNS enabled, +this setting will not have any effect. +``` + + +```{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 +::: +``` +:::{note} +Port publishing cannot be used with **network**. For this purpose, a workaround +using destination NAT and static IP assignment for the container is available. +::: +```{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 \ tmpfs \ destination \ + +Mount a tmpfs *(ramdisk)* filesystem to the given path within the container. +``` + +```{cfgcmd} set container name \ tmpfs \ size \ + +Size in MB for tmpfs filesystem, maximum size is 64GB or 50% of the +systems total available memory. +``` + +```{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 \ value \ + +Add metadata label for this container. +``` + +```{cfgcmd} set container name \ disable + +Disable a container. +``` + +### Container Health checks + + +By default, no health checks are run, even when defined by the image. + +```{cfgcmd} set container name \ health-check + +Default health check is run for the container if defined by the image. +``` + +```{cfgcmd} set container name \ health-check command \ + +Override the default health check command from the image for a container. +``` + +```{cfgcmd} set container name \ health-check interval \ + +Override the default health-check interval. For example: `60` +``` + +```{cfgcmd} set container name \ health-check timeout \ + +Override the default health-check timeout. For example: `10` +``` + +```{cfgcmd} set container name \ health-check retries \ + +Number of health check retries before container is considered unhealthy. For example: `1` +``` + +### Container Networks + +```{cfgcmd} set container network \ + +Creates a named container network +``` + +```{cfgcmd} set container network \ description + +A brief description what this network is all about. +``` + +```{cfgcmd} set container network \ prefix \ + +Define IPv4 and/or IPv6 prefix for a given network name. +Both IPv4 and IPv6 can be used in parallel. +``` + +```{cfgcmd} set container network \ mtu \ + +Configure {abbr}`MTU (Maximum Transmission Unit)` for a given network. It +is the size (in bytes) of the largest ethernet frame sent on this link. +``` + +```{cfgcmd} set container network \ no-name-server + +Disable Domain Name System (DNS) plugin for this network. +``` + +```{cfgcmd} set container network \ vrf \ + +Bind container network to a given VRF instance. +``` + +### Container Registry + +```{cfgcmd} set container registry \ + +Adds registry to list of unqualified-search-registries. By default, for any +image that does not include the registry in the image name, VyOS will use +docker.io and quay.io as the container registry. +``` + +```{cfgcmd} set container registry \ disable + +Disable a given container registry +``` + +```{cfgcmd} set container registry \ authentication username +``` + +```{cfgcmd} set container registry \ authentication password + +Some container registries require credentials to be used. + +Credentials can be defined here and will only be used when adding a +container image to the system. +``` + +```{cfgcmd} set container registry \ insecure + +Allow registry access over unencrypted HTTP or TLS connections with +untrusted certificates. +``` + +```{cfgcmd} set container registry \ mirror address \ +``` + +```{cfgcmd} set container registry \ mirror host-name \ +``` + +```{cfgcmd} set container registry \ mirror port \ +``` + +```{cfgcmd} set container registry \ mirror path \ + +Registry mirror, use ``(host-name|address)[:port][/path]``. + +If you have mirror http://192.168.1.1:8080 for docker.io, you can use ``docker.io/some/repo`` or run ``podman pull docker.io/some/repo`` + +:::{code-block} none +set container registry docker.io mirror address 192.168.1.1 +set container registry docker.io mirror port 8080 +set container registry docker.io insecure +::: +If http://192.168.1.1:8080 is your own registry, you can use ``192.168.1.1:8080/some/repo`` or run ``podman pull 192.168.1.1:8080/some/repo`` + +:::{code-block} none +set container registry 192.168.1.1:8080 insecure +::: +``` + +### Log Configuration + +```{cfgcmd} set container name \ log-driver [k8s-file | journald | none] + +Set the default log driver for containers. + +- **k8s-file**: Log to a plain text file in Kubernetes-style format. +- **journald**: Log to the system journal +- **none**: Disable logging for the container + +Current default is journald. + +``` + +## Operation Commands + +```{opcmd} add container image \ + +Pull a new image for container +``` +```{opcmd} show container + +Show the list of all active containers. +``` +```{opcmd} show container image + +Show the local container images. +``` +```{opcmd} show container log \ + +Show logs from a given container +``` +```{opcmd} show container network + +Show a list available container networks +``` +```{opcmd} restart container \ + +Restart a given container +``` +```{opcmd} update container image \ + +Update container image +``` +```{opcmd} delete container image \ [force] + +Delete a particular container image based on it's image ID. +You can also delete all container images at once. + +You can not delete a container image if it has more then one tag +assigned, this is why there is a `force` option to pass down to +the container image to also remove those images. +``` + +## Example Configuration + +For the sake of demonstration, [example #1 in the official documentation](https://www.zabbix.com/documentation/current/manual/installation/containers) +to the declarative VyOS CLI syntax. + +```none +set container network zabbix prefix 172.20.0.0/16 +set container network zabbix description 'Network for Zabbix component containers' + +set container name mysql-server image mysql:8.0 +set container name mysql-server network zabbix + +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' + +set container name zabbix-java-gateway image zabbix/zabbix-java-gateway:alpine-5.2-latest +set container name zabbix-java-gateway network zabbix + +set container name zabbix-server-mysql image zabbix/zabbix-server-mysql:alpine-5.2-latest +set container name zabbix-server-mysql network zabbix + +set container name zabbix-server-mysql environment 'DB_SERVER_HOST' value 'mysql-server' +set container name zabbix-server-mysql environment 'MYSQL_DATABASE' value 'zabbix' +set container name zabbix-server-mysql environment 'MYSQL_USER' value 'zabbix' +set container name zabbix-server-mysql environment 'MYSQL_PASSWORD' value 'zabbix_pwd' +set container name zabbix-server-mysql environment 'MYSQL_ROOT_PASSWORD' value 'root_pwd' +set container name zabbix-server-mysql environment 'ZBX_JAVAGATEWAY' value 'zabbix-java-gateway' + +set container name zabbix-server-mysql port zabbix source 10051 +set container name zabbix-server-mysql port zabbix destination 10051 + +set container name zabbix-web-nginx-mysql image zabbix/zabbix-web-nginx-mysql:alpine-5.2-latest +set container name zabbix-web-nginx-mysql network zabbix + +set container name zabbix-web-nginx-mysql environment 'MYSQL_DATABASE' value 'zabbix' +set container name zabbix-web-nginx-mysql environment 'ZBX_SERVER_HOST' value 'zabbix-server-mysql' +set container name zabbix-web-nginx-mysql environment 'DB_SERVER_HOST' value 'mysql-server' +set container name zabbix-web-nginx-mysql environment 'MYSQL_USER' value 'zabbix' +set container name zabbix-web-nginx-mysql environment 'MYSQL_PASSWORD' value 'zabbix_pwd' +set container name zabbix-web-nginx-mysql environment 'MYSQL_ROOT_PASSWORD' value 'root_pwd' + +set container name zabbix-web-nginx-mysql port http source 80 +set container name zabbix-web-nginx-mysql port http destination 8080 +``` diff --git a/docs/configuration/container/index.rst b/docs/configuration/container/index.rst deleted file mode 100644 index 398f1941..00000000 --- a/docs/configuration/container/index.rst +++ /dev/null @@ -1,417 +0,0 @@ -:lastproofread: 2024-07-03 - -######### -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 name-server
- - Optionally set a custom name server. - If a container network is used with DNS enabled, - this setting will not have any effect. - -.. 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 - -.. note:: Port publishing cannot be used with **network**. For this purpose, a workaround - using destination NAT and static IP assignment for the container is available. - -.. 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 tmpfs destination - - Mount a tmpfs *(ramdisk)* filesystem to the given path within the container. - -.. cfgcmd:: set container name tmpfs size - - Size in MB for tmpfs filesystem, maximum size is 64GB or 50% of the - systems total available memory. - -.. 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