summaryrefslogtreecommitdiff
path: root/docs/configexamples
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-04-21 20:35:22 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-04-21 20:35:22 +0300
commitd0a0fd4998b35af5b4e59374a5706ffeb27c7ee5 (patch)
treebebe87c3f28f8f7bb8aaa2fbdd091749f629f95b /docs/configexamples
parent5d4cdc95200e8ef8fa9ef0f52c5607b76e980692 (diff)
downloadvyos-documentation-d0a0fd4998b35af5b4e59374a5706ffeb27c7ee5.tar.gz
vyos-documentation-d0a0fd4998b35af5b4e59374a5706ffeb27c7ee5.zip
fix: resolve all line-length lint warnings across 14 RST files
Wrap prose lines exceeding 80 chars and apply stop/start_vyoslinter markers around cfgcmd/opcmd directive lines that cannot be shortened (e.g. long option names with placeholder arguments). Affected files: bonding, wireguard, pim, conntrack-sync, dmvpn, ipsec_general, site2site_ipsec, vrf/index, bare-metal, inter-vrf-routing-vrf-lite, lac-lns, tunnelbroker, OpenVPN_with_LDAP, dmvpn-dualhub-dualcloud. 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/configexamples')
-rw-r--r--docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst17
-rw-r--r--docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst14
-rw-r--r--docs/configexamples/dmvpn-dualhub-dualcloud.rst39
-rw-r--r--docs/configexamples/inter-vrf-routing-vrf-lite.rst3
-rw-r--r--docs/configexamples/lac-lns.rst3
5 files changed, 50 insertions, 26 deletions
diff --git a/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst b/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst
index 0ddd7e3e..ae997905 100644
--- a/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst
+++ b/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst
@@ -39,14 +39,22 @@ Here are some PowerShell commands to quickly add a Test Active Directory.
Configure VyOS as OpenVPN Server
====================================
-In this example OpenVPN will be setup with a client certificate and username / password authentication.
+In this example OpenVPN will be setup with a client certificate and
+username / password authentication.
-First a CA, a signed server and client ceftificate and a Diffie-Hellman parameter musst be generated and installed.
-Please look :ref:`here <configuration/pki/index:pki>` for more information.
+First a CA, a signed server and client ceftificate and a
+Diffie-Hellman parameter musst be generated and installed.
+Please look :ref:`here <configuration/pki/index:pki>` for more
+information.
| Add the LDAP plugin configuration file `/config/auth/ldap-auth.config`
+
+.. stop_vyoslinter
+
| Check all possible settings `here <https://github.com/threerings/openvpn-auth-ldap/blob/master/auth-ldap.conf>`_
+.. start_vyoslinter
+
.. literalinclude:: _include/ldap-auth.config
:language: none
@@ -93,7 +101,8 @@ OpenVPN Server configuration can be carried out.
Client configuration
====================
-One advantage of having the client certificate stored is the ability to create the client configuration.
+One advantage of having the client certificate stored is the ability to
+create the client configuration.
.. code-block:: none
diff --git a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
index a14a3199..e34cb779 100644
--- a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
+++ b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
@@ -220,9 +220,11 @@ Please note, 'autonomous-flag' and 'on-link-flag' are enabled by default,
Firewall
========
-Finally, don't forget the :ref:`Firewall<configuration/firewall/index:Firewall>`. The usage is identical, except for
-instead of `set firewall ipv4 name NAME`, you would use `set firewall ipv6 name
-NAME`.
-
-Similarly, to attach the firewall, you would use `set firewall ipv6 name NAME rule N inbound-interface name eth0` or `set firewall zone LOCAL from WAN firewall
-ipv6-name`.
+Finally, don't forget the
+:ref:`Firewall<configuration/firewall/index:Firewall>`. The usage is
+identical, except instead of `set firewall ipv4 name NAME`, you would
+use `set firewall ipv6 name NAME`.
+
+Similarly, to attach the firewall, you would use
+`set firewall ipv6 name NAME rule N inbound-interface name eth0` or
+`set firewall zone LOCAL from WAN firewall ipv6-name`.
diff --git a/docs/configexamples/dmvpn-dualhub-dualcloud.rst b/docs/configexamples/dmvpn-dualhub-dualcloud.rst
index 7bcfcf84..a3a4e619 100644
--- a/docs/configexamples/dmvpn-dualhub-dualcloud.rst
+++ b/docs/configexamples/dmvpn-dualhub-dualcloud.rst
@@ -6,11 +6,12 @@
DMVPN Dual HUB Dual Cloud
#########################
-This document is to describe a basic setup to build DVMPN network with two Hubs and two clouds using DMVPN Phase3.
+This document is to describe a basic setup to build DVMPN network with
+two Hubs and two clouds using DMVPN Phase3.
OSPF is used as routing protocol inside DMVPN.
-In this example we use VyOS 1.5 as HUBs and Spokes (HUB-1, HUB-2, SPOKE-2, SPOKE-3) and Cisco IOSv 15.5(3)M (SPOKE-1)
-as a Spoke.
+In this example we use VyOS 1.5 as HUBs and Spokes (HUB-1, HUB-2,
+SPOKE-2, SPOKE-3) and Cisco IOSv 15.5(3)M (SPOKE-1) as a Spoke.
Network Topology
================
@@ -80,9 +81,12 @@ Spoke-3
NHRP configuration
__________________
-The next step is to configure the NHRP protocol. In a Dual cloud network, every HUB has to be configured with one GRE
-multipoint tunnel interface and every spoke has to be configured with two tunnel interfaces, one tunnel to each hub.
-In this example tunnel networks are 10.100.100.0/24 for the first cloud and 10.100.101.0/24 for the second cloud.
+The next step is to configure the NHRP protocol. In a Dual cloud
+network, every HUB has to be configured with one GRE multipoint tunnel
+interface and every spoke has to be configured with two tunnel
+interfaces, one tunnel to each hub.
+In this example tunnel networks are 10.100.100.0/24 for the first cloud
+and 10.100.101.0/24 for the second cloud.
But VyOS uses FRR for NHRP, that is why the tunnel address mask must be /32.
HUB-1
@@ -211,8 +215,10 @@ Spoke-3
Overlay configuration
_____________________
-The last step is to configure the routing protocol. In this scenario, OSPF was chosen as the dynamic routing protocol.
-But you can use iBGP or eBGP. To form fast convergence it is possible to use BFD protocol.
+The last step is to configure the routing protocol. In this scenario,
+OSPF was chosen as the dynamic routing protocol.
+But you can use iBGP or eBGP. To form fast convergence it is possible
+to use BFD protocol.
HUB-1
@@ -378,7 +384,8 @@ SPOKE-1
Monitoring
==========
-All spokes created IPSec tunnels to Hubs, are registered on Hubs using NHRP protocol and formed adjacency in OSPF.
+All spokes created IPSec tunnels to Hubs, are registered on Hubs using
+NHRP protocol and formed adjacency in OSPF.
.. code-block:: none
@@ -468,7 +475,8 @@ For instance, traceroute was generated from PC-SPOKE-2 to PC-SPOKE-1
3 *192.168.11.2 3.241 ms (ICMP type:3, code:3, Destination port unreachable)
First trace goes via HUB but the second goes directly from SPOKE-1 to SPOKE-2.
-Now routing tables are changed. LAN networks 192.168.12.0/24 and 192.168.11.0/24 available directly via SPOKES.
+Now routing tables are changed. LAN networks 192.168.12.0/24 and
+192.168.11.0/24 available directly via SPOKES.
.. code-block:: none
@@ -541,8 +549,11 @@ A new Spoke to Spoke IPSec tunnel is created
Summary
=======
-If one of the Hubs loses connectivity to the Internet, the other Hub will be available and take the main role.
-This is a simple example where only one internet connection is used. But in the real world, there can be two
-connections to the Internet. In this case, there is a recommendation to build each tunnel via each Internet connection,
-choose the main cloud, and manipulate traffic via a routing protocol. It allows the creation failover on link-level
+If one of the Hubs loses connectivity to the Internet, the other Hub
+will be available and take the main role.
+This is a simple example where only one internet connection is used.
+But in the real world, there can be two connections to the Internet.
+In this case, there is a recommendation to build each tunnel via each
+Internet connection, choose the main cloud, and manipulate traffic via
+a routing protocol. It allows the creation failover on link-level
connections too. \ No newline at end of file
diff --git a/docs/configexamples/inter-vrf-routing-vrf-lite.rst b/docs/configexamples/inter-vrf-routing-vrf-lite.rst
index 36dabd73..1f02da8e 100644
--- a/docs/configexamples/inter-vrf-routing-vrf-lite.rst
+++ b/docs/configexamples/inter-vrf-routing-vrf-lite.rst
@@ -16,7 +16,8 @@ where you might need that some network can access other in a different VRF.
The scope of this document is to cover such cases in a dynamic way without the
use of MPLS-LDP.
-General information about L3VPNs can be found in the :ref:`configuration/vrf/index:L3VPN VRFs` chapter.
+General information about L3VPNs can be found in the
+:ref:`configuration/vrf/index:L3VPN VRFs` chapter.
********
Overview
diff --git a/docs/configexamples/lac-lns.rst b/docs/configexamples/lac-lns.rst
index f622b48f..5f344d54 100644
--- a/docs/configexamples/lac-lns.rst
+++ b/docs/configexamples/lac-lns.rst
@@ -101,7 +101,8 @@ LNS
.. start_vyoslinter
.. note:: This setup requires the Compression Control Protocol (CCP)
- being disabled, the command ``set vpn l2tp remote-access ppp-options disable-ccp``
+ being disabled, the command
+ ``set vpn l2tp remote-access ppp-options disable-ccp``
accomplishes that.
Client