[UG] Creating diagnostic snapshot

Change-Id: Ifc8bd254ed79836d9f4d73da89727215dfc828f8

userdocs/fuel-user-guide/maintain-environment.rst

@@ -20,7 +20,7 @@ This section includes the following topics:
    maintain-environment/rollback-ug.rst
    maintain-environment/reinstall-node.rst
    maintain-environment/reinstall-virtual-role.rst
-   maintain-environment/use-shotgun.rst
+   maintain-environment/create-snapshot.rst
    maintain-environment/custom-graph.rst
    maintain-environment/data-driven.rst
    maintain-environment/deployment-history.rst

userdocs/fuel-user-guide/maintain-environment/create-snapshot.rst

@@ -0,0 +1,78 @@
+.. _create-snapshot:
+
+============================
+Create a diagnostic snapshot
+============================
+
+Fuel enables you to generate a diagnostic snapshot of your OpenStack
+environment to simplify troubleshooting. The diagnostic snapshot feature
+is available right after the Fuel Master node installs.
+
+Fuel uses timmy, a diagnostic utility for OpenStack environments, to generate
+diagnostic snapshots through the Fuel web UI or CLI.
+
+**To create a diagnostic snapshot using the Fuel web UI:**
+
+#. Log in to the Fuel web UI.
+#. Navigate to :menuselection:`Support > Download Diagnostic Snapshot`.
+#. Click :guilabel:`Generate Diagnostic Snapshot`.
+
+By default, Fuel generates a diagnostic snapshot of all OpenStack nodes
+with log files updated in the last 3 days creating a ``.tar`` tarball
+with archives inside that becomes available for downloading once the generation
+of a snapshot completes successfully.
+
+**To create a diagnostic snapshot using the Fuel Master CLI:**
+
+#. Log in to the Fuel Master CLI.
+#. Use the :command:`timmy` command to create a snapshot:
+
+   .. code-block:: console
+
+      timmy
+
+   The :command:`timmy` command initiates the snapshot creation of all
+   OpenStack nodes without log collection and according to default
+   configuration.
+
+   You can specify additional options for the :command:`timmy` command.
+
+   **Examples:**
+
+   * Create a diagnostic snapshot according to default configuration but
+     with log collection for a definite period of time in days:
+
+     .. code-block:: console
+
+        timmy --logs --days <NUM>
+
+     .. note:: If not specified, timmy collects log files updated in the last
+               30 days.
+
+   * Run timmy on a particular OpenStack node:
+
+     .. code-block:: console
+
+        timmy --env <ENV_ID> --id <NODE_ID>
+
+   * Run timmy on a particular node role:
+
+     .. code-block:: console
+
+        timmy --role <ROLE_NAME>
+
+   * Specify a custom filename for the snapshot archive:
+
+     .. code-block:: console
+
+        timmy --dest-file <FILE_NAME>
+
+     If log files are collected, they will be placed in the specified folder
+     but as separate archives.
+
+     .. note:: By default, timmy creates a ``general.tar.gz`` snapshot
+               and stores it in ``/tmp/timmy/archives``.
+
+.. seealso::
+
+   * `Timmy documentation <http://timmy.readthedocs.io/en/latest/index.html>`__

userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst

@@ -1,52 +0,0 @@
-
-.. _shotgun-ug:
-
-========================================
-Create diagnostic snapshot using shotgun
-========================================
-
-Shotgun is a tool that you can use to generate diagnostic snapshots
-for Fuel. Although, Fuel API for diagnostic snapshots provides similar
-functionality, you may prefer to use Shotgun due to the following limitations
-of Fuel API:
-
-* When the size of log files is too big, Fuel drops a timeout exceptions.
-* When you use Fuel API, you may run out of space in the */var/* partition.
-
-Therefore, use Shotgun from the Fuel Master node directly and fetch the
-default configuration from the Fuel Client.
-
-Shotgun stores temporary snapshots in ``/var/www/nailgun/dump/fuel-snapshot``.
-A symlink to the last compressed snapshot is located in
-``/var/www/nailgun/dump/last``.
-
-With Shotgun you can use standard commands, such as :command:`dir`,
-:command:`command`, and :command:`file`:
-
-.. code-block:: ini
-
-    - command: brctl show
-      to_file: brctl_show.txt
-      type: command
-    - path: /etc/sysconfig/network-scripts
-      type: dir
-
-**To use Shotgun:**
-
-#. Install Shotgun on the Fuel Master node:
-
-   .. code-block:: console
-
-      yum install -y shotgun
-
-#. Fetch the default configuration:
-
-   .. code-block:: console
-
-      fuel snapshot --conf > dump_conf.yaml
-
-#. Provide the configuration to Shotgun and execute it:
-
-   .. code-block:: console
-
-      shotgun -c dump_conf.yaml