machinery-tool 1.23.1 → 1.24.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +5 -5
  2. data/.git_revision +1 -1
  3. data/NEWS +11 -0
  4. data/export_helpers/kiwi_export_readme.md +3 -3
  5. data/export_helpers/merge_users_and_groups.pl.erb +1 -1
  6. data/lib/build_task.rb +5 -3
  7. data/lib/deploy_task.rb +0 -1
  8. data/lib/exceptions.rb +13 -0
  9. data/lib/kiwi_config.rb +3 -9
  10. data/lib/machinery_helper.rb +15 -1
  11. data/lib/remote_system.rb +4 -2
  12. data/lib/system_description.rb +0 -9
  13. data/lib/version.rb +1 -1
  14. data/machinery-helper/version.go +1 -1
  15. data/man/generated/machinery.1.gz +0 -0
  16. data/manual/docs/index.html +2 -8
  17. data/manual/docs/machinery.ymp +10 -10
  18. data/manual/mkdocs.yml +3 -1
  19. data/manual/site/404.html +145 -0
  20. data/manual/site/css/base.css +324 -0
  21. data/manual/site/css/bootstrap-custom.min.css +1 -0
  22. data/manual/site/css/fixed-positioning.css +0 -0
  23. data/manual/site/css/font-awesome.min.css +4 -0
  24. data/manual/site/docs/index.html +25 -70
  25. data/manual/site/fonts/fontawesome-webfont.eot +0 -0
  26. data/manual/site/fonts/fontawesome-webfont.svg +2671 -0
  27. data/manual/site/fonts/fontawesome-webfont.ttf +0 -0
  28. data/manual/site/fonts/fontawesome-webfont.woff +0 -0
  29. data/manual/site/fonts/fontawesome-webfont.woff2 +0 -0
  30. data/manual/site/fonts/glyphicons-halflings-regular.eot +0 -0
  31. data/manual/site/fonts/glyphicons-halflings-regular.svg +288 -0
  32. data/manual/site/fonts/glyphicons-halflings-regular.ttf +0 -0
  33. data/manual/site/fonts/glyphicons-halflings-regular.woff +0 -0
  34. data/manual/site/fonts/glyphicons-halflings-regular.woff2 +0 -0
  35. data/manual/site/img/favicon.ico +0 -0
  36. data/manual/site/img/grid.png +0 -0
  37. data/manual/site/index.html +135 -396
  38. data/manual/site/js/base.js +216 -0
  39. data/manual/site/js/bootstrap-3.0.3.min.js +7 -0
  40. data/manual/site/js/jquery-1.10.2.min.js +6 -0
  41. data/manual/site/js/jquery.nicescroll.min.js +0 -0
  42. data/manual/site/js/jquery.pageslide.min.js +0 -0
  43. data/manual/site/js/parallaxImg.js +0 -0
  44. data/manual/site/machinery-analyze.1/index.html +25 -54
  45. data/manual/site/machinery-build.1/index.html +25 -85
  46. data/manual/site/machinery-compare.1/index.html +25 -87
  47. data/manual/site/machinery-config.1/index.html +25 -62
  48. data/manual/site/machinery-copy.1/index.html +25 -50
  49. data/manual/site/machinery-deploy.1/index.html +25 -87
  50. data/manual/site/machinery-export-autoyast.1/index.html +25 -74
  51. data/manual/site/machinery-export-html.1/index.html +25 -55
  52. data/manual/site/machinery-export-kiwi.1/index.html +25 -56
  53. data/manual/site/machinery-inspect-container.1/index.html +25 -129
  54. data/manual/site/machinery-inspect.1/index.html +25 -172
  55. data/manual/site/machinery-list.1/index.html +25 -67
  56. data/manual/site/machinery-man.1/index.html +25 -34
  57. data/manual/site/machinery-move.1/index.html +25 -49
  58. data/manual/site/machinery-remove.1/index.html +25 -62
  59. data/manual/site/machinery-serve.1/index.html +25 -61
  60. data/manual/site/machinery-show.1/index.html +25 -86
  61. data/manual/site/machinery-upgrade-format.1/index.html +25 -60
  62. data/manual/site/machinery-validate.1/index.html +25 -48
  63. data/manual/site/machinery.ymp +10 -10
  64. data/manual/site/machinery_main_general.1/index.html +25 -133
  65. data/manual/site/machinery_main_scopes.1/index.html +25 -129
  66. data/manual/site/machinery_main_security_implications.1/index.html +25 -108
  67. data/manual/site/machinery_main_usecases.1/index.html +25 -44
  68. data/manual/site/search/lunr.js +2986 -0
  69. data/manual/site/search/main.js +96 -0
  70. data/manual/site/search/search_index.json +1 -0
  71. data/manual/site/search/worker.js +128 -0
  72. data/manual/site/sitemap.xml +48 -87
  73. data/manual/site/sitemap.xml.gz +0 -0
  74. data/plugins/os/os_model.rb +0 -29
  75. data/tools/go.rb +14 -20
  76. metadata +32 -17
  77. data/manual/site/mkdocs/js/lunr.min.js +0 -7
  78. data/manual/site/mkdocs/js/mustache.min.js +0 -1
  79. data/manual/site/mkdocs/js/require.js +0 -36
  80. data/manual/site/mkdocs/js/search-results-template.mustache +0 -4
  81. data/manual/site/mkdocs/js/search.js +0 -88
  82. data/manual/site/mkdocs/js/text.js +0 -390
  83. data/manual/site/mkdocs/search_index.json +0 -869
data/manual/site/machinery-export-kiwi.1/index.html CHANGED
@@ -17,35 +17,35 @@
17
17
 
18
18
 
19
19
  <li class="">
20
- <a href="../docs/">Welcome</a>
20
+ <a href="docs/">Welcome</a>
21
21
  </li>
22
22
 
23
23
 
24
24
 
25
25
 
26
26
  <li class="">
27
- <a href="../machinery_main_general.1/">General Overview</a>
27
+ <a href="machinery_main_general.1/">General Overview</a>
28
28
  </li>
29
29
 
30
30
 
31
31
 
32
32
 
33
33
  <li class="">
34
- <a href="../machinery_main_scopes.1/">Scopes</a>
34
+ <a href="machinery_main_scopes.1/">Scopes</a>
35
35
  </li>
36
36
 
37
37
 
38
38
 
39
39
 
40
40
  <li class="">
41
- <a href="../machinery_main_usecases.1/">Use cases</a>
41
+ <a href="machinery_main_usecases.1/">Use cases</a>
42
42
  </li>
43
43
 
44
44
 
45
45
 
46
46
 
47
47
  <li class="">
48
- <a href="../machinery_main_security_implications.1/">Security Implications</a>
48
+ <a href="machinery_main_security_implications.1/">Security Implications</a>
49
49
  </li>
50
50
 
51
51
 
@@ -55,79 +55,79 @@
55
55
  <ul>
56
56
 
57
57
  <li class="">
58
- <a href="../machinery-analyze.1/">Analyze</a>
58
+ <a href="machinery-analyze.1/">Analyze</a>
59
59
  </li>
60
60
 
61
61
  <li class="">
62
- <a href="../machinery-build.1/">Build</a>
62
+ <a href="machinery-build.1/">Build</a>
63
63
  </li>
64
64
 
65
65
  <li class="">
66
- <a href="../machinery-compare.1/">Compare</a>
66
+ <a href="machinery-compare.1/">Compare</a>
67
67
  </li>
68
68
 
69
69
  <li class="">
70
- <a href="../machinery-config.1/">Config</a>
70
+ <a href="machinery-config.1/">Config</a>
71
71
  </li>
72
72
 
73
73
  <li class="">
74
- <a href="../machinery-copy.1/">Copy</a>
74
+ <a href="machinery-copy.1/">Copy</a>
75
75
  </li>
76
76
 
77
77
  <li class="">
78
- <a href="../machinery-deploy.1/">Deploy</a>
78
+ <a href="machinery-deploy.1/">Deploy</a>
79
79
  </li>
80
80
 
81
81
  <li class="">
82
- <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
82
+ <a href="machinery-export-autoyast.1/">Export AutoYaST</a>
83
83
  </li>
84
84
 
85
85
  <li class="current">
86
- <a href="./">Export Kiwi</a>
86
+ <a href="machinery-export-kiwi.1/">Export Kiwi</a>
87
87
  </li>
88
88
 
89
89
  <li class="">
90
- <a href="../machinery-export-html.1/">Export HTML</a>
90
+ <a href="machinery-export-html.1/">Export HTML</a>
91
91
  </li>
92
92
 
93
93
  <li class="">
94
- <a href="../machinery-inspect.1/">Inspect</a>
94
+ <a href="machinery-inspect.1/">Inspect</a>
95
95
  </li>
96
96
 
97
97
  <li class="">
98
- <a href="../machinery-inspect-container.1/">Inspect Container</a>
98
+ <a href="machinery-inspect-container.1/">Inspect Container</a>
99
99
  </li>
100
100
 
101
101
  <li class="">
102
- <a href="../machinery-list.1/">List</a>
102
+ <a href="machinery-list.1/">List</a>
103
103
  </li>
104
104
 
105
105
  <li class="">
106
- <a href="../machinery-man.1/">Man</a>
106
+ <a href="machinery-man.1/">Man</a>
107
107
  </li>
108
108
 
109
109
  <li class="">
110
- <a href="../machinery-move.1/">Move</a>
110
+ <a href="machinery-move.1/">Move</a>
111
111
  </li>
112
112
 
113
113
  <li class="">
114
- <a href="../machinery-remove.1/">Remove</a>
114
+ <a href="machinery-remove.1/">Remove</a>
115
115
  </li>
116
116
 
117
117
  <li class="">
118
- <a href="../machinery-serve.1/">Serve</a>
118
+ <a href="machinery-serve.1/">Serve</a>
119
119
  </li>
120
120
 
121
121
  <li class="">
122
- <a href="../machinery-show.1/">Show</a>
122
+ <a href="machinery-show.1/">Show</a>
123
123
  </li>
124
124
 
125
125
  <li class="">
126
- <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
126
+ <a href="machinery-upgrade-format.1/">Upgrade Format</a>
127
127
  </li>
128
128
 
129
129
  <li class="">
130
- <a href="../machinery-validate.1/">Validate</a>
130
+ <a href="machinery-validate.1/">Validate</a>
131
131
  </li>
132
132
 
133
133
  </ul>
@@ -138,38 +138,7 @@
138
138
  </ul>
139
139
  </div>
140
140
  <div class="content">
141
- <h1 id="export-kiwi-export-system-description-as-kiwi-image-description">export-kiwi — Export System Description as KIWI Image Description</h1>
142
- <h2 id="synopsis">Synopsis</h2>
143
- <p><code>machinery export-kiwi</code> -k | --kiwi-dir=DIRECTORY NAME
144
- --force</p>
145
- <p><code>machinery</code> help export-kiwi</p>
146
- <h2 id="description">Description</h2>
147
- <p>The <code>export-kiwi</code> subcommand exports a stored system description as a KIWI
148
- image description.</p>
149
- <h2 id="arguments">Arguments</h2>
150
- <ul>
151
- <li><code>NAME</code> (required):
152
- Name of the system description.</li>
153
- </ul>
154
- <h2 id="options">Options</h2>
155
- <ul>
156
- <li>
157
- <p><code>-k KIWI_DIR</code>, <code>--kiwi-dir=KIWI_DIR</code> (required):
158
- Write the KIWI image description to a subdirectory at the specified directory. The directory
159
- will be created if it does not exist yet.</p>
160
- </li>
161
- <li>
162
- <p><code>--force</code> (optional):
163
- Overwrite an existing output directory.</p>
164
- </li>
165
- </ul>
166
- <h2 id="examples">Examples</h2>
167
- <ul>
168
- <li>
169
- <p>Export the <code>myhost</code> system description to <code>/tmp/myhost-kiwi</code>:</p>
170
- <p>$ <code>machinery</code> export-kiwi myhost --kiwi-dir=/tmp</p>
171
- </li>
172
- </ul>
141
+
173
142
  </div>
174
143
  </div>
175
144
  </body>
data/manual/site/machinery-inspect-container.1/index.html CHANGED
@@ -17,35 +17,35 @@
17
17
 
18
18
 
19
19
  <li class="">
20
- <a href="../docs/">Welcome</a>
20
+ <a href="docs/">Welcome</a>
21
21
  </li>
22
22
 
23
23
 
24
24
 
25
25
 
26
26
  <li class="">
27
- <a href="../machinery_main_general.1/">General Overview</a>
27
+ <a href="machinery_main_general.1/">General Overview</a>
28
28
  </li>
29
29
 
30
30
 
31
31
 
32
32
 
33
33
  <li class="">
34
- <a href="../machinery_main_scopes.1/">Scopes</a>
34
+ <a href="machinery_main_scopes.1/">Scopes</a>
35
35
  </li>
36
36
 
37
37
 
38
38
 
39
39
 
40
40
  <li class="">
41
- <a href="../machinery_main_usecases.1/">Use cases</a>
41
+ <a href="machinery_main_usecases.1/">Use cases</a>
42
42
  </li>
43
43
 
44
44
 
45
45
 
46
46
 
47
47
  <li class="">
48
- <a href="../machinery_main_security_implications.1/">Security Implications</a>
48
+ <a href="machinery_main_security_implications.1/">Security Implications</a>
49
49
  </li>
50
50
 
51
51
 
@@ -55,79 +55,79 @@
55
55
  <ul>
56
56
 
57
57
  <li class="">
58
- <a href="../machinery-analyze.1/">Analyze</a>
58
+ <a href="machinery-analyze.1/">Analyze</a>
59
59
  </li>
60
60
 
61
61
  <li class="">
62
- <a href="../machinery-build.1/">Build</a>
62
+ <a href="machinery-build.1/">Build</a>
63
63
  </li>
64
64
 
65
65
  <li class="">
66
- <a href="../machinery-compare.1/">Compare</a>
66
+ <a href="machinery-compare.1/">Compare</a>
67
67
  </li>
68
68
 
69
69
  <li class="">
70
- <a href="../machinery-config.1/">Config</a>
70
+ <a href="machinery-config.1/">Config</a>
71
71
  </li>
72
72
 
73
73
  <li class="">
74
- <a href="../machinery-copy.1/">Copy</a>
74
+ <a href="machinery-copy.1/">Copy</a>
75
75
  </li>
76
76
 
77
77
  <li class="">
78
- <a href="../machinery-deploy.1/">Deploy</a>
78
+ <a href="machinery-deploy.1/">Deploy</a>
79
79
  </li>
80
80
 
81
81
  <li class="">
82
- <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
82
+ <a href="machinery-export-autoyast.1/">Export AutoYaST</a>
83
83
  </li>
84
84
 
85
85
  <li class="">
86
- <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
86
+ <a href="machinery-export-kiwi.1/">Export Kiwi</a>
87
87
  </li>
88
88
 
89
89
  <li class="">
90
- <a href="../machinery-export-html.1/">Export HTML</a>
90
+ <a href="machinery-export-html.1/">Export HTML</a>
91
91
  </li>
92
92
 
93
93
  <li class="">
94
- <a href="../machinery-inspect.1/">Inspect</a>
94
+ <a href="machinery-inspect.1/">Inspect</a>
95
95
  </li>
96
96
 
97
97
  <li class="current">
98
- <a href="./">Inspect Container</a>
98
+ <a href="machinery-inspect-container.1/">Inspect Container</a>
99
99
  </li>
100
100
 
101
101
  <li class="">
102
- <a href="../machinery-list.1/">List</a>
102
+ <a href="machinery-list.1/">List</a>
103
103
  </li>
104
104
 
105
105
  <li class="">
106
- <a href="../machinery-man.1/">Man</a>
106
+ <a href="machinery-man.1/">Man</a>
107
107
  </li>
108
108
 
109
109
  <li class="">
110
- <a href="../machinery-move.1/">Move</a>
110
+ <a href="machinery-move.1/">Move</a>
111
111
  </li>
112
112
 
113
113
  <li class="">
114
- <a href="../machinery-remove.1/">Remove</a>
114
+ <a href="machinery-remove.1/">Remove</a>
115
115
  </li>
116
116
 
117
117
  <li class="">
118
- <a href="../machinery-serve.1/">Serve</a>
118
+ <a href="machinery-serve.1/">Serve</a>
119
119
  </li>
120
120
 
121
121
  <li class="">
122
- <a href="../machinery-show.1/">Show</a>
122
+ <a href="machinery-show.1/">Show</a>
123
123
  </li>
124
124
 
125
125
  <li class="">
126
- <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
126
+ <a href="machinery-upgrade-format.1/">Upgrade Format</a>
127
127
  </li>
128
128
 
129
129
  <li class="">
130
- <a href="../machinery-validate.1/">Validate</a>
130
+ <a href="machinery-validate.1/">Validate</a>
131
131
  </li>
132
132
 
133
133
  </ul>
@@ -138,111 +138,7 @@
138
138
  </ul>
139
139
  </div>
140
140
  <div class="content">
141
- <h1 id="inspect-container-inspect-container">inspect-container — Inspect Container</h1>
142
- <h2 id="synopsis">Synopsis</h2>
143
- <p><code>machinery inspect-container</code> [OPTIONS] IMAGENAME</p>
144
- <p><code>machinery inspect-container</code> [OPTIONS] IMAGEID</p>
145
- <p><code>machinery</code> help inspect-container</p>
146
- <h2 id="description">Description</h2>
147
- <p>The <code>inspect-container</code> command inspects a container image. It creates and starts the container from the provided image before inspection
148
- and generates a system description from the gathered data. After the inspection the container will be killed and removed again.
149
- This approach ensures that no containers and images are affected by the inspection.</p>
150
- <p>Right now the container inspection only supports Docker images.</p>
151
- <p>The system data is structured into scopes, controlled by the
152
- <code>--scope</code> option.</p>
153
- <p><strong>Note</strong>:
154
- Machinery will always inspect all specified scopes, and skip scopes which
155
- trigger errors.</p>
156
- <h2 id="arguments">Arguments</h2>
157
- <ul>
158
- <li><code>IMAGENAME / IMAGEID</code> (required):
159
- The name or ID of the image to be inspected. The provided name or ID will also be
160
- used as the name of the stored system description unless another name is
161
- provided with the <code>--name</code> option.</li>
162
- </ul>
163
- <h2 id="options">Options</h2>
164
- <ul>
165
- <li>
166
- <p><code>-n NAME</code>, <code>--name=NAME</code> (optional):
167
- Store the system description under the specified name.</p>
168
- </li>
169
- <li>
170
- <p><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional):
171
- Inspect image for specified scope.
172
- See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
173
- </li>
174
- <li>
175
- <p><code>-e SCOPE</code>, <code>--ignore-scope=IGNORE-SCOPE</code> (optional):
176
- Inspect image for all scopes except the specified scope.
177
- See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
178
- </li>
179
- <li>
180
- <p><code>-x</code>, <code>--extract-files</code> (optional):
181
- Extract changed configuration and unmanaged files from the inspected container.
182
- Shortcut for the combination of <code>--extract-changed-config-files</code>,
183
- <code>--extract-unmanaged-files</code>, and <code>--extract-changed-managed-files</code></p>
184
- </li>
185
- <li>
186
- <p><code>--extract-changed-config-files</code> (optional):
187
- Extract changed configuration files from the inspected image.</p>
188
- </li>
189
- <li>
190
- <p><code>--extract-unmanaged-files</code> (optional):
191
- Extract unmanaged files from the inspected image.</p>
192
- </li>
193
- <li>
194
- <p><code>--extract-changed-managed-files</code> (optional):
195
- Extract changed managed files from inspected image.</p>
196
- </li>
197
- <li>
198
- <p><code>--skip-files</code> (optional):
199
- Do not consider given files or directories during inspection. Either provide
200
- one file or directory name or a list of names separated by commas. You can
201
- also point to a file which contains a list of files to filter (one per line)
202
- by adding an '@' before the path, e.g.</p>
203
- <p>$ <code>machinery</code> inspect-container --skip-files=@/path/to/filter_file myimage</p>
204
- <p>If a filename contains a comma it needs to be escaped, e.g.</p>
205
- <p>$ <code>machinery</code> inspect-container --skip-files=/file\,with_comma myimage</p>
206
- <p><strong>Note</strong>: File or directory names are not expanded, e.g. '../path' is taken
207
- literally and not expanded.</p>
208
- </li>
209
- <li>
210
- <p><code>--verbose</code> (optional):
211
- Display the filters which are used during inspection.</p>
212
- </li>
213
- </ul>
214
- <h2 id="prerequisites">Prerequisites</h2>
215
- <ul>
216
- <li>
217
- <p>Inspecting a container requires an image specified by the name or ID.</p>
218
- </li>
219
- <li>
220
- <p>The image to be inspected needs to have the following commands:</p>
221
- <ul>
222
- <li><code>rpm</code> or <code>dpkg</code></li>
223
- <li><code>zypper</code>, <code>yum</code> or <code>apt-cache</code></li>
224
- <li><code>rsync</code></li>
225
- <li><code>cat</code></li>
226
- <li><code>sed</code></li>
227
- <li><code>find</code></li>
228
- </ul>
229
- </li>
230
- </ul>
231
- <h2 id="examples">Examples</h2>
232
- <ul>
233
- <li>
234
- <p>Inspect Docker container <code>myimage</code> and save system description under name 'MyContainer':</p>
235
- <p>$ <code>machinery</code> inspect-container --name=MyContainer myimage</p>
236
- </li>
237
- <li>
238
- <p>Inspect Docker container <code>076f46c1bef1</code> and save system description under name 'MySecondContainer':</p>
239
- <p>$ <code>machinery</code> inspect-container --name=MySecondContainer 076f46c1bef1</p>
240
- </li>
241
- <li>
242
- <p>Extract changed managed files and save them:</p>
243
- <p>$ <code>machinery</code> inspect-container --scope=changed-managed-files --extract-files myimage</p>
244
- </li>
245
- </ul>
141
+
246
142
  </div>
247
143
  </div>
248
144
  </body>
data/manual/site/machinery-inspect.1/index.html CHANGED
@@ -17,35 +17,35 @@
17
17
 
18
18
 
19
19
  <li class="">
20
- <a href="../docs/">Welcome</a>
20
+ <a href="docs/">Welcome</a>
21
21
  </li>
22
22
 
23
23
 
24
24
 
25
25
 
26
26
  <li class="">
27
- <a href="../machinery_main_general.1/">General Overview</a>
27
+ <a href="machinery_main_general.1/">General Overview</a>
28
28
  </li>
29
29
 
30
30
 
31
31
 
32
32
 
33
33
  <li class="">
34
- <a href="../machinery_main_scopes.1/">Scopes</a>
34
+ <a href="machinery_main_scopes.1/">Scopes</a>
35
35
  </li>
36
36
 
37
37
 
38
38
 
39
39
 
40
40
  <li class="">
41
- <a href="../machinery_main_usecases.1/">Use cases</a>
41
+ <a href="machinery_main_usecases.1/">Use cases</a>
42
42
  </li>
43
43
 
44
44
 
45
45
 
46
46
 
47
47
  <li class="">
48
- <a href="../machinery_main_security_implications.1/">Security Implications</a>
48
+ <a href="machinery_main_security_implications.1/">Security Implications</a>
49
49
  </li>
50
50
 
51
51
 
@@ -55,79 +55,79 @@
55
55
  <ul>
56
56
 
57
57
  <li class="">
58
- <a href="../machinery-analyze.1/">Analyze</a>
58
+ <a href="machinery-analyze.1/">Analyze</a>
59
59
  </li>
60
60
 
61
61
  <li class="">
62
- <a href="../machinery-build.1/">Build</a>
62
+ <a href="machinery-build.1/">Build</a>
63
63
  </li>
64
64
 
65
65
  <li class="">
66
- <a href="../machinery-compare.1/">Compare</a>
66
+ <a href="machinery-compare.1/">Compare</a>
67
67
  </li>
68
68
 
69
69
  <li class="">
70
- <a href="../machinery-config.1/">Config</a>
70
+ <a href="machinery-config.1/">Config</a>
71
71
  </li>
72
72
 
73
73
  <li class="">
74
- <a href="../machinery-copy.1/">Copy</a>
74
+ <a href="machinery-copy.1/">Copy</a>
75
75
  </li>
76
76
 
77
77
  <li class="">
78
- <a href="../machinery-deploy.1/">Deploy</a>
78
+ <a href="machinery-deploy.1/">Deploy</a>
79
79
  </li>
80
80
 
81
81
  <li class="">
82
- <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
82
+ <a href="machinery-export-autoyast.1/">Export AutoYaST</a>
83
83
  </li>
84
84
 
85
85
  <li class="">
86
- <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
86
+ <a href="machinery-export-kiwi.1/">Export Kiwi</a>
87
87
  </li>
88
88
 
89
89
  <li class="">
90
- <a href="../machinery-export-html.1/">Export HTML</a>
90
+ <a href="machinery-export-html.1/">Export HTML</a>
91
91
  </li>
92
92
 
93
93
  <li class="current">
94
- <a href="./">Inspect</a>
94
+ <a href="machinery-inspect.1/">Inspect</a>
95
95
  </li>
96
96
 
97
97
  <li class="">
98
- <a href="../machinery-inspect-container.1/">Inspect Container</a>
98
+ <a href="machinery-inspect-container.1/">Inspect Container</a>
99
99
  </li>
100
100
 
101
101
  <li class="">
102
- <a href="../machinery-list.1/">List</a>
102
+ <a href="machinery-list.1/">List</a>
103
103
  </li>
104
104
 
105
105
  <li class="">
106
- <a href="../machinery-man.1/">Man</a>
106
+ <a href="machinery-man.1/">Man</a>
107
107
  </li>
108
108
 
109
109
  <li class="">
110
- <a href="../machinery-move.1/">Move</a>
110
+ <a href="machinery-move.1/">Move</a>
111
111
  </li>
112
112
 
113
113
  <li class="">
114
- <a href="../machinery-remove.1/">Remove</a>
114
+ <a href="machinery-remove.1/">Remove</a>
115
115
  </li>
116
116
 
117
117
  <li class="">
118
- <a href="../machinery-serve.1/">Serve</a>
118
+ <a href="machinery-serve.1/">Serve</a>
119
119
  </li>
120
120
 
121
121
  <li class="">
122
- <a href="../machinery-show.1/">Show</a>
122
+ <a href="machinery-show.1/">Show</a>
123
123
  </li>
124
124
 
125
125
  <li class="">
126
- <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
126
+ <a href="machinery-upgrade-format.1/">Upgrade Format</a>
127
127
  </li>
128
128
 
129
129
  <li class="">
130
- <a href="../machinery-validate.1/">Validate</a>
130
+ <a href="machinery-validate.1/">Validate</a>
131
131
  </li>
132
132
 
133
133
  </ul>
@@ -138,154 +138,7 @@
138
138
  </ul>
139
139
  </div>
140
140
  <div class="content">
141
- <h1 id="inspect-inspect-running-system">inspect — Inspect Running System</h1>
142
- <h2 id="synopsis">Synopsis</h2>
143
- <p><code>machinery inspect</code> [OPTIONS] HOSTNAME</p>
144
- <p><code>machinery</code> help inspect</p>
145
- <h2 id="description">Description</h2>
146
- <p>The <code>inspect</code> command inspects a running system and generates a system
147
- description from the gathered data.</p>
148
- <p>The system data is structured into scopes, controlled by the
149
- <code>--scope</code> option.</p>
150
- <p><strong>Note</strong>:
151
- Machinery will always inspect all specified scopes, and skip scopes which
152
- trigger errors.</p>
153
- <p><strong>Note</strong>:
154
- Tasks on Debian-like systems are treated as patterns.</p>
155
- <h2 id="arguments">Arguments</h2>
156
- <ul>
157
- <li><code>HOSTNAME</code> (required):
158
- The host name of the system to be inspected. The host name will also be
159
- used as the name of the stored system description unless another name is
160
- provided with the <code>--name</code> option.</li>
161
- </ul>
162
- <h2 id="options">Options</h2>
163
- <ul>
164
- <li>
165
- <p><code>-n NAME</code>, <code>--name=NAME</code> (optional):
166
- Store the system description under the specified name.</p>
167
- </li>
168
- <li>
169
- <p><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional):
170
- Inspect system for specified scope.
171
- See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
172
- </li>
173
- <li>
174
- <p><code>-e SCOPE</code>, <code>--ignore-scope=IGNORE-SCOPE</code> (optional):
175
- Inspect system for all scopes except the specified scope.
176
- See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
177
- </li>
178
- <li>
179
- <p><code>-r USER</code>, <code>--remote-user=USER</code> (optional):
180
- Defines the user which is used to access the inspected system via SSH.
181
- This user needs to be allowed to run certain commands using sudo (see
182
- Prerequisites for more information).
183
- To change the default-user use <code>machinery config remote-user=USER</code></p>
184
- </li>
185
- <li>
186
- <p><code>-p SSH-PORT</code>, <code>--ssh-port SSH-PORT</code> (optional):
187
- Specifies the SSH port of the remote SSH server.</p>
188
- </li>
189
- <li>
190
- <p><code>-i SSH-IDENTITY-FILE</code>, <code>--ssh-identity-file SSH-IDENTITY-FILE</code> (optional):
191
- Specifies the SSH private key what should be used to authenticate with the
192
- remote SSH server. Keys with a passphrase are not allowed here. Use the ssh-agent
193
- instead.</p>
194
- </li>
195
- <li>
196
- <p><code>-x</code>, <code>--extract-files</code> (optional):
197
- Extract changed configuration and unmanaged files from the inspected system.
198
- Shortcut for the combination of <code>--extract-changed-config-files</code>,
199
- <code>--extract-unmanaged-files</code>, and <code>--extract-changed-managed-files</code></p>
200
- </li>
201
- <li>
202
- <p><code>--extract-changed-config-files</code> (optional):
203
- Extract changed configuration files from the inspected system.</p>
204
- </li>
205
- <li>
206
- <p><code>--extract-unmanaged-files</code> (optional):
207
- Extract unmanaged files from the inspected system.</p>
208
- </li>
209
- <li>
210
- <p><code>--extract-changed-managed-files</code> (optional):
211
- Extract changed managed files from inspected system.</p>
212
- </li>
213
- <li>
214
- <p><code>--skip-files</code> (optional):
215
- Do not consider given files or directories during inspection. Either provide
216
- one file or directory name or a list of names separated by commas. You can
217
- also point to a file which contains a list of files to filter (one per line)
218
- by adding an '@' before the path, e.g.</p>
219
- <p>$ <code>machinery</code> inspect --skip-files=@/path/to/filter_file myhost</p>
220
- <p>If a filename contains a comma it needs to be escaped, e.g.</p>
221
- <p>$ <code>machinery</code> inspect --skip-files=/file\,with_comma myhost</p>
222
- <p><strong>Note</strong>: File or directory names are not expanded, e.g. '../path' is taken
223
- literally and not expanded.</p>
224
- </li>
225
- <li>
226
- <p><code>--verbose</code> (optional):
227
- Display the filters which are used during inspection.</p>
228
- </li>
229
- </ul>
230
- <h2 id="prerequisites">Prerequisites</h2>
231
- <ul>
232
- <li>
233
- <p>Inspecting a local system requires running <code>machinery</code> as root.</p>
234
- </li>
235
- <li>
236
- <p>Inspecting a remote system requires passwordless SSH login as root on the
237
- inspected system.
238
- Use <code>ssh-agent</code> or asymmetric keys (you can transfer the current SSH key
239
- via <code>ssh-copy-id</code> to the inspected host, e.g.: <code>ssh-copy-id root@HOSTNAME</code>).</p>
240
- </li>
241
- <li>
242
- <p>The system to be inspected needs to have the following commands:</p>
243
- <ul>
244
- <li><code>rpm</code> or <code>dpkg</code></li>
245
- <li><code>zypper</code>, <code>yum</code>, or <code>apt-cache</code></li>
246
- <li><code>rsync</code></li>
247
- <li><code>chkconfig</code>, <code>initctl</code>, or <code>systemctl</code></li>
248
- <li><code>cat</code></li>
249
- <li><code>sed</code></li>
250
- <li><code>find</code></li>
251
- <li><code>tar</code></li>
252
- </ul>
253
- </li>
254
- <li>
255
- <p>When inspecting as non-root the user needs passwordless sudo rights.
256
- The following entry in the sudoers file would allow the user <code>machinery</code>
257
- to run sudo without password input:</p>
258
- <p>machinery ALL=(ALL) NOPASSWD: ALL</p>
259
- </li>
260
- <li>
261
- <p>To add a remote <code>machinery</code> user run as root:</p>
262
- <p># <code>useradd</code> -m machinery -c "remote user for machinery"</p>
263
- <p>To configure a password for the new user run:</p>
264
- <p># <code>passwd</code> machinery</p>
265
- </li>
266
- </ul>
267
- <h2 id="examples">Examples</h2>
268
- <ul>
269
- <li>
270
- <p>Inspect remote system <code>myhost</code> and save system description under name
271
- 'MySystem':</p>
272
- <p>$ <code>machinery</code> inspect --name=MySystem myhost</p>
273
- </li>
274
- <li>
275
- <p>Inspect the installed packages of your local system and save system description
276
- under the name 'localhost' (you need to become root):</p>
277
- <p># <code>machinery</code> inspect --scope="packages" localhost</p>
278
- </li>
279
- <li>
280
- <p>Extracts changed managed files and saves them in the same way as changed
281
- configuration files are saved:</p>
282
- <p>$ <code>machinery</code> inspect --scope=changed-managed-files --extract-files myhost</p>
283
- </li>
284
- <li>
285
- <p>To inspect the remote system <code>myhost</code> with the user <code>machinery</code>:</p>
286
- <p>$ <code>machinery</code> inspect --remote-user machinery myhost</p>
287
- </li>
288
- </ul>
141
+
289
142
  </div>
290
143
  </div>
291
144
  </body>