summaryrefslogtreecommitdiff
path: root/docs/configuration/nat
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-03-30 14:11:57 +0300
committerGitHub <noreply@github.com>2026-03-30 12:11:57 +0100
commita01c2c4ed50470141e7d7bbd31a3ab17418e9936 (patch)
treef13f96feb9529593a5080e1a31eb39c6e97332ed /docs/configuration/nat
parentdad139434e34d3bbf24fd46c8fa8ea7a54177d0a (diff)
downloadvyos-documentation-a01c2c4ed50470141e7d7bbd31a3ab17418e9936.tar.gz
vyos-documentation-a01c2c4ed50470141e7d7bbd31a3ab17418e9936.zip
Add TODO markers, fill placeholders, mark stub pages (#1802)
* chore: add TODO markers for 12 files needing cfgcmd/opcmd conversion Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: fill TBD placeholder in flow-accounting, remove TBD in static routes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: add stub admonitions to 3 minimal pages Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: replace non-RFC IP addresses and suppress false positives in linter Replace public IPs with RFC 5737 documentation addresses and add stop/start_vyoslinter markers for false positives (MAC addresses, OIDs, NAT64 well-known prefix). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: replace remaining non-RFC IPs and suppress MAC address false positive - Replace 8.8.8.8 (Google DNS) with 192.0.2.1 (RFC 5737) in: - docs/configexamples/ansible.rst (3 occurrences) - docs/configexamples/nmp.rst (1 occurrence) - docs/automation/terraform/terraformvSphere.rst (1 occurrence) - Wrap SHA-256 certificate fingerprint in openvpn-examples.rst with stop_vyoslinter/start_vyoslinter to suppress false-positive IPv6 flag Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: wrap long lines to comply with 80-char line length limit Wrapped prose content exceeding 80 characters in 9 documentation files. Only RST prose and directive content was modified; code block contents were left untouched as they are exempt from the linter. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: wrap 2 remaining long lines for linter compliance Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: suppress linter for long URL reference in terraformvSphere.rst * fix: address Copilot review suggestions — broken links, typos, YAML indentation - Fix broken inline RST links split across lines in sysctl.rst, eve-ng.rst, oracle.rst (stub notes with VyOS documentation repository link) - Fix YAML indentation in both playbook code blocks in ansible.rst - Fix typo "VyoS" -> "VyOS" in ansible.rst - Fix typo "desition" -> "decision" in terraformvSphere.rst - Fix 4 occurrences of "Terrafom" -> "Terraform" in terraformvSphere.rst - Fix :doc: role split across two lines in openvpn-examples.rst - Wrap long paragraph in openconnect.rst to <=80 chars and remove unnecessary stop/start_vyoslinter markers Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: resolve remaining linter failures — long lines and OID false positive Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: revert 8.8.8.8 replacements, use stop_vyoslinter instead --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Diffstat (limited to 'docs/configuration/nat')
-rw-r--r--docs/configuration/nat/nat64.rst7
-rw-r--r--docs/configuration/nat/nat66.rst8
2 files changed, 13 insertions, 2 deletions
diff --git a/docs/configuration/nat/nat64.rst b/docs/configuration/nat/nat64.rst
index e8a3a0e6..8608da9f 100644
--- a/docs/configuration/nat/nat64.rst
+++ b/docs/configuration/nat/nat64.rst
@@ -4,6 +4,9 @@
NAT64
#####
+.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd
+ directives for command coverage tracking.
+
:abbr:`NAT64 (IPv6-to-IPv4 Prefix Translation)` is a critical component in
modern networking, facilitating communication between IPv6 and IPv4 networks.
This documentation outlines the setup, configuration, and usage of the NAT64
@@ -69,6 +72,8 @@ NAT64 client configuration:
Test from the IPv6 only client:
+.. stop_vyoslinter
+
.. code-block:: none
vyos@r1:~$ ping 64:ff9b::192.0.2.1 count 2
@@ -79,3 +84,5 @@ Test from the IPv6 only client:
--- 64:ff9b::192.0.2.1 ping statistics ---
2 packets transmitted, 2 received, 0% packet loss, time 1023ms
rtt min/avg/max/mdev = 0.351/0.362/0.373/0.011 ms
+
+.. start_vyoslinter
diff --git a/docs/configuration/nat/nat66.rst b/docs/configuration/nat/nat66.rst
index 42f63fc9..d7d8e8be 100644
--- a/docs/configuration/nat/nat66.rst
+++ b/docs/configuration/nat/nat66.rst
@@ -4,6 +4,9 @@
NAT66(NPTv6)
############
+.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd
+ directives for command coverage tracking.
+
:abbr:`NPTv6 (IPv6-to-IPv6 Network Prefix Translation)` is an address
translation technology based on IPv6 networks, used to convert an IPv6
address prefix in an IPv6 message into another IPv6 address prefix.
@@ -151,8 +154,9 @@ R2:
set service router-advert interface br1 prefix ::/0
-Use the following topology to translate internal user local addresses (``fc::/7``)
-to DHCPv6-PD provided prefixes from an ISP connected to a VyOS HA pair.
+Use the following topology to translate internal user local addresses
+(``fc::/7``) to DHCPv6-PD provided prefixes from an ISP connected to
+a VyOS HA pair.
.. figure:: /_static/images/vyos_1_5_nat66_dhcpv6_wdummy.png
:alt: VyOS NAT66 DHCPv6 using a dummy interface