diff options
| -rw-r--r-- | docs/_include/interface-ip.txt | 2 | ||||
| -rw-r--r-- | docs/_include/interface-xdp.txt | 6 | ||||
| -rw-r--r-- | docs/configuration/service/snmp.rst | 5 | ||||
| -rw-r--r-- | docs/configuration/service/ssh.rst | 7 | ||||
| -rw-r--r-- | docs/configuration/service/tftp-server.rst | 6 | ||||
| -rw-r--r-- | docs/configuration/system/option.rst | 6 | ||||
| -rw-r--r-- | docs/configuration/vpn/l2tp.rst | 4 | ||||
| -rw-r--r-- | docs/debugging.rst | 11 |
8 files changed, 30 insertions, 17 deletions
diff --git a/docs/_include/interface-ip.txt b/docs/_include/interface-ip.txt index 89937806..abbed529 100644 --- a/docs/_include/interface-ip.txt +++ b/docs/_include/interface-ip.txt @@ -126,7 +126,7 @@ possible to allow these hosts to communicate through the upstream router by proxy_arp'ing. - .. note:: Don't need to be used together with proxy_arp. + .. note:: Does not need to be used together with proxy_arp. This technology is known by different names: diff --git a/docs/_include/interface-xdp.txt b/docs/_include/interface-xdp.txt index d87151fc..e28db88d 100644 --- a/docs/_include/interface-xdp.txt +++ b/docs/_include/interface-xdp.txt @@ -1,6 +1,6 @@ .. cfgcmd:: set interfaces {{ var0 }} <interface> xdp - Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.3 rolling + Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.4 rolling releases. You must enable it for every interface which should participate in the XDP forwarding. @@ -18,10 +18,12 @@ nftables. Enabling this feature will only load the XDP router code as described here: + .. stop_vyoslinter https://blog.apnic.net/2020/04/30/how-to-build-an-xdp-based-bgp-peering-router/ + .. start_vyoslinter Example: .. code-block:: none - set interfaces {{ var0 }} {{ var1 }} xdp
\ No newline at end of file + set interfaces {{ var0 }} {{ var1 }} xdp diff --git a/docs/configuration/service/snmp.rst b/docs/configuration/service/snmp.rst index e962c1c5..4a5a2780 100644 --- a/docs/configuration/service/snmp.rst +++ b/docs/configuration/service/snmp.rst @@ -201,7 +201,8 @@ VyOS MIBs All SNMP MIBs are located in each image of VyOS here: ``/usr/share/snmp/mibs/`` -you are be able to download the files with the a activate ssh service like this +You are be able to download the files using SCP, once the SSH service +has been activated like so .. code-block:: none @@ -270,4 +271,4 @@ following content: .. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2 .. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3 -.. start_vyoslinter
\ No newline at end of file +.. start_vyoslinter diff --git a/docs/configuration/service/ssh.rst b/docs/configuration/service/ssh.rst index 94249766..6b09d40d 100644 --- a/docs/configuration/service/ssh.rst +++ b/docs/configuration/service/ssh.rst @@ -127,8 +127,8 @@ Operation .. opcmd:: generate ssh client-key /path/to/private_key - Re-generated a known pub/private keyfile which can e.g. used to connect to - other services (RPKI cache). + Re-generated a known pub/private keyfile which can be used to connect to + other services (e.g. RPKI cache). Example: @@ -153,5 +153,6 @@ Operation | =.. o=.oo| +----[SHA256]-----+ - Two new files ``/config/auth/id_rsa_rpki`` and ``/config/auth/id_rsa_rpki.pub`` + Two new files ``/config/auth/id_rsa_rpki`` and + ``/config/auth/id_rsa_rpki.pub`` will be created. diff --git a/docs/configuration/service/tftp-server.rst b/docs/configuration/service/tftp-server.rst index 276ce5fb..d220d789 100644 --- a/docs/configuration/service/tftp-server.rst +++ b/docs/configuration/service/tftp-server.rst @@ -32,15 +32,15 @@ on each IP address. .. cfgcmd:: set service tftp-server allow-upload -Optional, if you want to enable uploads, else TFTP server will act as read-only -server. +Optional, if you want to enable uploads, else TFTP server will act as a +read-only server. Example ------- Provide TFTP server listening on both IPv4 and IPv6 addresses ``192.0.2.1`` and ``2001:db8::1`` serving the content from ``/config/tftpboot``. Uploading via -TFTP to this server is not allowed! +TFTP to this server is disabled. The resulting configuration will look like: diff --git a/docs/configuration/system/option.rst b/docs/configuration/system/option.rst index e029ec96..a4e08245 100644 --- a/docs/configuration/system/option.rst +++ b/docs/configuration/system/option.rst @@ -28,8 +28,8 @@ HTTP client .. cfgcmd:: set system option http-client source-address <address> - Several commands utilize curl to initiate transfers. Configure the local - source IPv4/IPv6 address used for all CURL operations. + Several commands utilize cURL to initiate transfers. Configure the local + source IPv4/IPv6 address used for all cURL operations. .. cfgcmd:: set system option http-client source-interface <interface> @@ -54,7 +54,7 @@ the used keyboard layout on the system console. Defaults to ``us``. .. note:: Changing the keymap only has an effect on the system console, using - SSH oder Serial remote access to the device is not affected as the keyboard + SSH or Serial remote access to the device is not affected as the keyboard layout here corresponds to your access system. .. _system_options_performance: diff --git a/docs/configuration/vpn/l2tp.rst b/docs/configuration/vpn/l2tp.rst index d331ce2c..0df5080c 100644 --- a/docs/configuration/vpn/l2tp.rst +++ b/docs/configuration/vpn/l2tp.rst @@ -72,8 +72,8 @@ parameter to the client. .. code-block:: none - set vpn l2tp remote-access dns-servers server-1 '198.51.100.8' - set vpn l2tp remote-access dns-servers server-2 '198.51.100.4' + set vpn l2tp remote-access name-server '198.51.100.8' + set vpn l2tp remote-access name-server '198.51.100.4' Established sessions can be viewed using the **show vpn remote-access** operational command, or **show l2tp-server sessions** diff --git a/docs/debugging.rst b/docs/debugging.rst index 6150ff60..e9207664 100644 --- a/docs/debugging.rst +++ b/docs/debugging.rst @@ -76,6 +76,15 @@ will have the same effect as ``touch /tmp/vyos.ifconfig.debug``. disable ``vyos-configd`` in addition. This can be run either one-time by calling ``sudo systemctl stop vyos-configd`` or make this reboot-safe by calling ``sudo systemctl disable vyos-configd``. + +FRR +--- + +Recent versions use the ``vyos.frr`` framework. The Python class is located +inside our ``vyos-1x:python/vyos/frr.py``. It comes with an embedded debugging/ +(print style) debugger as vyos.ifconfig does. + +To enable debugging just run: ``$ touch /tmp/vyos.frr.debug`` Debugging Python Code with PDB ------------------------------ @@ -188,4 +197,4 @@ the execution order of the scripts. .. _bootchart.conf: https://github.com/vyos/vyos-build/blob/current/data/live-build-config/includes.chroot/etc/systemd/bootchart.conf .. include:: /_include/common-references.txt -.. start_vyoslinter
\ No newline at end of file +.. start_vyoslinter |