summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArtur Zarzycki <azarzycki@mirantis.com>2017-03-09 11:17:00 +0100
committerArtur Zarzycki <azarzycki@mirantis.com>2017-03-09 11:17:00 +0100
commit109eb10e45af88e7538a8d4dc2221c50261b49c6 (patch)
tree7ddf8591469082e365661b3a2319e760a1ccd0f2 /doc
parent5da9d81a2d3a89e39818afe418d40151e620386d (diff)
Diagnostic snapshot description
Notes
Notes (review): Verified+1: Mirantis CCP CI <mirantis-fuel-ccp-ci@mirantis.com> Code-Review+2: Andrey Pavlov <apavlov@mirantis.com> Code-Review+2: Sergey Lukjanov <slukjanov@mirantis.com> Workflow+1: Sergey Lukjanov <slukjanov@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 31 Mar 2017 09:01:55 +0000 Reviewed-on: https://review.openstack.org/443550 Project: openstack/fuel-ccp Branch: refs/heads/master
Diffstat (limited to 'doc')
-rw-r--r--doc/source/diagnostic_snapshot.rst67
-rw-r--r--doc/source/index.rst1
2 files changed, 68 insertions, 0 deletions
diff --git a/doc/source/diagnostic_snapshot.rst b/doc/source/diagnostic_snapshot.rst
new file mode 100644
index 0000000..6b45a5e
--- /dev/null
+++ b/doc/source/diagnostic_snapshot.rst
@@ -0,0 +1,67 @@
1.. diagnostic_snapshot:
2
3==================================
4Diagnostic snapshot
5==================================
6
7In ``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:
8
9::
10
11 ./tools/diagnostic_snapshot -n <namespace> -o <output_dir> -c <ccp_config>
12
13.. _parameters:
14
15parameters
16---------
17
18.. list-table::
19 :widths: 10 13 30
20 :header-rows: 1
21
22 * - Short option
23 - Long option
24 - Description
25 * - -n
26 - --namespace
27 - deployment namespace
28 * - -o
29 - --output-dir
30 - directory where diagnostic snapshot will be saved
31 * - -c
32 - --config
33 - should point to Fuel-ccp config file
34 * - -h
35 - --help
36 - print help
37
38This tool collect some basic data about:
39
40- k8s objects in kube-system and ccp namespaces:
41
42 - pods
43 - services
44 - jobs
45 - kubelet logs
46
47- system:
48
49 - diskspace
50 - network configuration
51 - cpu info/load
52 - sysctl info
53
54- docker:
55
56 - logs
57 - list of images
58 - running containers
59 - stats
60
61- ccp:
62
63 - status output
64
65
66This 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
67
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 7b26cb4..ca34e32 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -55,6 +55,7 @@ Developer docs
55 docker 55 docker
56 dsl 56 dsl
57 debugging 57 debugging
58 diagnostic_snapshot
58 59
59Design docs 60Design docs
60----------- 61-----------