From eea005b2e4308e537c8c97a6bd43338676187d36 Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Sun, 15 Dec 2019 13:21:38 +0100
Subject: config-management: restructure to the new cfgcmd/opcmd style

---
 docs/system/config-management.rst | 43 +++++++++++++++++++--------------------
 1 file changed, 21 insertions(+), 22 deletions(-)

(limited to 'docs/system/config-management.rst')

diff --git a/docs/system/config-management.rst b/docs/system/config-management.rst
index f087cb46..b8c1d309 100644
--- a/docs/system/config-management.rst
+++ b/docs/system/config-management.rst
@@ -1,33 +1,32 @@
 .. _config-management:
 
-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.
 
-The following changes the number of commit revisions. In the default settings, 20 revisions are stored locally.
+.. cfgcmd:: set system config-management commit-revisions <number>
 
-.. code-block:: none
+Change the number of commit revisions to `<number>`, the default setting for
+this value is to store 20 revisions locally.
 
-  set system config-management commit-revisions 50
 
+.. 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 destinations.
+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)`
 
-.. code-block:: none
+* ``scp://<user>:<passwd>@<host>/<dir>``
+* ``sftp://<user>:<passwd>@<host>/<dir>``
+* ``ftp://<user>:<passwd>@<host>/<dir>``
+* ``tftp://<host>/<dir>``
 
-  set system config-management commit-archive location 'tftp://10.0.0.2'
-
-.. note:: the number of revisions don't effect the commit-archive:
-
-A commit look now like this:
-
-.. code-block:: none
-
-    vyos@vyos-R1# commit
-    Archiving config...
-    tftp://10.0.0.2  OK
-    [edit]
-    vyos@vyos-R1#
-
-The filename has this format: config.boot-hostname.YYYYMMDD_HHMMSS
\ No newline at end of file
+.. note:: The number of revisions don't effect the commit-archive.
\ No newline at end of file
-- 
cgit v1.2.3