summaryrefslogtreecommitdiff
path: root/docs/configuration/interfaces
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/interfaces
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/interfaces')
-rw-r--r--docs/configuration/interfaces/openvpn-examples.rst21
-rw-r--r--docs/configuration/interfaces/vti.rst3
2 files changed, 19 insertions, 5 deletions
diff --git a/docs/configuration/interfaces/openvpn-examples.rst b/docs/configuration/interfaces/openvpn-examples.rst
index 46409975..34cabddf 100644
--- a/docs/configuration/interfaces/openvpn-examples.rst
+++ b/docs/configuration/interfaces/openvpn-examples.rst
@@ -2,6 +2,9 @@
Site-to-site
============
+.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd
+ directives for command coverage tracking.
+
OpenVPN is popular for client-server setups, but its site-to-site mode is less
common and often not supported by router appliances. Despite limited support,
it is effective for quickly establishing tunnels between routers.
@@ -29,9 +32,9 @@ In both cases, we will use the following settings:
* The ``persistent-tunnel`` directive allows us to configure tunnel-related
attributes, such as firewall policy, as we would on any standard network
interface.
-* If known, the remote router's IP address can be configured using the
- ``remote-host`` directive. If unknown, it can be omitted. We assume the remote
- router has a dynamic IP address.
+* If known, the remote router's IP address can be configured using
+ the ``remote-host`` directive. If unknown, it can be omitted.
+ We assume the remote router has a dynamic IP address.
.. figure:: /_static/images/openvpn_site2site_diagram.jpg
@@ -87,11 +90,15 @@ You do **not** need to copy the certificate to the other router. Instead,
retrieve its SHA-256 fingerprint. Since OpenVPN currently supports only SHA-256
fingerprints, use the following command:
+.. stop_vyoslinter
+
.. code-block:: none
vyos@vyos# run show pki certificate openvpn-local fingerprint sha256
5C:B8:09:64:8B:59:51:DC:F4:DF:2C:12:5C:B7:03:D1:68:94:D7:5B:62:C2:E1:83:79:F1:F0:68:B2:81:26:79
+.. start_vyoslinter
+
.. note:: Certificate names are arbitrary. While ``openvpn-local`` and
``openvpn-remote`` are used here, you may choose any names.
@@ -456,7 +463,7 @@ Check the tunnel status:
Client CN Remote Host Tunnel IP Local Host TX bytes RX bytes Connected Since
----------- ------------------ ----------- ---------------- ---------- ---------- -------------------
- client1 172.110.12.54:33166 10.23.1.10 172.18.201.10:1194 3.4 KB 3.4 KB 2024-06-11 12:07:25
+ client1 172.16.12.54:33166 10.23.1.10 172.18.201.10:1194 3.4 KB 3.4 KB 2024-06-11 12:07:25
@@ -639,7 +646,11 @@ below:
}
}
-For a detailed example, refer to :doc:`OpenVPN with LDAP</configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP>`.
+.. stop_vyoslinter
+
+For a detailed example, refer to :doc:`OpenVPN with LDAP </configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP>`.
+
+.. start_vyoslinter
Multi-factor authentication
===========================
diff --git a/docs/configuration/interfaces/vti.rst b/docs/configuration/interfaces/vti.rst
index 1704b9d1..9c2dc1eb 100644
--- a/docs/configuration/interfaces/vti.rst
+++ b/docs/configuration/interfaces/vti.rst
@@ -4,6 +4,9 @@
VTI - Virtual Tunnel Interface
##############################
+.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd
+ directives for command coverage tracking.
+
Set Virtual Tunnel Interface
.. code-block:: none