Browse Source

Merge "Diagnostic snapshot description"

Jenkins 2 years ago
parent
commit
9b84e969f6
2 changed files with 68 additions and 0 deletions
  1. 67
    0
      doc/source/diagnostic_snapshot.rst
  2. 1
    0
      doc/source/index.rst

+ 67
- 0
doc/source/diagnostic_snapshot.rst View File

@@ -0,0 +1,67 @@
1
+.. diagnostic_snapshot:
2
+
3
+==================================
4
+Diagnostic snapshot
5
+==================================
6
+
7
+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:
8
+
9
+::
10
+
11
+    ./tools/diagnostic_snapshot -n <namespace> -o <output_dir> -c <ccp_config>
12
+
13
+.. _parameters:
14
+
15
+parameters
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
+
38
+This 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
+
66
+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
67
+

+ 1
- 0
doc/source/index.rst View File

@@ -58,6 +58,7 @@ Developer docs
58 58
    docker
59 59
    dsl
60 60
    debugging
61
+   diagnostic_snapshot
61 62
 
62 63
 Design docs
63 64
 -----------

Loading…
Cancel
Save