Jenkins checking in autogenerated rST files

autogenerated_rst_docs/Backups.rst

@@ -350,18 +350,22 @@ To backup the shared configuration:
 Restoring Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-To restore a previous backup, copy the six files listed above to
-``/etc/clearwater`` on one of your sprout nodes. Then run the following
-commands on that node:
-
-::
-
-    sudo cw-upload_shared_config
-    sudo cw-upload_bgcf_json
-    sudo cw-upload_enum_json
-    sudo cw-upload_scscf_json
-    sudo cw-upload_shared_ifcs_xml
-    sudo cw-upload_fallback_ifcs_xml
+To restore a previous backup, follow these steps:
+
+-  Copy all the files listed above except ``shared_config`` to
+   ``/etc/clearwater`` on one of your sprout nodes.
+-  Run the following commands on that node:
+
+   ``sudo cw-upload_bgcf_json`` ``sudo cw-upload_enum_json``
+   ``sudo cw-upload_scscf_json`` ``sudo cw-upload_shared_ifcs_xml``
+   ``sudo cw-upload_fallback_ifcs_xml``
+
+-  Run ``cw-config download shared_config`` to download a copy of the
+   current ``shared_config``.
+-  Copy the backed up version of ``shared_config`` over the top of the
+   downloaded copy.
+-  Run ``cw-config upload shared_config`` to push the config to all the
+   nodes in the cluster.
 
 See `Modifying Clearwater settings <Modifying_Clearwater_settings.html>`__
 for more details on this.

autogenerated_rst_docs/Manual_Install.rst

@@ -251,11 +251,12 @@ documentation <Clearwater_SNMP_Statistics.html>`__.
 Provide Shared Configuration
 ----------------------------
 
-Log onto any node in the deployment and create the file
-``/etc/clearwater/shared_config`` with the following contents. The
-``site_name`` should match the value of ``local_site_name`` in
-``local_config``; if your deployment is not geographically redundant
-then you don't need to include it.
+Log onto any node in the deployment and run
+``cw-config download shared_config``. This will download the current
+``shared_config`` in use by your deployment. Edit the downloaded file to
+add the following contents. The ``site_name`` should match the value of
+``local_site_name`` in ``local_config``; if your deployment is not
+geographically redundant then you don't need to include it.
 
 ::
 
@@ -349,7 +350,7 @@ this).
 
 ::
 
-    sudo cw-upload_shared_config
+    `cw-config upload shared_config`
 
 Provision Telephone Numbers in Ellis
 ------------------------------------

autogenerated_rst_docs/Modifying_Clearwater_settings.rst

@@ -19,19 +19,23 @@ scratch" section instead.
 
 To change one of these settings:
 
--  Edit ``/etc/clearwater/shared_config`` on *one* node in each site and
-   change to the new value.
--  Run ``sudo cw-upload_shared_config`` to upload the new config to
-   etcd. The changes to the shared configuration are logged to
+-  On one node of your deployment, run
+   ``cw-config download shared_config``. This will download the current
+   version of ``shared_config`` to
+   ``~/clearwater-config-manager/[username]/shared_config``.
+-  Edit ``~/clearwater-config-manager/[username]/shared_config`` to make
+   changes as desired.
+-  Run ``cw-config upload shared_config`` to upload the modified config
+   to etcd. The changes to the shared configuration are logged to
    ``/var/log/syslog`` and to the console. Each node in the site picks
    up the changed shared configuration (using Clearwater's `automatic
    configuration sharing <Automatic_Clustering_Config_Sharing.html>`__
    functionality) and safely restarts itself to use it.
 -  You can check which nodes are using the new shared config by running
    ``cw-check_restart_queue_state``. If this command shows that there's
    been an error (i.e. a node wasn't able to restart after picking up
-   the new config), simply fix the ``/etc/clearwater/shared_config`` and
-   run the ``sudo cw-upload_shared_config`` script again.
+   the new config), simply fix the downloaded ``shared_config`` file and
+   run ``cw-config upload shared_config`` again.
 
 Modifying Sprout JSON Configuration
 -----------------------------------

autogenerated_rst_docs/Troubleshooting_and_Recovery.rst

@@ -30,8 +30,8 @@ General
    stress through your deployment, you should revert the log levels back
    to the default level.
 
--  Changes to ``shared_config`` are detected each time
-   ``cw-upload_shared_config`` is run (see `Modifying Clearwater
+-  Changes to ``shared_config`` are detected each time ``cw-config`` is
+   run (see `Modifying Clearwater
    settings <Modifying_Clearwater_settings.html>`__), and logged to
    ``/var/log/syslog`` on the node from which the configuration was
    changed.