diff options
| -rw-r--r-- | docs/configuration-overview.rst | 49 | ||||
| -rw-r--r-- | docs/contributing/development.rst | 29 | ||||
| -rw-r--r-- | docs/interfaces/advanced-index.rst | 8 | ||||
| -rw-r--r-- | docs/system/advanced-index.rst | 9 | ||||
| -rw-r--r-- | docs/system/basic-index.rst | 8 | ||||
| -rw-r--r-- | docs/system/config-management.rst | 32 | ||||
| -rw-r--r-- | docs/vrf.rst | 7 |
7 files changed, 78 insertions, 64 deletions
diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index cadaabac..27bd5d36 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -29,8 +29,8 @@ A VyOS system has three major types of configurations: can be multiple configuration files. The default or "boot" configuration is saved and loaded from the file ``/config/config.boot``. -Work the Config -=============== +Seeing the configuration +======================== .. opcmd:: show configuration @@ -121,8 +121,8 @@ Both these commands should be executed when in operational mode, they do not work directly in configuration mode. The is a special way on how to :ref:`run_opmode_from_config_mode`. -Navigating -========== +Navigating the configuration +============================ When entering the configuration mode you are navigating inside the tree structure exported in the overview above, to enter configuration mode enter @@ -223,10 +223,10 @@ to the top level. vyos@vyos# exit Warning: configuration changes have not been saved. -Managing -======== +Editing the configuration +========================= -The configuration is managed by the use of :cfgcmd:`set` and :cfgcmd:`delete` +The configuration can be edited by the use of :cfgcmd:`set` and :cfgcmd:`delete` commands from within configuration mode. Configuration commands are flattened from the tree into 'one-liner' commands shown in :opcmd:`show configuration commands` from operation mode. @@ -337,11 +337,14 @@ commands. --------- ---------- --- ----------- eth0 0.0.0.0/0 u/u -Config Archive -============== +Managing configurations +======================= -VyOS automatically maintains backups of every previous configurations which -has been committed to the system. +VyOS comes with an integrated versioning system for the system configuration. +It automatically maintains a backup of every previous configuration +which has been committed to the system. +The configurations are versioned locally for rollback +but they can also be stored on a remote host for archiving/backup reasons. Local Archive ------------- @@ -416,6 +419,7 @@ previous revisions if something goes wrong. You can specify the number of revisions stored on disk. N can be in the range of 0 - 65535. When the number of revisions exceeds the configured value, the oldest revision is removed. + The default setting for this value is to store 20 revisions locally. Rollback Changes ---------------- @@ -443,19 +447,26 @@ Remote Archive -------------- VyOS can upload the configuration to a remote location after each call to -:cfgcmd:`commit`. TFTP, FTP, and SFTP servers are supported. +:cfgcmd:`commit`. You will have to set the commit-archive location. +TFTP, FTP, and SFTP servers are supported. +Every time a :cfgcmd:`commit` is successfull +the ``config.boot`` file will be copied to the defined destination(s). +The filename used on the remote host will be ``config.boot-hostname.YYYYMMDD_HHMMSS`` -.. cfgcmd set system config-management commit-archive location <URI> +.. cfgcmd:: set system config-management commit-archive location <URI> - Specify remote location of commit archive. + Specify remote location of commit archive as any of the below :abbr:`URI (Uniform + Resource Identifier)` - * scp://<user>:<passwd>@<host>/<dir> - * sftp://<user>:<passwd>@<host>/<dir> - * ftp://<user>:<passwd>@<host>/<dir> - * tftp://<host>/<dir> + * ``scp://<user>:<passwd>@<host>/<dir>`` + * ``sftp://<user>:<passwd>@<host>/<dir>`` + * ``ftp://<user>:<passwd>@<host>/<dir>`` + * ``tftp://<host>/<dir>`` + +.. note:: The number of revisions don't affect the commit-archive. Restore Default -=============== +--------------- In the case you want to completely delete your configuration and restore the default one, you can enter the following command in configuration mode: diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index 009e84f7..0a8967d5 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -673,6 +673,34 @@ Migrating old CLI - None - All logic should be in the scripts +Debugging +========= + +There are two flags available to aid in debugging configuration scripts. +Since configuration loading issues will manifest during boot, the flags are +passed as kernel boot parameters. + +Kernel boot parameters +---------------------- + +``vyos-debug`` +^^^^^^^^^^^^^^ + +Adding the parameter ``vyos-debug`` to the linux boot line will produce +timing results for the execution of scripts during commit. If one is seeing +an unexpected delay during manual or boot commit, this may be useful in +identifying bottlenecks. The internal flag is ``VYOS_DEBUG``, and is found in +vyatta-cfg_. Output is directed to ``/var/log/vyatta/cfg-stdout.log``. + +``vyos-config-debug`` +^^^^^^^^^^^^^^^^^^^^^ + +During development, coding errors can lead to a commit failure on boot, +possibly resulting in a failed initialization of the CLI. In this +circumstance, the kernel boot parameter ``vyos-config-debug`` will ensure +access to the system as user ``vyos``, and will log a Python stack trace to +``/tmp/boot-config-trace``. + Continuous Integration ====================== @@ -701,5 +729,6 @@ http://dev.packages.vyos.net/repositories/. .. _`IPv4, IPv6`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/address-ipv4-ipv6.xml.i .. _`VLAN (VIF)`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/vif.xml.i .. _`MAC address`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/interface-mac.xml.i +.. _vyatta-cfg: https://github.com/vyos/vyatta-cfg .. include:: ../common-references.rst diff --git a/docs/interfaces/advanced-index.rst b/docs/interfaces/advanced-index.rst index e86a9330..73c471e9 100644 --- a/docs/interfaces/advanced-index.rst +++ b/docs/interfaces/advanced-index.rst @@ -1,8 +1,8 @@ -.. _network-interfaces: +.. _advanced_network-interfaces: -################## -Network Interfaces -################## +########################### +Advanced Network Interfaces +########################### .. toctree:: :maxdepth: 1 diff --git a/docs/system/advanced-index.rst b/docs/system/advanced-index.rst index 1ce1b405..9241821b 100644 --- a/docs/system/advanced-index.rst +++ b/docs/system/advanced-index.rst @@ -1,13 +1,12 @@ -.. _system_config: +.. _advanced_system_tweaks: -#################### -System Configuration -#################### +###################### +Advanced System Tweaks +###################### .. toctree:: :maxdepth: 2 - config-management eventhandler flow-accounting ntp diff --git a/docs/system/basic-index.rst b/docs/system/basic-index.rst index ab23478f..cb030089 100644 --- a/docs/system/basic-index.rst +++ b/docs/system/basic-index.rst @@ -1,8 +1,8 @@ -.. _basic_system_config: +.. _basic_system_tweaks: -########################## -Basic System Configuration -########################## +################### +Basic System Tweaks +################### .. toctree:: :maxdepth: 2 diff --git a/docs/system/config-management.rst b/docs/system/config-management.rst deleted file mode 100644 index 9d65adb3..00000000 --- a/docs/system/config-management.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _config-management: - -######################## -Configuration Management -######################## - -VyOS comes with an integrated versioning system for the system configuration. -The configurations are versioned locally for rollback but they can also be -stored on a remote host for archiving/backup reasons. - -.. cfgcmd:: set system config-management commit-revisions <number> - - Change the number of commit revisions to `<number>`, the default setting for - this value is to store 20 revisions locally. - -.. cfgcmd:: set system config-management commit-archive location <url> - - If you want to save all config changes to a remote destination. Set the - commit-archive location. Every time a commit is successfully the - ``config.boot`` file will be copied to the defined destination(s). The - filename used on the remote host used will be: - ``config.boot-hostname.YYYYMMDD_HHMMSS`` - - Destinations will be configured as any of the below :abbr:`URI (Uniform - Resource Identifier)` - - * ``scp://<user>:<passwd>@<host>/<dir>`` - * ``sftp://<user>:<passwd>@<host>/<dir>`` - * ``ftp://<user>:<passwd>@<host>/<dir>`` - * ``tftp://<host>/<dir>`` - -.. note:: The number of revisions don't effect the commit-archive.
\ No newline at end of file diff --git a/docs/vrf.rst b/docs/vrf.rst index a1afab58..3cf7e6ad 100644 --- a/docs/vrf.rst +++ b/docs/vrf.rst @@ -257,5 +257,12 @@ For VR Fmaintenance the followin operational commands are in place. 2 packets transmitted, 2 received, 0% packet loss, time 4ms rtt min/avg/max/mdev = 0.070/0.074/0.078/0.004 ms +.. opcmd:: traceroute vrf <name> [ipv4 | ipv6] <host> + + Displays the route packets take to a network host utilizing VRF instance + identified by `<name>`. When using the IPv4 or IPv6 option, display the route + packets take to the for the given hosts IP address family. This option is + useful when the host specified is a hostname rather than an IP address. + .. include:: common-references.rst |