From 9970d2e9f33857a3a33b20a6c904d1b2d736d248 Mon Sep 17 00:00:00 2001 From: OlgaGusarenko Date: Tue, 6 Sep 2016 09:53:37 +0300 Subject: [PATCH] [UG] Creating diagnostic snapshot Change-Id: Ifc8bd254ed79836d9f4d73da89727215dfc828f8 --- .../fuel-user-guide/maintain-environment.rst | 2 +- .../maintain-environment/create-snapshot.rst | 78 +++++++++++++++++++ .../maintain-environment/use-shotgun.rst | 52 ------------- 3 files changed, 79 insertions(+), 53 deletions(-) create mode 100644 userdocs/fuel-user-guide/maintain-environment/create-snapshot.rst delete mode 100644 userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst diff --git a/userdocs/fuel-user-guide/maintain-environment.rst b/userdocs/fuel-user-guide/maintain-environment.rst index a8c7a71be..97eb3f823 100644 --- a/userdocs/fuel-user-guide/maintain-environment.rst +++ b/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 diff --git a/userdocs/fuel-user-guide/maintain-environment/create-snapshot.rst b/userdocs/fuel-user-guide/maintain-environment/create-snapshot.rst new file mode 100644 index 000000000..417344b44 --- /dev/null +++ b/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 + + .. 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 --id + + * Run timmy on a particular node role: + + .. code-block:: console + + timmy --role + + * Specify a custom filename for the snapshot archive: + + .. code-block:: console + + timmy --dest-file + + 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 `__ diff --git a/userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst b/userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst deleted file mode 100644 index aba2ace4d..000000000 --- a/userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst +++ /dev/null @@ -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