machinery-tool 1.21.0 → 1.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. checksums.yaml +4 -4
  2. data/.git_revision +1 -1
  3. data/NEWS +8 -0
  4. data/html/index.html.haml +8 -7
  5. data/html/partials/changed_config_files.html.haml +1 -1
  6. data/html/partials/changed_managed_files.html.haml +1 -1
  7. data/html/partials/unmanaged_files.html.haml +2 -2
  8. data/lib/cli.rb +26 -4
  9. data/lib/diff_widget.rb +73 -0
  10. data/lib/dpkg_database.rb +16 -1
  11. data/lib/haml_helpers.rb +60 -0
  12. data/lib/kiwi_config.rb +7 -0
  13. data/lib/machinery.rb +3 -0
  14. data/lib/man_task.rb +3 -2
  15. data/lib/move_task.rb +1 -0
  16. data/lib/remote_system.rb +4 -0
  17. data/lib/server.rb +2 -105
  18. data/lib/static_html.rb +75 -0
  19. data/lib/system.rb +2 -1
  20. data/lib/system_description.rb +10 -0
  21. data/lib/version.rb +1 -1
  22. data/machinery-helper/version.go +1 -1
  23. data/man/generated/machinery.1.gz +0 -0
  24. data/manual/docs/README.md +8 -16
  25. data/manual/docs/docs.md +42 -4
  26. data/manual/docs/index.html +6 -2
  27. data/manual/docs/machinery-analyze.1.md +6 -10
  28. data/manual/docs/machinery-build.1.md +7 -11
  29. data/manual/docs/machinery-compare.1.md +5 -10
  30. data/manual/docs/machinery-config.1.md +4 -7
  31. data/manual/docs/machinery-copy.1.md +5 -10
  32. data/manual/docs/machinery-deploy.1.md +8 -12
  33. data/manual/docs/machinery-export-autoyast.1.md +10 -17
  34. data/manual/docs/machinery-export-html.1.md +32 -0
  35. data/manual/docs/machinery-export-kiwi.1.md +7 -12
  36. data/manual/docs/{machinery-inspect-docker.1.md → machinery-inspect-container.1.md} +10 -15
  37. data/manual/docs/machinery-inspect.1.md +10 -15
  38. data/manual/docs/machinery-list.1.md +4 -8
  39. data/manual/docs/machinery-man.1.md +4 -6
  40. data/manual/docs/machinery-move.1.md +4 -8
  41. data/manual/docs/machinery-remove.1.md +5 -10
  42. data/manual/docs/machinery-serve.1.md +5 -9
  43. data/manual/docs/machinery-show.1.md +7 -11
  44. data/manual/docs/machinery-upgrade-format.1.md +5 -9
  45. data/manual/docs/machinery-validate.1.md +4 -8
  46. data/manual/docs/machinery_main_general.1.md +33 -51
  47. data/manual/docs/machinery_main_scopes.1.md +13 -14
  48. data/manual/docs/{machinery_security_implications.1.md → machinery_main_security_implications.1.md} +15 -15
  49. data/manual/docs/machinery_main_usecases.1.md +2 -30
  50. data/manual/mkdocs.yml +9 -9
  51. data/manual/site/docs/index.html +71 -25
  52. data/manual/site/index.html +6 -2
  53. data/manual/site/machinery-analyze.1/index.html +34 -27
  54. data/manual/site/machinery-build.1/index.html +35 -28
  55. data/manual/site/machinery-compare.1/index.html +33 -26
  56. data/manual/site/machinery-config.1/index.html +32 -25
  57. data/manual/site/machinery-copy.1/index.html +33 -27
  58. data/manual/site/machinery-deploy.1/index.html +36 -29
  59. data/manual/site/machinery-export-autoyast.1/index.html +38 -32
  60. data/manual/site/machinery-export-html.1/index.html +175 -0
  61. data/manual/site/machinery-export-kiwi.1/index.html +35 -28
  62. data/manual/site/machinery-inspect-container.1/index.html +249 -0
  63. data/manual/site/machinery-inspect.1/index.html +38 -31
  64. data/manual/site/machinery-list.1/index.html +32 -25
  65. data/manual/site/machinery-man.1/index.html +32 -26
  66. data/manual/site/machinery-move.1/index.html +32 -25
  67. data/manual/site/machinery-remove.1/index.html +33 -26
  68. data/manual/site/machinery-serve.1/index.html +33 -26
  69. data/manual/site/machinery-show.1/index.html +35 -28
  70. data/manual/site/machinery-upgrade-format.1/index.html +33 -26
  71. data/manual/site/machinery-validate.1/index.html +32 -25
  72. data/manual/site/machinery_main_general.1/index.html +63 -70
  73. data/manual/site/machinery_main_scopes.1/index.html +41 -36
  74. data/manual/site/machinery_main_security_implications.1/index.html +228 -0
  75. data/manual/site/machinery_main_usecases.1/index.html +30 -48
  76. data/manual/site/mkdocs/search_index.json +246 -201
  77. data/manual/site/sitemap.xml +40 -30
  78. data/plugins/os/os_inspector.rb +1 -1
  79. data/plugins/packages/packages.yml +1 -1
  80. data/plugins/patterns/patterns.yml +2 -5
  81. data/plugins/repositories/repositories.yml +2 -2
  82. data/plugins/unmanaged_files/unmanaged_files.yml +3 -3
  83. data/plugins/unmanaged_files/unmanaged_files_renderer.rb +1 -1
  84. metadata +11 -5
  85. data/manual/docs/subcommand-template.1.md +0 -46
@@ -23,26 +23,29 @@
23
23
 
24
24
 
25
25
 
26
- <li>Home
27
- <ul>
28
-
29
- <li class="">
30
- <a href="../machinery_main_general.1/">General</a>
31
- </li>
32
-
33
- <li class="">
34
- <a href="../machinery_main_scopes.1/">Scopes</a>
35
- </li>
36
-
37
- <li class="">
38
- <a href="../machinery_main_usecases.1/">Use cases</a>
39
- </li>
40
-
41
- <li class="">
42
- <a href="../machinery_security_implications.1/">Security Implications</a>
43
- </li>
44
-
45
- </ul>
26
+ <li class="">
27
+ <a href="../machinery_main_general.1/">General Overview</a>
28
+ </li>
29
+
30
+
31
+
32
+
33
+ <li class="">
34
+ <a href="../machinery_main_scopes.1/">Scopes</a>
35
+ </li>
36
+
37
+
38
+
39
+
40
+ <li class="">
41
+ <a href="../machinery_main_usecases.1/">Use cases</a>
42
+ </li>
43
+
44
+
45
+
46
+
47
+ <li class="">
48
+ <a href="../machinery_main_security_implications.1/">Security Implications</a>
46
49
  </li>
47
50
 
48
51
 
@@ -83,12 +86,16 @@
83
86
  <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
84
87
  </li>
85
88
 
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
86
93
  <li class="current">
87
94
  <a href="./">Inspect</a>
88
95
  </li>
89
96
 
90
97
  <li class="">
91
- <a href="../machinery-inspect-docker.1/">Inspect Docker</a>
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
92
99
  </li>
93
100
 
94
101
  <li class="">
@@ -132,10 +139,10 @@
132
139
  </div>
133
140
  <div class="content">
134
141
  <h1 id="inspect-inspect-running-system">inspect — Inspect Running System</h1>
135
- <h2 id="synopsis">SYNOPSIS</h2>
142
+ <h2 id="synopsis">Synopsis</h2>
136
143
  <p><code>machinery inspect</code> [OPTIONS] HOSTNAME</p>
137
144
  <p><code>machinery</code> help inspect</p>
138
- <h2 id="description">DESCRIPTION</h2>
145
+ <h2 id="description">Description</h2>
139
146
  <p>The <code>inspect</code> command inspects a running system and generates a system
140
147
  description from the gathered data.</p>
141
148
  <p>The system data is structured into scopes, controlled by the
@@ -145,14 +152,14 @@ Machinery will always inspect all specified scopes, and skip scopes which
145
152
  trigger errors.</p>
146
153
  <p><strong>Note</strong>:
147
154
  Tasks on Debian-like systems are treated as patterns.</p>
148
- <h2 id="arguments">ARGUMENTS</h2>
155
+ <h2 id="arguments">Arguments</h2>
149
156
  <ul>
150
157
  <li><code>HOSTNAME</code> (required):
151
158
  The host name of the system to be inspected. The host name will also be
152
159
  used as the name of the stored system description unless another name is
153
160
  provided with the <code>--name</code> option.</li>
154
161
  </ul>
155
- <h2 id="options">OPTIONS</h2>
162
+ <h2 id="options">Options</h2>
156
163
  <ul>
157
164
  <li>
158
165
  <p><code>-n NAME</code>, <code>--name=NAME</code> (optional):
@@ -161,18 +168,18 @@ Tasks on Debian-like systems are treated as patterns.</p>
161
168
  <li>
162
169
  <p><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional):
163
170
  Inspect system for specified scope.
164
- See the <a href="../machinery_main_scopes.1/index.html">Scope section</a> for more information.</p>
171
+ See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
165
172
  </li>
166
173
  <li>
167
174
  <p><code>-e SCOPE</code>, <code>--ignore-scope=IGNORE-SCOPE</code> (optional):
168
175
  Inspect system for all scopes except the specified scope.
169
- See the <a href="../machinery_main_scopes.1/index.html">Scope section</a> for more information.</p>
176
+ See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
170
177
  </li>
171
178
  <li>
172
179
  <p><code>-r USER</code>, <code>--remote-user=USER</code> (optional):
173
180
  Defines the user which is used to access the inspected system via SSH.
174
181
  This user needs to be allowed to run certain commands using sudo (see
175
- PREREQUISITES for more information).
182
+ Prerequisites for more information).
176
183
  To change the default-user use <code>machinery config remote-user=USER</code></p>
177
184
  </li>
178
185
  <li>
@@ -220,7 +227,7 @@ Tasks on Debian-like systems are treated as patterns.</p>
220
227
  Display the filters which are used during inspection.</p>
221
228
  </li>
222
229
  </ul>
223
- <h2 id="prerequisites">PREREQUISITES</h2>
230
+ <h2 id="prerequisites">Prerequisites</h2>
224
231
  <ul>
225
232
  <li>
226
233
  <p>Inspecting a local system requires running <code>machinery</code> as root.</p>
@@ -229,7 +236,7 @@ Tasks on Debian-like systems are treated as patterns.</p>
229
236
  <p>Inspecting a remote system requires passwordless SSH login as root on the
230
237
  inspected system.
231
238
  Use <code>ssh-agent</code> or asymmetric keys (you can transfer the current SSH key
232
- via <code>ssh-copy-id</code> to the inspected host, e.g.: <code>ssh-copy-id root@HOSTNAME</code>)</p>
239
+ via <code>ssh-copy-id</code> to the inspected host, e.g.: <code>ssh-copy-id root@HOSTNAME</code>).</p>
233
240
  </li>
234
241
  <li>
235
242
  <p>The system to be inspected needs to have the following commands:</p>
@@ -257,7 +264,7 @@ Tasks on Debian-like systems are treated as patterns.</p>
257
264
  <p># <code>passwd</code> machinery</p>
258
265
  </li>
259
266
  </ul>
260
- <h2 id="examples">EXAMPLES</h2>
267
+ <h2 id="examples">Examples</h2>
261
268
  <ul>
262
269
  <li>
263
270
  <p>Inspect remote system <code>myhost</code> and save system description under name
@@ -23,26 +23,29 @@
23
23
 
24
24
 
25
25
 
26
- <li>Home
27
- <ul>
28
-
29
- <li class="">
30
- <a href="../machinery_main_general.1/">General</a>
31
- </li>
32
-
33
- <li class="">
34
- <a href="../machinery_main_scopes.1/">Scopes</a>
35
- </li>
36
-
37
- <li class="">
38
- <a href="../machinery_main_usecases.1/">Use cases</a>
39
- </li>
40
-
41
- <li class="">
42
- <a href="../machinery_security_implications.1/">Security Implications</a>
43
- </li>
44
-
45
- </ul>
26
+ <li class="">
27
+ <a href="../machinery_main_general.1/">General Overview</a>
28
+ </li>
29
+
30
+
31
+
32
+
33
+ <li class="">
34
+ <a href="../machinery_main_scopes.1/">Scopes</a>
35
+ </li>
36
+
37
+
38
+
39
+
40
+ <li class="">
41
+ <a href="../machinery_main_usecases.1/">Use cases</a>
42
+ </li>
43
+
44
+
45
+
46
+
47
+ <li class="">
48
+ <a href="../machinery_main_security_implications.1/">Security Implications</a>
46
49
  </li>
47
50
 
48
51
 
@@ -83,12 +86,16 @@
83
86
  <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
84
87
  </li>
85
88
 
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
86
93
  <li class="">
87
94
  <a href="../machinery-inspect.1/">Inspect</a>
88
95
  </li>
89
96
 
90
97
  <li class="">
91
- <a href="../machinery-inspect-docker.1/">Inspect Docker</a>
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
92
99
  </li>
93
100
 
94
101
  <li class="current">
@@ -132,15 +139,15 @@
132
139
  </div>
133
140
  <div class="content">
134
141
  <h1 id="list-list-system-descriptions">list — List System Descriptions</h1>
135
- <h2 id="synopsis">SYNOPSIS</h2>
142
+ <h2 id="synopsis">Synopsis</h2>
136
143
  <p><code>machinery list</code> [OPTIONS] [NAME[,NAME2[,NAME3]]]</p>
137
144
  <p><code>machinery</code> help list</p>
138
- <h2 id="description">DESCRIPTION</h2>
145
+ <h2 id="description">Description</h2>
139
146
  <p>List the specified system descriptions if parameter name is given.
140
147
  List all available system descriptions in the internal database if no name parameter is given.
141
148
  The list is sorted alphabetically and contains a name and the
142
149
  scopes for each system.</p>
143
- <h2 id="options">OPTIONS</h2>
150
+ <h2 id="options">Options</h2>
144
151
  <ul>
145
152
  <li><code>--verbose</code> (optional):
146
153
  Print additional information about the origin of scopes.
@@ -151,7 +158,7 @@ scopes for each system.</p>
151
158
  Run a web server and open the list of system descriptions in HTML format in
152
159
  your web browser using the <code>xdg-open</code> command.</li>
153
160
  </ul>
154
- <h2 id="examples">EXAMPLES</h2>
161
+ <h2 id="examples">Examples</h2>
155
162
  <ul>
156
163
  <li>
157
164
  <p>Lists the two specified system descriptions <code>a</code> and <code>b</code>:</p>
@@ -23,26 +23,29 @@
23
23
 
24
24
 
25
25
 
26
- <li>Home
27
- <ul>
28
-
29
- <li class="">
30
- <a href="../machinery_main_general.1/">General</a>
31
- </li>
32
-
33
- <li class="">
34
- <a href="../machinery_main_scopes.1/">Scopes</a>
35
- </li>
36
-
37
- <li class="">
38
- <a href="../machinery_main_usecases.1/">Use cases</a>
39
- </li>
40
-
41
- <li class="">
42
- <a href="../machinery_security_implications.1/">Security Implications</a>
43
- </li>
44
-
45
- </ul>
26
+ <li class="">
27
+ <a href="../machinery_main_general.1/">General Overview</a>
28
+ </li>
29
+
30
+
31
+
32
+
33
+ <li class="">
34
+ <a href="../machinery_main_scopes.1/">Scopes</a>
35
+ </li>
36
+
37
+
38
+
39
+
40
+ <li class="">
41
+ <a href="../machinery_main_usecases.1/">Use cases</a>
42
+ </li>
43
+
44
+
45
+
46
+
47
+ <li class="">
48
+ <a href="../machinery_main_security_implications.1/">Security Implications</a>
46
49
  </li>
47
50
 
48
51
 
@@ -83,12 +86,16 @@
83
86
  <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
84
87
  </li>
85
88
 
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
86
93
  <li class="">
87
94
  <a href="../machinery-inspect.1/">Inspect</a>
88
95
  </li>
89
96
 
90
97
  <li class="">
91
- <a href="../machinery-inspect-docker.1/">Inspect Docker</a>
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
92
99
  </li>
93
100
 
94
101
  <li class="">
@@ -132,15 +139,14 @@
132
139
  </div>
133
140
  <div class="content">
134
141
  <h1 id="man-shows-man-page">man — Shows Man Page</h1>
135
- <h2 id="synopsis">SYNOPSIS</h2>
142
+ <h2 id="synopsis">Synopsis</h2>
136
143
  <p><code>machinery man</code> [OPTIONS]</p>
137
- <h2 id="options">OPTIONS</h2>
144
+ <h2 id="options">Options</h2>
138
145
  <ul>
139
146
  <li><code>--html</code> (optional):
140
- Run a web server and open the documentation in HTML format in your web browser using the
141
- <code>xdg-open</code> command.</li>
147
+ Run a web server and open the documentation in HTML format in your web browser.</li>
142
148
  </ul>
143
- <h2 id="description">DESCRIPTION</h2>
149
+ <h2 id="description">Description</h2>
144
150
  <p>The <code>man</code> command shows the Machinery man page.</p>
145
151
  </div>
146
152
  </div>
@@ -23,26 +23,29 @@
23
23
 
24
24
 
25
25
 
26
- <li>Home
27
- <ul>
28
-
29
- <li class="">
30
- <a href="../machinery_main_general.1/">General</a>
31
- </li>
32
-
33
- <li class="">
34
- <a href="../machinery_main_scopes.1/">Scopes</a>
35
- </li>
36
-
37
- <li class="">
38
- <a href="../machinery_main_usecases.1/">Use cases</a>
39
- </li>
40
-
41
- <li class="">
42
- <a href="../machinery_security_implications.1/">Security Implications</a>
43
- </li>
44
-
45
- </ul>
26
+ <li class="">
27
+ <a href="../machinery_main_general.1/">General Overview</a>
28
+ </li>
29
+
30
+
31
+
32
+
33
+ <li class="">
34
+ <a href="../machinery_main_scopes.1/">Scopes</a>
35
+ </li>
36
+
37
+
38
+
39
+
40
+ <li class="">
41
+ <a href="../machinery_main_usecases.1/">Use cases</a>
42
+ </li>
43
+
44
+
45
+
46
+
47
+ <li class="">
48
+ <a href="../machinery_main_security_implications.1/">Security Implications</a>
46
49
  </li>
47
50
 
48
51
 
@@ -83,12 +86,16 @@
83
86
  <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
84
87
  </li>
85
88
 
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
86
93
  <li class="">
87
94
  <a href="../machinery-inspect.1/">Inspect</a>
88
95
  </li>
89
96
 
90
97
  <li class="">
91
- <a href="../machinery-inspect-docker.1/">Inspect Docker</a>
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
92
99
  </li>
93
100
 
94
101
  <li class="">
@@ -132,13 +139,13 @@
132
139
  </div>
133
140
  <div class="content">
134
141
  <h1 id="move-move-system-description">move — Move System Description</h1>
135
- <h2 id="synopsis">SYNOPSIS</h2>
142
+ <h2 id="synopsis">Synopsis</h2>
136
143
  <p><code>machinery move</code>
137
144
  FROM_NAME TO_NAME</p>
138
145
  <p><code>machinery</code> help move</p>
139
- <h2 id="description">DESCRIPTION</h2>
146
+ <h2 id="description">Description</h2>
140
147
  <p>The <code>move</code> command renames a stored system description from <code>FROM_NAME</code> to <code>TO_NAME</code>.</p>
141
- <h2 id="arguments">ARGUMENTS</h2>
148
+ <h2 id="arguments">Arguments</h2>
142
149
  <ul>
143
150
  <li>
144
151
  <p><code>FROM_NAME</code> (required):
@@ -149,7 +156,7 @@
149
156
  New name of the system description.</p>
150
157
  </li>
151
158
  </ul>
152
- <h2 id="examples">EXAMPLES</h2>
159
+ <h2 id="examples">Examples</h2>
153
160
  <ul>
154
161
  <li>
155
162
  <p>Rename the system description <code>earth</code> to <code>moon</code>:</p>
@@ -23,26 +23,29 @@
23
23
 
24
24
 
25
25
 
26
- <li>Home
27
- <ul>
28
-
29
- <li class="">
30
- <a href="../machinery_main_general.1/">General</a>
31
- </li>
32
-
33
- <li class="">
34
- <a href="../machinery_main_scopes.1/">Scopes</a>
35
- </li>
36
-
37
- <li class="">
38
- <a href="../machinery_main_usecases.1/">Use cases</a>
39
- </li>
40
-
41
- <li class="">
42
- <a href="../machinery_security_implications.1/">Security Implications</a>
43
- </li>
44
-
45
- </ul>
26
+ <li class="">
27
+ <a href="../machinery_main_general.1/">General Overview</a>
28
+ </li>
29
+
30
+
31
+
32
+
33
+ <li class="">
34
+ <a href="../machinery_main_scopes.1/">Scopes</a>
35
+ </li>
36
+
37
+
38
+
39
+
40
+ <li class="">
41
+ <a href="../machinery_main_usecases.1/">Use cases</a>
42
+ </li>
43
+
44
+
45
+
46
+
47
+ <li class="">
48
+ <a href="../machinery_main_security_implications.1/">Security Implications</a>
46
49
  </li>
47
50
 
48
51
 
@@ -83,12 +86,16 @@
83
86
  <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
84
87
  </li>
85
88
 
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
86
93
  <li class="">
87
94
  <a href="../machinery-inspect.1/">Inspect</a>
88
95
  </li>
89
96
 
90
97
  <li class="">
91
- <a href="../machinery-inspect-docker.1/">Inspect Docker</a>
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
92
99
  </li>
93
100
 
94
101
  <li class="">
@@ -132,13 +139,13 @@
132
139
  </div>
133
140
  <div class="content">
134
141
  <h1 id="remove-remove-system-descriptions">remove — Remove System Descriptions</h1>
135
- <h2 id="synopsis">SYNOPSIS</h2>
142
+ <h2 id="synopsis">Synopsis</h2>
136
143
  <p><code>machinery remove</code> [--all]
137
144
  [NAME[,NAME2[,NAME3]]]</p>
138
145
  <p><code>machinery</code> help remove</p>
139
- <h2 id="description">DESCRIPTION</h2>
146
+ <h2 id="description">Description</h2>
140
147
  <p>The <code>remove</code> command removes all specified system descriptions.</p>
141
- <h2 id="options">OPTIONS</h2>
148
+ <h2 id="options">Options</h2>
142
149
  <ul>
143
150
  <li>
144
151
  <p><code>--all</code> (optional):
@@ -149,12 +156,12 @@
149
156
  Explain what is being done.</p>
150
157
  </li>
151
158
  </ul>
152
- <h2 id="arguments">ARGUMENTS</h2>
159
+ <h2 id="arguments">Arguments</h2>
153
160
  <ul>
154
161
  <li><code>NAME...</code> (required):
155
162
  Remove specified system descriptions.</li>
156
163
  </ul>
157
- <h2 id="examples">EXAMPLES</h2>
164
+ <h2 id="examples">Examples</h2>
158
165
  <ul>
159
166
  <li>
160
167
  <p>Remove the system description stored as <code>earth</code>:</p>