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.
- checksums.yaml +4 -4
- data/.git_revision +1 -1
- data/NEWS +8 -0
- data/html/index.html.haml +8 -7
- data/html/partials/changed_config_files.html.haml +1 -1
- data/html/partials/changed_managed_files.html.haml +1 -1
- data/html/partials/unmanaged_files.html.haml +2 -2
- data/lib/cli.rb +26 -4
- data/lib/diff_widget.rb +73 -0
- data/lib/dpkg_database.rb +16 -1
- data/lib/haml_helpers.rb +60 -0
- data/lib/kiwi_config.rb +7 -0
- data/lib/machinery.rb +3 -0
- data/lib/man_task.rb +3 -2
- data/lib/move_task.rb +1 -0
- data/lib/remote_system.rb +4 -0
- data/lib/server.rb +2 -105
- data/lib/static_html.rb +75 -0
- data/lib/system.rb +2 -1
- data/lib/system_description.rb +10 -0
- data/lib/version.rb +1 -1
- data/machinery-helper/version.go +1 -1
- data/man/generated/machinery.1.gz +0 -0
- data/manual/docs/README.md +8 -16
- data/manual/docs/docs.md +42 -4
- data/manual/docs/index.html +6 -2
- data/manual/docs/machinery-analyze.1.md +6 -10
- data/manual/docs/machinery-build.1.md +7 -11
- data/manual/docs/machinery-compare.1.md +5 -10
- data/manual/docs/machinery-config.1.md +4 -7
- data/manual/docs/machinery-copy.1.md +5 -10
- data/manual/docs/machinery-deploy.1.md +8 -12
- data/manual/docs/machinery-export-autoyast.1.md +10 -17
- data/manual/docs/machinery-export-html.1.md +32 -0
- data/manual/docs/machinery-export-kiwi.1.md +7 -12
- data/manual/docs/{machinery-inspect-docker.1.md → machinery-inspect-container.1.md} +10 -15
- data/manual/docs/machinery-inspect.1.md +10 -15
- data/manual/docs/machinery-list.1.md +4 -8
- data/manual/docs/machinery-man.1.md +4 -6
- data/manual/docs/machinery-move.1.md +4 -8
- data/manual/docs/machinery-remove.1.md +5 -10
- data/manual/docs/machinery-serve.1.md +5 -9
- data/manual/docs/machinery-show.1.md +7 -11
- data/manual/docs/machinery-upgrade-format.1.md +5 -9
- data/manual/docs/machinery-validate.1.md +4 -8
- data/manual/docs/machinery_main_general.1.md +33 -51
- data/manual/docs/machinery_main_scopes.1.md +13 -14
- data/manual/docs/{machinery_security_implications.1.md → machinery_main_security_implications.1.md} +15 -15
- data/manual/docs/machinery_main_usecases.1.md +2 -30
- data/manual/mkdocs.yml +9 -9
- data/manual/site/docs/index.html +71 -25
- data/manual/site/index.html +6 -2
- data/manual/site/machinery-analyze.1/index.html +34 -27
- data/manual/site/machinery-build.1/index.html +35 -28
- data/manual/site/machinery-compare.1/index.html +33 -26
- data/manual/site/machinery-config.1/index.html +32 -25
- data/manual/site/machinery-copy.1/index.html +33 -27
- data/manual/site/machinery-deploy.1/index.html +36 -29
- data/manual/site/machinery-export-autoyast.1/index.html +38 -32
- data/manual/site/machinery-export-html.1/index.html +175 -0
- data/manual/site/machinery-export-kiwi.1/index.html +35 -28
- data/manual/site/machinery-inspect-container.1/index.html +249 -0
- data/manual/site/machinery-inspect.1/index.html +38 -31
- data/manual/site/machinery-list.1/index.html +32 -25
- data/manual/site/machinery-man.1/index.html +32 -26
- data/manual/site/machinery-move.1/index.html +32 -25
- data/manual/site/machinery-remove.1/index.html +33 -26
- data/manual/site/machinery-serve.1/index.html +33 -26
- data/manual/site/machinery-show.1/index.html +35 -28
- data/manual/site/machinery-upgrade-format.1/index.html +33 -26
- data/manual/site/machinery-validate.1/index.html +32 -25
- data/manual/site/machinery_main_general.1/index.html +63 -70
- data/manual/site/machinery_main_scopes.1/index.html +41 -36
- data/manual/site/machinery_main_security_implications.1/index.html +228 -0
- data/manual/site/machinery_main_usecases.1/index.html +30 -48
- data/manual/site/mkdocs/search_index.json +246 -201
- data/manual/site/sitemap.xml +40 -30
- data/plugins/os/os_inspector.rb +1 -1
- data/plugins/packages/packages.yml +1 -1
- data/plugins/patterns/patterns.yml +2 -5
- data/plugins/repositories/repositories.yml +2 -2
- data/plugins/unmanaged_files/unmanaged_files.yml +3 -3
- data/plugins/unmanaged_files/unmanaged_files_renderer.rb +1 -1
- metadata +11 -5
- data/manual/docs/subcommand-template.1.md +0 -46
|
@@ -23,26 +23,29 @@
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
26
|
-
<li>
|
|
27
|
-
<
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
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-
|
|
98
|
+
<a href="../machinery-inspect-container.1/">Inspect Container</a>
|
|
92
99
|
</li>
|
|
93
100
|
|
|
94
101
|
<li class="">
|
|
@@ -131,11 +138,11 @@
|
|
|
131
138
|
</ul>
|
|
132
139
|
</div>
|
|
133
140
|
<div class="content">
|
|
134
|
-
<h1 id="serve-serve-system-descriptions-using-a-web-server">serve — Serve System Descriptions Using
|
|
135
|
-
<h2 id="synopsis">
|
|
141
|
+
<h1 id="serve-serve-system-descriptions-using-a-web-server">serve — Serve System Descriptions Using a Web Server</h1>
|
|
142
|
+
<h2 id="synopsis">Synopsis</h2>
|
|
136
143
|
<p><code>machinery serve</code> [-p PORT | --port=PORT] [--public]</p>
|
|
137
144
|
<p><code>machinery</code> help serve</p>
|
|
138
|
-
<h2 id="description">
|
|
145
|
+
<h2 id="description">Description</h2>
|
|
139
146
|
<p>The <code>serve</code> command spawns a web server to view system descriptions as an HTML
|
|
140
147
|
view.</p>
|
|
141
148
|
<p>By default the server is available from http://127.0.0.1:7585 but both the
|
|
@@ -143,7 +150,7 @@ IP address and the port can be configured using the according options.</p>
|
|
|
143
150
|
<p>Specific descriptions are available from http://127.0.0.1:7585/NAME, where NAME
|
|
144
151
|
is the name of the system description. If no name is specified in the URL an
|
|
145
152
|
overview of all descriptions is served.</p>
|
|
146
|
-
<h2 id="options">
|
|
153
|
+
<h2 id="options">Options</h2>
|
|
147
154
|
<ul>
|
|
148
155
|
<li>
|
|
149
156
|
<p><code>-p PORT</code>, <code>--port=PORT</code> (optional):
|
|
@@ -157,7 +164,7 @@ chosen when <code>machinery</code> will be executed as <code>root</code> user.</
|
|
|
157
164
|
the server will only listen on the localhost IP address 127.0.0.1</p>
|
|
158
165
|
</li>
|
|
159
166
|
</ul>
|
|
160
|
-
<h2 id="examples">
|
|
167
|
+
<h2 id="examples">Examples</h2>
|
|
161
168
|
<ul>
|
|
162
169
|
<li>
|
|
163
170
|
<p>Start the server with default options:</p>
|
|
@@ -23,26 +23,29 @@
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
26
|
-
<li>
|
|
27
|
-
<
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
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-
|
|
98
|
+
<a href="../machinery-inspect-container.1/">Inspect Container</a>
|
|
92
99
|
</li>
|
|
93
100
|
|
|
94
101
|
<li class="">
|
|
@@ -132,32 +139,32 @@
|
|
|
132
139
|
</div>
|
|
133
140
|
<div class="content">
|
|
134
141
|
<h1 id="show-show-system-description">show — Show System Description</h1>
|
|
135
|
-
<h2 id="synopsis">
|
|
142
|
+
<h2 id="synopsis">Synopsis</h2>
|
|
136
143
|
<p><code>machinery show</code> [-s SCOPE | --scope=SCOPE] [-e IGNORE-SCOPE | --ignore-scope=IGNORE-SCOPE] [--no-pager] [--show-diffs] [--html] NAME</p>
|
|
137
144
|
<p><code>machinery</code> help show</p>
|
|
138
|
-
<h2 id="description">
|
|
145
|
+
<h2 id="description">Description</h2>
|
|
139
146
|
<p>The <code>show</code> command displays a stored system description.
|
|
140
147
|
Scopes are supported and limit the output to the given scope.
|
|
141
148
|
The hostname of the inspected system and the last modification
|
|
142
149
|
in local time are shown in the title of each scope section.</p>
|
|
143
|
-
<h2 id="arguments">
|
|
150
|
+
<h2 id="arguments">Arguments</h2>
|
|
144
151
|
<ul>
|
|
145
152
|
<li><code>NAME</code> (required):
|
|
146
153
|
Use specified system description.</li>
|
|
147
154
|
</ul>
|
|
148
|
-
<h2 id="options">
|
|
155
|
+
<h2 id="options">Options</h2>
|
|
149
156
|
<ul>
|
|
150
157
|
<li>
|
|
151
158
|
<p><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional):
|
|
152
159
|
Limit output to the specified scope.
|
|
153
|
-
See the <a href="
|
|
160
|
+
See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.
|
|
154
161
|
If displaying information related to a scope fails, <code>show</code> will print an error message what has failed.
|
|
155
162
|
In case of an error, no content is displayed.</p>
|
|
156
163
|
</li>
|
|
157
164
|
<li>
|
|
158
165
|
<p><code>-e IGNORE-SCOPE</code>, <code>--ignore-scope=IGNORE-SCOPE</code> (optional):
|
|
159
166
|
Skip output of the specified scope.
|
|
160
|
-
See the <a href="
|
|
167
|
+
See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
|
|
161
168
|
</li>
|
|
162
169
|
<li>
|
|
163
170
|
<p><code>--no-pager</code> (optional):
|
|
@@ -178,7 +185,7 @@ in local time are shown in the title of each scope section.</p>
|
|
|
178
185
|
Display the filters which were applied before showing the system description.</p>
|
|
179
186
|
</li>
|
|
180
187
|
</ul>
|
|
181
|
-
<h2 id="examples">
|
|
188
|
+
<h2 id="examples">Examples</h2>
|
|
182
189
|
<ul>
|
|
183
190
|
<li>
|
|
184
191
|
<p>Show the system description taken from the last inspection, saved as <code>earth</code>:</p>
|
|
@@ -23,26 +23,29 @@
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
26
|
-
<li>
|
|
27
|
-
<
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
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-
|
|
98
|
+
<a href="../machinery-inspect-container.1/">Inspect Container</a>
|
|
92
99
|
</li>
|
|
93
100
|
|
|
94
101
|
<li class="">
|
|
@@ -132,11 +139,11 @@
|
|
|
132
139
|
</div>
|
|
133
140
|
<div class="content">
|
|
134
141
|
<h1 id="upgrade-format-upgrade-system-description">upgrade-format — Upgrade System Description</h1>
|
|
135
|
-
<h2 id="synopsis">
|
|
142
|
+
<h2 id="synopsis">Synopsis</h2>
|
|
136
143
|
<p><code>machinery upgrade-format</code> --all</p>
|
|
137
144
|
<p><code>machinery upgrade-format</code> NAME</p>
|
|
138
145
|
<p><code>machinery</code> help upgrade-format</p>
|
|
139
|
-
<h2 id="description">
|
|
146
|
+
<h2 id="description">Description</h2>
|
|
140
147
|
<p>The <code>upgrade-format</code> command upgrades a system description to the latest format
|
|
141
148
|
version.</p>
|
|
142
149
|
<p>The <code>format</code> in this context is the structure of the internal system description
|
|
@@ -146,17 +153,17 @@ until it is upgraded. The current format version can be retrieved using
|
|
|
146
153
|
<code>machinery --version</code>. The format version of a system description can be found
|
|
147
154
|
in the <code>meta</code> section of the according <code>manifest.json</code> file.</p>
|
|
148
155
|
<p>If the <code>--all</code> switch is given all local descriptions will be upgraded.</p>
|
|
149
|
-
<h2 id="options">
|
|
156
|
+
<h2 id="options">Options</h2>
|
|
150
157
|
<ul>
|
|
151
158
|
<li><code>--all</code> (optional):
|
|
152
159
|
Upgrade all stored system descriptions.</li>
|
|
153
160
|
</ul>
|
|
154
|
-
<h2 id="arguments">
|
|
161
|
+
<h2 id="arguments">Arguments</h2>
|
|
155
162
|
<ul>
|
|
156
163
|
<li><code>NAME</code> (optional):
|
|
157
164
|
Upgrade specified system description.</li>
|
|
158
165
|
</ul>
|
|
159
|
-
<h2 id="examples">
|
|
166
|
+
<h2 id="examples">Examples</h2>
|
|
160
167
|
<ul>
|
|
161
168
|
<li>
|
|
162
169
|
<p>Upgrade the system description stored as <code>earth</code>:</p>
|
|
@@ -23,26 +23,29 @@
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
26
|
-
<li>
|
|
27
|
-
<
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
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-
|
|
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="validate-validate-system-description">validate — Validate System Description</h1>
|
|
135
|
-
<h2 id="synopsis">
|
|
142
|
+
<h2 id="synopsis">Synopsis</h2>
|
|
136
143
|
<p><code>machinery validate</code> NAME</p>
|
|
137
144
|
<p><code>machinery</code> help validate</p>
|
|
138
|
-
<h2 id="description">
|
|
145
|
+
<h2 id="description">Description</h2>
|
|
139
146
|
<p>The <code>validate</code> subcommand validates an existing system description.
|
|
140
147
|
It checks, that the description has the correct structure and the data stored
|
|
141
148
|
there conforms to the required schema. It also verifies that all extracted files
|
|
@@ -143,12 +150,12 @@ are present on disk and that all files have meta information.</p>
|
|
|
143
150
|
<p>In case of issues errors are shown with additional information.</p>
|
|
144
151
|
<p>The main purpose of this command is to verify the system description after
|
|
145
152
|
manually editing it.</p>
|
|
146
|
-
<h2 id="arguments">
|
|
153
|
+
<h2 id="arguments">Arguments</h2>
|
|
147
154
|
<ul>
|
|
148
155
|
<li><code>NAME</code> (required):
|
|
149
156
|
Name of the system description.</li>
|
|
150
157
|
</ul>
|
|
151
|
-
<h2 id="examples">
|
|
158
|
+
<h2 id="examples">Examples</h2>
|
|
152
159
|
<ul>
|
|
153
160
|
<li>
|
|
154
161
|
<p>Validate the system description with the name <code>myhost</code>:</p>
|
|
@@ -23,26 +23,29 @@
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
26
|
-
<li>
|
|
27
|
-
<
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
26
|
+
<li class="current">
|
|
27
|
+
<a href="./">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-
|
|
98
|
+
<a href="../machinery-inspect-container.1/">Inspect Container</a>
|
|
92
99
|
</li>
|
|
93
100
|
|
|
94
101
|
<li class="">
|
|
@@ -132,49 +139,10 @@
|
|
|
132
139
|
</div>
|
|
133
140
|
<div class="content">
|
|
134
141
|
<h1 id="machinery-a-systems-management-toolkit-for-linux">Machinery — A Systems Management Toolkit for Linux</h1>
|
|
135
|
-
<h1 id="synopsis">
|
|
142
|
+
<h1 id="synopsis">Synopsis</h1>
|
|
136
143
|
<p><code>machinery</code> SUBCOMMAND [options] <br>
|
|
137
144
|
<code>machinery</code> help [SUBCOMMAND]</p>
|
|
138
|
-
<h1 id="
|
|
139
|
-
<p>Machinery is a systems management toolkit for Linux. It supports configuration
|
|
140
|
-
discovery, system validation, and service migration. Machinery is based on the
|
|
141
|
-
idea of an universal system description. Machinery has a set of commands which
|
|
142
|
-
work with this system description. These commands can be combined to form work
|
|
143
|
-
flows. Machinery is targeted at the system administrator of the data center.</p>
|
|
144
|
-
<h1 id="work-flow-examples">WORK FLOW EXAMPLES</h1>
|
|
145
|
-
<h2 id="inspect-a-system-and-show-results">Inspect a System and Show Results</h2>
|
|
146
|
-
<ul>
|
|
147
|
-
<li><code>machinery inspect --extract-files --name=NAME HOSTNAME</code></li>
|
|
148
|
-
<li><code>machinery show NAME</code></li>
|
|
149
|
-
</ul>
|
|
150
|
-
<h2 id="inspect-two-systems-and-compare-them">Inspect Two Systems and Compare Them</h2>
|
|
151
|
-
<ul>
|
|
152
|
-
<li><code>machinery inspect HOSTNAME1</code></li>
|
|
153
|
-
<li><code>machinery inspect HOSTNAME2</code></li>
|
|
154
|
-
<li><code>machinery compare HOSTNAME1 HOSTNAME2</code></li>
|
|
155
|
-
</ul>
|
|
156
|
-
<h2 id="fully-inspect-a-system-and-export-a-kiwi-description">Fully Inspect a System and Export a Kiwi Description</h2>
|
|
157
|
-
<ul>
|
|
158
|
-
<li><code>machinery inspect --extract-files HOSTNAME</code></li>
|
|
159
|
-
<li><code>machinery export-kiwi --kiwi-dir=~/kiwi HOSTNAME</code></li>
|
|
160
|
-
</ul>
|
|
161
|
-
<h2 id="fully-inspect-a-system-and-export-an-autoyast-profile">Fully Inspect a System and Export an AutoYaST Profile</h2>
|
|
162
|
-
<ul>
|
|
163
|
-
<li><code>machinery inspect --extract-files HOSTNAME</code></li>
|
|
164
|
-
<li><code>machinery export-autoyast --autoyast-dir=~/autoyast HOSTNAME</code></li>
|
|
165
|
-
</ul>
|
|
166
|
-
<h2 id="fully-inspect-a-system-and-deploy-a-replicate-to-the-cloud">Fully Inspect a System and Deploy a Replicate to the Cloud</h2>
|
|
167
|
-
<ul>
|
|
168
|
-
<li><code>machinery inspect --extract-files HOSTNAME</code></li>
|
|
169
|
-
<li><code>machinery deploy --cloud-config=~/openrc.sh HOSTNAME</code></li>
|
|
170
|
-
</ul>
|
|
171
|
-
<h2 id="how-to-upgrade-a-sles-11-sp3-system-to-sles-12">How to upgrade a SLES 11 SP3 system to SLES 12</h2>
|
|
172
|
-
<ul>
|
|
173
|
-
<li>Machinery can help you to upgrade without affecting the original system.
|
|
174
|
-
For more details please read the Wiki Page: <br>
|
|
175
|
-
https://github.com/SUSE/machinery/wiki/How-to-upgrade-a-SLES-11-SP3-system-to-SLES-12</li>
|
|
176
|
-
</ul>
|
|
177
|
-
<h1 id="conceptual-overview">CONCEPTUAL OVERVIEW</h1>
|
|
145
|
+
<h1 id="conceptual-overview">Conceptual Overview</h1>
|
|
178
146
|
<p>Machinery's core concept is the complete representation of a system by a
|
|
179
147
|
universal system description.
|
|
180
148
|
System descriptions are managed independently of the described
|
|
@@ -183,7 +151,7 @@ modifications.</p>
|
|
|
183
151
|
<p>Machinery's subcommands work on the system description as the connecting
|
|
184
152
|
element.
|
|
185
153
|
System descriptions are obtained by inspecting systems, importing from other
|
|
186
|
-
formats, manual creation or merging
|
|
154
|
+
formats, manual creation or merging existing descriptions.
|
|
187
155
|
Machinery can store and modify system descriptions to allow changes to
|
|
188
156
|
described state of the system.
|
|
189
157
|
System descriptions can be compared to find similarities and differences
|
|
@@ -191,7 +159,7 @@ between them or analyzed to deepen the knowledge about particular aspects of
|
|
|
191
159
|
the system.
|
|
192
160
|
System descriptions may be exported to other formats and can be used to
|
|
193
161
|
migrate or replicate systems.</p>
|
|
194
|
-
<p>Subcommands can be combined in different ways to
|
|
162
|
+
<p>Subcommands can be combined in different ways to accommodate higher-level work
|
|
195
163
|
flows and use cases.
|
|
196
164
|
These are some implemented and planned use cases:</p>
|
|
197
165
|
<p>Migrate a physical system to a virtual environment:</p>
|
|
@@ -223,14 +191,39 @@ address use cases currently not covered by them.</p>
|
|
|
223
191
|
<code>machinery</code> command has several subcommands for specific tasks. All
|
|
224
192
|
subcommands work with the same system description identified by an optional
|
|
225
193
|
name which can be used by all subcommands.</p>
|
|
194
|
+
<h2 id="system-description">System Description</h2>
|
|
195
|
+
<p>The System Description format and file structure is documented in the machinery
|
|
196
|
+
wiki: <a href="https://github.com/SUSE/machinery/wiki/System-Description-Format">System Description Format</a>.</p>
|
|
197
|
+
<p>Machinery validates descriptions on load. It checks that the JSON structure of
|
|
198
|
+
the manifest file, which contains the primary and meta data of a description, is
|
|
199
|
+
correct and it adheres to the schema. Validation errors are reported as warnings.
|
|
200
|
+
It also checks that the information about extracted files is consistent. Missing
|
|
201
|
+
files or extra files without reference in the manifest are treated also as
|
|
202
|
+
warnings. All other issues are errors which need to be fixed so that Machinery
|
|
203
|
+
can use the description.
|
|
204
|
+
To manually validate a description use the <code>machinery validate</code> command.</p>
|
|
226
205
|
<h2 id="scopes">Scopes</h2>
|
|
227
206
|
<p>The system description is structured into "scopes". A scope covers a specific
|
|
228
207
|
part of the configuration of the inspected system such as installed packages,
|
|
229
208
|
repositories, or changed configuration files.</p>
|
|
230
209
|
<p>For example, if you are only interested in the installed packages, limit the
|
|
231
210
|
scope to <code>packages</code>. This will output only the requested information.</p>
|
|
232
|
-
<p>
|
|
233
|
-
<h1 id="
|
|
211
|
+
<p>See the <a href="../machinery_main_scopes.1/">Scopes documentation</a> for a list of all supported scopes.</p>
|
|
212
|
+
<h1 id="options-for-all-subcommands">Options for All Subcommands</h1>
|
|
213
|
+
<!--- These are 'global' options of machinery -->
|
|
214
|
+
|
|
215
|
+
<ul>
|
|
216
|
+
<li>
|
|
217
|
+
<p><code>--version</code>:
|
|
218
|
+
Displays version of <code>machinery</code> tool. Exit when done.</p>
|
|
219
|
+
</li>
|
|
220
|
+
<li>
|
|
221
|
+
<p><code>--debug</code>:
|
|
222
|
+
Enable debug mode. Machinery writes additional information into the log
|
|
223
|
+
file which can be useful to track down problems.</p>
|
|
224
|
+
</li>
|
|
225
|
+
</ul>
|
|
226
|
+
<h1 id="files-and-devices">Files and Devices</h1>
|
|
234
227
|
<ul>
|
|
235
228
|
<li>
|
|
236
229
|
<p><code>~/.machinery/machinery.config</code>:</p>
|
|
@@ -241,18 +234,18 @@ scope to <code>packages</code>. This will output only the requested information.
|
|
|
241
234
|
<p>Central log file, in the format date, time, process id, and log message.</p>
|
|
242
235
|
</li>
|
|
243
236
|
<li>
|
|
244
|
-
<p><code>eth0</code> (SLE11) and <code>lan0</code> (SLE12):</p>
|
|
237
|
+
<p><code>em1 (openSUSE 13.2 / openSUSE leap)</code>, <code>eth0</code> (SLE11) and <code>lan0</code> (SLE12):</p>
|
|
245
238
|
<p>First network device is used when DHCP in built image is enabled.</p>
|
|
246
239
|
</li>
|
|
247
240
|
</ul>
|
|
248
|
-
<h1 id="environment">
|
|
241
|
+
<h1 id="environment">Environment</h1>
|
|
249
242
|
<ul>
|
|
250
243
|
<li>
|
|
251
244
|
<p><code>MACHINERY_LOG_FILE</code>:</p>
|
|
252
|
-
<p>Location of Machinery's log file (defaults to <code>~/.machinery/machinery.log</code>)
|
|
245
|
+
<p>Location of Machinery's log file (defaults to <code>~/.machinery/machinery.log</code>).</p>
|
|
253
246
|
</li>
|
|
254
247
|
</ul>
|
|
255
|
-
<h1 id="copyright">
|
|
248
|
+
<h1 id="copyright">Copyright</h1>
|
|
256
249
|
<p>Copyright (c) 2013-2016 <a href="http://www.suse.com">SUSE LLC</a></p>
|
|
257
250
|
</div>
|
|
258
251
|
</div>
|