summaryrefslogtreecommitdiff
path: root/docs/configexamples
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-05 23:21:35 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 16:18:03 +0300
commitd72e213cc7c2dd0099f305cda4a6ba527b27d1da (patch)
tree783b5f504e1a8d367148f2c140a403dc35cb6868 /docs/configexamples
parent80c5ca4aebb666932f681d2be0e7712e22d97f47 (diff)
downloadvyos-documentation-d72e213cc7c2dd0099f305cda4a6ba527b27d1da.tar.gz
vyos-documentation-d72e213cc7c2dd0099f305cda4a6ba527b27d1da.zip
docs: fix typos and a few grammar issues (ported from #1852 RST → MyST)
Ports the typo/grammar sweep originally captured in PR #1852 from .rst files to their .md equivalents, plus the eventhandler grammar fix that Copilot flagged in #1852's review (which the RST PR explicitly skipped as scope-stretch). Sources: - 73 typo/grammar substitutions from PR #1852 (rebased from #1801) - "Using environments is more preferable" → "Using environment variables is preferable" (Copilot review comment on #1852) #1852 itself is being discarded since it targets RST and we are phasing out the RST tree in favor of MyST. The 4 RST-linter line-wrap comments and 1 RST section-underline comment from Copilot's #1852 review are RST-specific and do not apply to .md. 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/configexamples')
-rw-r--r--docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.log14
-rw-r--r--docs/configexamples/md-fwall-and-bridge.md16
-rw-r--r--docs/configexamples/md-inter-vrf-routing-vrf-lite.md6
3 files changed, 18 insertions, 18 deletions
diff --git a/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.log b/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.log
index 6361d21c..a2f52ecd 100644
--- a/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.log
+++ b/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.log
@@ -373,7 +373,7 @@ See the timeout setting options in the Network Debug and Troubleshooting Guide.
2023-05-11 14:39:54,941 p=69617 u=rob n=ansible | [WARNING]: To ensure idempotency and correct diff the input configuration lines should be similar to how they appear if present in the running configuration on device including the indentation
2023-05-11 14:39:54,943 p=69617 u=rob n=ansible | changed: [ovpn-server]
-2023-05-11 14:39:54,954 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : generate openvpn client conifg] *************************************************************************************************************************************************************************
+2023-05-11 14:39:54,954 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : generate openvpn client config] *************************************************************************************************************************************************************************
2023-05-11 14:39:54,977 p=69617 u=rob n=ansible | skipping: [eveng]
2023-05-11 14:39:54,985 p=69617 u=rob n=ansible | skipping: [vyos-oobm]
2023-05-11 14:39:54,996 p=69617 u=rob n=ansible | skipping: [client]
@@ -503,7 +503,7 @@ deprecation_warnings=False in ansible.cfg.
2023-05-11 14:47:17,013 p=69617 u=rob n=ansible | skipping: [ldap-server]
2023-05-11 14:47:17,017 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: wait after stop] *********************************************************************************************************************************************************************
2023-05-11 14:47:17,029 p=69617 u=rob n=ansible | Pausing for 5 seconds
-2023-05-11 14:47:17,030 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2023-05-11 14:47:17,030 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
2023-05-11 14:47:22,045 p=69617 u=rob n=ansible | ok: [eveng]
2023-05-11 14:47:22,057 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: start nodes id] **********************************************************************************************************************************************************************
2023-05-11 14:47:22,092 p=69617 u=rob n=ansible | skipping: [eveng]
@@ -513,11 +513,11 @@ deprecation_warnings=False in ansible.cfg.
2023-05-11 14:47:22,112 p=69617 u=rob n=ansible | skipping: [ldap-server]
2023-05-11 14:47:22,116 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: wait after start] ********************************************************************************************************************************************************************
2023-05-11 14:47:22,130 p=69617 u=rob n=ansible | Pausing for 5 seconds
-2023-05-11 14:47:22,130 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2023-05-11 14:47:22,130 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
2023-05-11 14:47:27,153 p=69617 u=rob n=ansible | ok: [eveng]
2023-05-11 14:47:27,161 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: wait, b/c the ping often failed without a short break] *******************************************************************************************************************************
2023-05-11 14:47:27,181 p=69617 u=rob n=ansible | Pausing for 30 seconds
-2023-05-11 14:47:27,182 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2023-05-11 14:47:27,182 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
2023-05-11 14:47:57,152 p=69617 u=rob n=ansible | ok: [eveng]
2023-05-11 14:47:57,160 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: do ping test] ************************************************************************************************************************************************************************
2023-05-11 14:47:57,198 p=69617 u=rob n=ansible | skipping: [eveng]
@@ -598,7 +598,7 @@ See the timeout setting options in the Network Debug and Troubleshooting Guide.
2023-05-11 14:50:16,773 p=69617 u=rob n=ansible | skipping: [ldap-server]
2023-05-11 14:50:16,777 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: wait after stop] *********************************************************************************************************************************************************************
2023-05-11 14:50:16,791 p=69617 u=rob n=ansible | Pausing for 5 seconds
-2023-05-11 14:50:16,791 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2023-05-11 14:50:16,791 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
2023-05-11 14:50:21,807 p=69617 u=rob n=ansible | ok: [eveng]
2023-05-11 14:50:21,821 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: start nodes id] **********************************************************************************************************************************************************************
2023-05-11 14:50:21,858 p=69617 u=rob n=ansible | skipping: [eveng]
@@ -608,11 +608,11 @@ See the timeout setting options in the Network Debug and Troubleshooting Guide.
2023-05-11 14:50:21,878 p=69617 u=rob n=ansible | skipping: [ldap-server]
2023-05-11 14:50:21,882 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: wait after start] ********************************************************************************************************************************************************************
2023-05-11 14:50:21,896 p=69617 u=rob n=ansible | Pausing for 5 seconds
-2023-05-11 14:50:21,896 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2023-05-11 14:50:21,896 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
2023-05-11 14:50:26,904 p=69617 u=rob n=ansible | ok: [eveng]
2023-05-11 14:50:26,915 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: wait, b/c the ping often failed without a short break] *******************************************************************************************************************************
2023-05-11 14:50:26,933 p=69617 u=rob n=ansible | Pausing for 30 seconds
-2023-05-11 14:50:26,934 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
+2023-05-11 14:50:26,934 p=69617 u=rob n=ansible | (ctrl+C then 'C' = continue early, ctrl+C then 'A' = abort)
2023-05-11 14:50:56,945 p=69617 u=rob n=ansible | ok: [eveng]
2023-05-11 14:50:56,962 p=69617 u=rob n=ansible | TASK [eve-ng-lab-test : OpenVPN_with_LDAP: do ping test] ************************************************************************************************************************************************************************
2023-05-11 14:50:56,998 p=69617 u=rob n=ansible | skipping: [eveng]
diff --git a/docs/configexamples/md-fwall-and-bridge.md b/docs/configexamples/md-fwall-and-bridge.md
index d6602592..5f64c47b 100644
--- a/docs/configexamples/md-fwall-and-bridge.md
+++ b/docs/configexamples/md-fwall-and-bridge.md
@@ -41,7 +41,7 @@ own requirements.
First, we need to configure the interfaces and bridges:
```none
-# Brige br0
+# Bridge br0
set interfaces bridge br0 description 'Isolated L2 bridge'
set interfaces bridge br0 member interface eth1
set interfaces bridge br0 member interface eth2
@@ -133,7 +133,7 @@ And then create the custom rulesets:
set firewall bridge name br0-pre rule 10 description 'Accept IPv6 traffic'
set firewall bridge name br0-pre rule 10 action 'accept'
set firewall bridge name br0-pre rule 10 ethernet-type 'ipv6'
- # And drop everything else
+ # And drop everythingg else
set firewall bridge name br0-pre default-action 'drop'
### br1 - br1-pre
@@ -149,7 +149,7 @@ set firewall bridge name br1-pre rule 10 log
set firewall bridge name br1-pre rule 20 description 'Drop IPv6 traffic'
set firewall bridge name br1-pre rule 20 action 'drop'
set firewall bridge name br1-pre rule 20 ethernet-type 'ipv6'
- # Accept everything else so it can be parsed later
+ # Accept everythingg else so it can be parsed later
set firewall bridge name br1-pre default-action 'accept'
### br2 - br2-pre
@@ -157,7 +157,7 @@ set firewall bridge name br1-pre default-action 'accept'
set firewall bridge name br2-pre rule 10 description 'Drop IPv6 traffic'
set firewall bridge name br2-pre rule 10 action 'drop'
set firewall bridge name br2-pre rule 10 ethernet-type 'ipv6'
- # Accept everything else so it can be parsed later
+ # Accept everythingg else so it can be parsed later
set firewall bridge name br2-pre default-action 'accept'
```
@@ -199,7 +199,7 @@ And the content of the custom rulesets:
```none
### br0 - br0-fwd
- # Accept everything that wasn't dropped in prerouting
+ # Accept everythingg that wasn't dropped in prerouting
set firewall bridge name br0-fwd default-action 'accept'
### br1 - br1-fwd
@@ -212,7 +212,7 @@ set firewall bridge name br1-fwd rule 20 description 'Accept ipv4 from host'
set firewall bridge name br1-fwd rule 20 action 'accept'
set firewall bridge name br1-fwd rule 20 source address '10.1.1.102'
set firewall bridge name br1-fwd rule 20 state 'new'
- # Drop everything else within the bridge:
+ # Drop everythingg else within the bridge:
set firewall bridge name br1-fwd default-action 'drop'
### br2 - br2-fwd
@@ -245,7 +245,7 @@ set firewall bridge name br2-fwd rule 30 ethernet-type 'arp'
set firewall bridge name br2-fwd rule 40 description 'Accept ipv4'
set firewall bridge name br2-fwd rule 40 action 'accept'
set firewall bridge name br2-fwd rule 40 ethernet-type 'ipv4'
- # Drop everything else
+ # Drop everythingg else
set firewall bridge name br2-fwd default-action 'drop'
```
@@ -259,7 +259,7 @@ router itself, to other local networks, and to the Internet.
As a reminder, here's a link to the {doc}`firewall documentation
</configuration/firewall/index>`, where you can find more information about
-the packet flow for traffic that comes from bridge layer and should be analized
+the packet flow for traffic that comes from bridge layer and should be analyzed
by the IP firewall.
Access to the router itself is controlled by the base chain `input`, and
diff --git a/docs/configexamples/md-inter-vrf-routing-vrf-lite.md b/docs/configexamples/md-inter-vrf-routing-vrf-lite.md
index 349a6f14..2ac36904 100644
--- a/docs/configexamples/md-inter-vrf-routing-vrf-lite.md
+++ b/docs/configexamples/md-inter-vrf-routing-vrf-lite.md
@@ -122,7 +122,7 @@ in our topology.
set interface eth eth<N> address <IP ADDRESS/CIDR>
# Static default route back to Core
-set procotols static route 0.0.0.0/0 next-hop <CORE IP ADDRESS>
+set protocols static route 0.0.0.0/0 next-hop <CORE IP ADDRESS>
```
@@ -779,7 +779,7 @@ B>* 10.0.0.0/24 [20/0] via 10.1.1.2, eth0 (vrf LAN1), weight 1, 00:45:28
S>* 172.16.0.0/24 [1/0] via 172.16.2.2, eth1, weight 1, 00:45:32
C>* 172.16.2.0/30 is directly connected, eth1, 00:45:39
B>* 192.0.2.0/24 [20/0] via 10.2.2.2, eth3 (vrf Internet), weight 1, 00:45:24
-B>* 192.168.0.0/24 [20/0] via 192.168.3.2, eth2 (vrf Managment), weight 1, 00:45:27
+B>* 192.168.0.0/24 [20/0] via 192.168.3.2, eth2 (vrf Management), weight 1, 00:45:27
B>* 198.51.100.0/24 [20/0] via 10.2.2.2, eth3 (vrf Internet), weight 1, 00:45:24
# show ipv6 route vrf LAN2
@@ -787,7 +787,7 @@ B>* 198.51.100.0/24 [20/0] via 10.2.2.2, eth3 (vrf Internet), weight 1, 00:45:24
C>* 2001:db8::2/127 is directly connected, eth1, 00:46:26
B>* 2001:db8:0:1::/64 [20/0] via 2001:db8::1, eth0 (vrf LAN1), weight 1, 00:46:17
S>* 2001:db8:0:2::/64 [1/0] via 2001:db8::3, eth1, weight 1, 00:46:21
-B>* 2001:db8:0:3::/64 [20/0] via 2001:db8::5, eth2 (vrf Managment), weight 1, 00:46:16
+B>* 2001:db8:0:3::/64 [20/0] via 2001:db8::5, eth2 (vrf Management), weight 1, 00:46:16
B>* 2001:db8:1::/48 [20/0] via fe80::5200:ff:fe02:3, eth3 (vrf Internet), weight 1, 00:46:13
B>* 2001:db8:2::/48 [20/0] via fe80::5200:ff:fe02:3, eth3 (vrf Internet), weight 1, 00:46:13
C>* fe80::/64 is directly connected, eth1, 00:46:27