From 109eb10e45af88e7538a8d4dc2221c50261b49c6 Mon Sep 17 00:00:00 2001
From: Artur Zarzycki <azarzycki@mirantis.com>
Date: Thu, 9 Mar 2017 11:17:00 +0100
Subject: [PATCH] Diagnostic snapshot description

Change-Id: Ide3f32abcaf9c2b22305dc173b908d4a04e11a94
---
 doc/source/diagnostic_snapshot.rst | 67 ++++++++++++++++++++++++++++++
 doc/source/index.rst               |  1 +
 2 files changed, 68 insertions(+)
 create mode 100644 doc/source/diagnostic_snapshot.rst

diff --git a/doc/source/diagnostic_snapshot.rst b/doc/source/diagnostic_snapshot.rst
new file mode 100644
index 00000000..6b45a5ea
--- /dev/null
+++ b/doc/source/diagnostic_snapshot.rst
@@ -0,0 +1,67 @@
+.. diagnostic_snapshot:
+
+==================================
+Diagnostic snapshot
+==================================
+
+In ``fuel-ccp/tools`` directory you can find tool called ``diagnostic-snapshot.sh``. This tool helps to collect some debug data about your environment. You can run it with:
+
+::
+
+    ./tools/diagnostic_snapshot -n <namespace> -o <output_dir> -c <ccp_config>
+
+.. _parameters:
+
+parameters
+---------
+
+.. list-table::
+   :widths: 10 13 30
+   :header-rows: 1
+
+   * - Short option
+     - Long option
+     - Description
+   * - -n
+     - --namespace
+     - deployment namespace
+   * - -o
+     - --output-dir
+     - directory where diagnostic snapshot will be saved
+   * - -c
+     - --config
+     - should point to Fuel-ccp config file
+   * - -h
+     - --help
+     - print help
+
+This tool collect some basic data about:
+
+-  k8s objects in kube-system and ccp namespaces:
+
+   - pods
+   - services
+   - jobs
+   - kubelet logs
+
+-  system:
+
+   - diskspace
+   - network configuration
+   - cpu info/load
+   - sysctl info
+
+-  docker:
+
+   - logs
+   - list of images
+   - running containers
+   - stats
+
+-  ccp:
+
+   - status output
+
+
+This script automatically create directory provided as parameter for -o option and archive file in it with all collected data. The name of this file is created with template: <datetime>-diagnostic.tar.gz
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 7b26cb42..ca34e329 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -55,6 +55,7 @@ Developer docs
    docker
    dsl
    debugging
+   diagnostic_snapshot
 
 Design docs
 -----------