machinery-tool 1.24.0 → 1.24.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/.git_revision +1 -1
  3. data/NEWS +4 -0
  4. data/lib/man_task.rb +1 -1
  5. data/lib/version.rb +1 -1
  6. data/machinery-helper/version.go +1 -1
  7. data/man/generated/machinery.1.gz +0 -0
  8. data/manual/{docs/README.md → README.md} +0 -0
  9. data/manual/custom_theme/{base.html → main.html} +5 -5
  10. data/manual/docs/css/custom.css +17 -1
  11. data/manual/docs/{docs.md → docs/index.md} +1 -1
  12. data/manual/docs/{machinery-analyze.1.md → docs/machinery-analyze.1.md} +0 -0
  13. data/manual/docs/{machinery-build.1.md → docs/machinery-build.1.md} +0 -0
  14. data/manual/docs/{machinery-compare.1.md → docs/machinery-compare.1.md} +0 -0
  15. data/manual/docs/{machinery-config.1.md → docs/machinery-config.1.md} +0 -0
  16. data/manual/docs/{machinery-copy.1.md → docs/machinery-copy.1.md} +0 -0
  17. data/manual/docs/{machinery-deploy.1.md → docs/machinery-deploy.1.md} +0 -0
  18. data/manual/docs/{machinery-export-autoyast.1.md → docs/machinery-export-autoyast.1.md} +0 -0
  19. data/manual/docs/{machinery-export-html.1.md → docs/machinery-export-html.1.md} +0 -0
  20. data/manual/docs/{machinery-export-kiwi.1.md → docs/machinery-export-kiwi.1.md} +0 -0
  21. data/manual/docs/{machinery-inspect-container.1.md → docs/machinery-inspect-container.1.md} +2 -2
  22. data/manual/docs/{machinery-inspect.1.md → docs/machinery-inspect.1.md} +2 -2
  23. data/manual/docs/{machinery-list.1.md → docs/machinery-list.1.md} +0 -0
  24. data/manual/docs/{machinery-man.1.md → docs/machinery-man.1.md} +0 -0
  25. data/manual/docs/{machinery-move.1.md → docs/machinery-move.1.md} +0 -0
  26. data/manual/docs/{machinery-remove.1.md → docs/machinery-remove.1.md} +0 -0
  27. data/manual/docs/{machinery-serve.1.md → docs/machinery-serve.1.md} +0 -0
  28. data/manual/docs/{machinery-show.1.md → docs/machinery-show.1.md} +2 -2
  29. data/manual/docs/{machinery-upgrade-format.1.md → docs/machinery-upgrade-format.1.md} +0 -0
  30. data/manual/docs/{machinery-validate.1.md → docs/machinery-validate.1.md} +0 -0
  31. data/manual/docs/{machinery_main_general.1.md → docs/machinery_main_general.1.md} +1 -1
  32. data/manual/docs/{machinery_main_scopes.1.md → docs/machinery_main_scopes.1.md} +0 -0
  33. data/manual/docs/{machinery_main_security_implications.1.md → docs/machinery_main_security_implications.1.md} +3 -3
  34. data/manual/docs/{machinery_main_usecases.1.md → docs/machinery_main_usecases.1.md} +0 -0
  35. data/manual/mkdocs.yml +40 -26
  36. data/manual/site/css/custom.css +17 -1
  37. data/manual/site/docs/index.html +49 -4
  38. data/manual/site/docs/machinery-analyze.1/index.html +174 -0
  39. data/manual/site/docs/machinery-build.1/index.html +205 -0
  40. data/manual/site/docs/machinery-compare.1/index.html +207 -0
  41. data/manual/site/docs/machinery-config.1/index.html +182 -0
  42. data/manual/site/{machinery-analyze.1 → docs/machinery-copy.1}/index.html +55 -30
  43. data/manual/site/docs/machinery-deploy.1/index.html +207 -0
  44. data/manual/site/docs/machinery-export-autoyast.1/index.html +194 -0
  45. data/manual/site/docs/machinery-export-html.1/index.html +175 -0
  46. data/manual/site/docs/machinery-export-kiwi.1/index.html +176 -0
  47. data/manual/site/docs/machinery-inspect-container.1/index.html +249 -0
  48. data/manual/site/docs/machinery-inspect.1/index.html +292 -0
  49. data/manual/site/docs/machinery-list.1/index.html +187 -0
  50. data/manual/site/{machinery-config.1 → docs/machinery-man.1}/index.html +39 -30
  51. data/manual/site/{machinery-compare.1 → docs/machinery-move.1}/index.html +54 -30
  52. data/manual/site/docs/machinery-remove.1/index.html +182 -0
  53. data/manual/site/docs/machinery-serve.1/index.html +181 -0
  54. data/manual/site/docs/machinery-show.1/index.html +206 -0
  55. data/manual/site/docs/machinery-upgrade-format.1/index.html +180 -0
  56. data/manual/site/docs/machinery-validate.1/index.html +168 -0
  57. data/manual/site/docs/machinery_main_general.1/index.html +253 -0
  58. data/manual/site/docs/machinery_main_scopes.1/index.html +249 -0
  59. data/manual/site/docs/machinery_main_security_implications.1/index.html +228 -0
  60. data/manual/site/{machinery_main_usecases.1 → docs/machinery_main_usecases.1}/index.html +47 -28
  61. data/manual/site/index.html +390 -135
  62. data/manual/site/search/search_index.json +1 -1
  63. data/manual/site/sitemap.xml +24 -24
  64. data/manual/site/sitemap.xml.gz +0 -0
  65. metadata +51 -76
  66. data/manual/docs/custom.css +0 -804
  67. data/manual/docs/hand3.png +0 -0
  68. data/manual/docs/wheels.png +0 -0
  69. data/manual/site/404.html +0 -145
  70. data/manual/site/css/base.css +0 -324
  71. data/manual/site/css/bootstrap-custom.min.css +0 -1
  72. data/manual/site/css/font-awesome.min.css +0 -4
  73. data/manual/site/custom.css +0 -804
  74. data/manual/site/fonts/fontawesome-webfont.eot +0 -0
  75. data/manual/site/fonts/fontawesome-webfont.svg +0 -2671
  76. data/manual/site/fonts/fontawesome-webfont.ttf +0 -0
  77. data/manual/site/fonts/fontawesome-webfont.woff +0 -0
  78. data/manual/site/fonts/fontawesome-webfont.woff2 +0 -0
  79. data/manual/site/fonts/glyphicons-halflings-regular.eot +0 -0
  80. data/manual/site/fonts/glyphicons-halflings-regular.svg +0 -288
  81. data/manual/site/fonts/glyphicons-halflings-regular.ttf +0 -0
  82. data/manual/site/fonts/glyphicons-halflings-regular.woff +0 -0
  83. data/manual/site/fonts/glyphicons-halflings-regular.woff2 +0 -0
  84. data/manual/site/hand3.png +0 -0
  85. data/manual/site/img/favicon.ico +0 -0
  86. data/manual/site/img/grid.png +0 -0
  87. data/manual/site/js/base.js +0 -216
  88. data/manual/site/js/bootstrap-3.0.3.min.js +0 -7
  89. data/manual/site/js/jquery-1.10.2.min.js +0 -6
  90. data/manual/site/machinery-build.1/index.html +0 -145
  91. data/manual/site/machinery-copy.1/index.html +0 -145
  92. data/manual/site/machinery-deploy.1/index.html +0 -145
  93. data/manual/site/machinery-export-autoyast.1/index.html +0 -145
  94. data/manual/site/machinery-export-html.1/index.html +0 -145
  95. data/manual/site/machinery-export-kiwi.1/index.html +0 -145
  96. data/manual/site/machinery-inspect-container.1/index.html +0 -145
  97. data/manual/site/machinery-inspect.1/index.html +0 -145
  98. data/manual/site/machinery-list.1/index.html +0 -145
  99. data/manual/site/machinery-man.1/index.html +0 -145
  100. data/manual/site/machinery-move.1/index.html +0 -145
  101. data/manual/site/machinery-remove.1/index.html +0 -145
  102. data/manual/site/machinery-serve.1/index.html +0 -145
  103. data/manual/site/machinery-show.1/index.html +0 -145
  104. data/manual/site/machinery-upgrade-format.1/index.html +0 -145
  105. data/manual/site/machinery-validate.1/index.html +0 -145
  106. data/manual/site/machinery_main_general.1/index.html +0 -145
  107. data/manual/site/machinery_main_scopes.1/index.html +0 -145
  108. data/manual/site/machinery_main_security_implications.1/index.html +0 -145
  109. data/manual/site/wheels.png +0 -0
@@ -0,0 +1,228 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8"/>
5
+ <link href="../../css/custom.css" rel="stylesheet">
6
+ </head>
7
+ <body id="manpage">
8
+ <div id="back">
9
+ <a href="../..">
10
+ <img src="../../img/hand3.png" class="hand3"/>
11
+ <div class="goback">Go back to the web site</div>
12
+ </a>
13
+ </div>
14
+ <div class="mp">
15
+ <div class="nav">
16
+ <ul>
17
+
18
+
19
+ <li class="">
20
+ <a href="../">Welcome</a>
21
+ </li>
22
+
23
+
24
+
25
+
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="current">
48
+ <a href="./">Security Implications</a>
49
+ </li>
50
+
51
+
52
+
53
+
54
+ <li>Commands
55
+ <ul>
56
+
57
+ <li class="">
58
+ <a href="../machinery-analyze.1/">Analyze</a>
59
+ </li>
60
+
61
+ <li class="">
62
+ <a href="../machinery-build.1/">Build</a>
63
+ </li>
64
+
65
+ <li class="">
66
+ <a href="../machinery-compare.1/">Compare</a>
67
+ </li>
68
+
69
+ <li class="">
70
+ <a href="../machinery-config.1/">Config</a>
71
+ </li>
72
+
73
+ <li class="">
74
+ <a href="../machinery-copy.1/">Copy</a>
75
+ </li>
76
+
77
+ <li class="">
78
+ <a href="../machinery-deploy.1/">Deploy</a>
79
+ </li>
80
+
81
+ <li class="">
82
+ <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
83
+ </li>
84
+
85
+ <li class="">
86
+ <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
87
+ </li>
88
+
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
93
+ <li class="">
94
+ <a href="../machinery-inspect.1/">Inspect</a>
95
+ </li>
96
+
97
+ <li class="">
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
99
+ </li>
100
+
101
+ <li class="">
102
+ <a href="../machinery-list.1/">List</a>
103
+ </li>
104
+
105
+ <li class="">
106
+ <a href="../machinery-man.1/">Man</a>
107
+ </li>
108
+
109
+ <li class="">
110
+ <a href="../machinery-move.1/">Move</a>
111
+ </li>
112
+
113
+ <li class="">
114
+ <a href="../machinery-remove.1/">Remove</a>
115
+ </li>
116
+
117
+ <li class="">
118
+ <a href="../machinery-serve.1/">Serve</a>
119
+ </li>
120
+
121
+ <li class="">
122
+ <a href="../machinery-show.1/">Show</a>
123
+ </li>
124
+
125
+ <li class="">
126
+ <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
127
+ </li>
128
+
129
+ <li class="">
130
+ <a href="../machinery-validate.1/">Validate</a>
131
+ </li>
132
+
133
+ </ul>
134
+ </li>
135
+
136
+
137
+
138
+ </ul>
139
+ </div>
140
+ <div class="content">
141
+ <h1 id="security-implications">Security Implications</h1>
142
+ <p>This document describes security related issues administrators need to be aware of when using
143
+ Machinery.</p>
144
+ <h2 id="inspection">Inspection</h2>
145
+ <p>Machinery inspects several parts of a system which are covered by Machinery's scopes.
146
+ Information about scopes is listed <a href="../machinery_main_scopes.1/">here</a>.</p>
147
+ <p>Users of Machinery who inspect systems need to be aware of the security implications
148
+ to take the right decisions on how to protect the retrieved data.</p>
149
+ <h2 id="retrieval-of-data">Retrieval of Data</h2>
150
+ <p>Machinery transfers data from one end point to another via SSH (Secure Shell, using public key authentication).</p>
151
+ <p>Depending on the scope, Machinery <a href="../machinery_main_scopes.1/">collects information</a>
152
+ about files on the system. Additionally, when the <code>--extract-files</code> option is given for the
153
+ <code>inspect</code> command, not only the meta data about the files (e.g. permission bits, owner, group etc
154
+ .) but also the file content is extracted. Machinery does not distinguish between sensitive
155
+ data (such as private keys or password files). That means that everyone with access to the system
156
+ description has automatically access to <strong>all</strong> extracted files and contained sensitive data.</p>
157
+ <h4 id="rootsudo-privileges">root/sudo Privileges</h4>
158
+ <p>An inspection can only be done, when the user on the inspected system is either root or has
159
+ sudo privileges. Information about the required sudo configuration can be found
160
+ <a href="../machinery-inspect.1/#prerequisites">here</a>.</p>
161
+ <h2 id="storage-of-data">Storage of Data</h2>
162
+ <h4 id="access-restrictions">Access Restrictions</h4>
163
+ <p>After an inspection has been completed, the directory where the description is stored is made
164
+ readable only for the user. The data is not encrypted by Machinery.</p>
165
+ <h4 id="used-permission-bits">Used Permission Bits</h4>
166
+ <p>When Machinery extracts data, it sets permission bits for files and directories as follows:</p>
167
+ <table>
168
+ <thead>
169
+ <tr>
170
+ <th>Permission Bits</th>
171
+ <th>Used for ...</th>
172
+ </tr>
173
+ </thead>
174
+ <tbody>
175
+ <tr>
176
+ <td>0700</td>
177
+ <td>... directories inside the description directory</td>
178
+ </tr>
179
+ <tr>
180
+ <td>0600</td>
181
+ <td>... for files inside the description directory</td>
182
+ </tr>
183
+ </tbody>
184
+ </table>
185
+ <h4 id="accessing-system-descriptions">Accessing System Descriptions</h4>
186
+ <p>By default, all system descriptions are stored in the directory <code>.machinery</code> in the home directory
187
+ of the user running Machinery. The directory can be redefined by the environment variable
188
+ <code>$MACHINERY_DIR</code>. Each description has its own subdirectory. There is a <code>manifest.json</code> file in
189
+ each description directory which contains the data of the inspection. Extracted files are stored in
190
+ separate subdirectories inside the same description directory.</p>
191
+ <h2 id="presentation-of-data">Presentation of Data</h2>
192
+ <p>There are several ways how data can be presented to one or more users. The user has the option to
193
+ either start a web server and view descriptions or view the descriptions only in the console.</p>
194
+ <p>The following commands are used to present data to users:</p>
195
+ <ul>
196
+ <li>show</li>
197
+ <li>compare</li>
198
+ <li>serve</li>
199
+ <li>list</li>
200
+ </ul>
201
+ <p>All of the commands listed above also have a <code>--html</code> option. When this option is used, Machinery
202
+ starts a web server what will listen on the IP address <code>127.0.0.1</code>. The <code>serve</code> command
203
+ offers also a <code>--public</code> option which makes the server listen on all configured IP addresses.</p>
204
+ <p><strong>WARNING:</strong> When making the server reachable from the outside, users can modify the link to
205
+ access also other descriptions. There is currently no way to restrict the access to only one
206
+ description.</p>
207
+ <p>The <code>serve</code> command also allows the user to specify a port via the <code>--port</code> option. When no port
208
+ is specified, the default port which is configured in the machinery config file in
209
+ <code>~/.machinery/machinery.config</code>) will be taken.</p>
210
+ <h2 id="export-of-data">Export of Data</h2>
211
+ <h4 id="export-autoyast">export-autoyast</h4>
212
+ <p>The <code>export-autoyast</code> command creates an AutoYaST profile for an automated installation. This will result
213
+ in tar balls containing the extracted files from the system description. These files
214
+ potentially contain sensitive data (e.g. passwords). This fact needs to be kept in mind, especially
215
+ if these files are copied to a web server for an AutoYaST installation via HTTP.</p>
216
+ <h4 id="export-kiwi">export-kiwi</h4>
217
+ <p>The program <strong>kiwi</strong> allows you to build OS images for deployment. Machinery gives
218
+ you the opportunity to export a KIWI description. This description can be used to build an image via Kiwi.
219
+ The <code>export-kiwi</code> command creates a directory, where it stores the Kiwi configuration and the files
220
+ of a system description. These files potentially contain sensitive data (e.g. passwords).</p>
221
+ <h4 id="build">build</h4>
222
+ <p>The created image potentially contains sensitive data (e.g. passwords) from extracted files.</p>
223
+ <h4 id="deploy">deploy</h4>
224
+ <p>The uploaded image potentially contains sensitive data (e.g. passwords) from extracted files.</p>
225
+ </div>
226
+ </div>
227
+ </body>
228
+ </html>
@@ -2,12 +2,12 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8"/>
5
- <link href="../custom.css" rel="stylesheet">
5
+ <link href="../../css/custom.css" rel="stylesheet">
6
6
  </head>
7
7
  <body id="manpage">
8
8
  <div id="back">
9
- <a href="..">
10
- <img src="../hand3.png" class="hand3"/>
9
+ <a href="../..">
10
+ <img src="../../img/hand3.png" class="hand3"/>
11
11
  <div class="goback">Go back to the web site</div>
12
12
  </a>
13
13
  </div>
@@ -17,35 +17,35 @@
17
17
 
18
18
 
19
19
  <li class="">
20
- <a href="docs/">Welcome</a>
20
+ <a href="../">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="current">
41
- <a href="machinery_main_usecases.1/">Use cases</a>
41
+ <a href="./">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="">
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,7 +138,26 @@
138
138
  </ul>
139
139
  </div>
140
140
  <div class="content">
141
-
141
+ <h1 id="use-cases">Use Cases</h1>
142
+ <p>Some of the important use cases of Machinery are:</p>
143
+ <ul>
144
+ <li>Inspecting a System and Collecting Information</li>
145
+ </ul>
146
+ <p>Collecting a variety of information. Limit the gathered
147
+ information with scopes (see section about scopes). Each inspection step
148
+ updates the system description.</p>
149
+ <ul>
150
+ <li>Reviewing System Description</li>
151
+ </ul>
152
+ <p>After a successful inspection, the system description can be displayed on
153
+ the console or the output can be fed into other tools.</p>
154
+ <ul>
155
+ <li>Cloning a System</li>
156
+ </ul>
157
+ <p>An inspected system can be cloned. The inspection step returns a system
158
+ description which is used as the basis for cloning physical or virtual
159
+ instances. Machinery can build a system image from the description, which
160
+ can then for example be deployed to a cloud environment.</p>
142
161
  </div>
143
162
  </div>
144
163
  </body>
@@ -1,145 +1,400 @@
1
1
  <!DOCTYPE html>
2
- <html>
2
+ <html lang="en">
3
3
  <head>
4
4
  <meta charset="utf-8"/>
5
- <link href="./custom.css" rel="stylesheet">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6
+ <meta name="viewport" content="width=device-width, initial-scale=1"/>
7
+ <title>Machinery - A Systems Management Toolkit for Linux</title>
8
+ <meta name="description" content="A systems management toolkit for Linux. Machinery supports configuration discovery, system validation,and service migration.">
9
+ <meta name="keywords" content="linux,machinery,suse,suse linux, system validation, service migration, configuration discovery, system administrator">
10
+ <link href="css/bootstrap.min.css" rel="stylesheet"/>
11
+ <link href="css/custom.css" rel="stylesheet" />
12
+ <link href="css/fixed-positioning.css" rel="stylesheet" type="text/css" />
13
+ <link href="favicon.png" rel="shortcut icon" />
14
+ <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
15
+ <!--[if lt IE 9]>
16
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
17
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
18
+ <![endif]-->
6
19
  </head>
7
- <body id="manpage">
8
- <div id="back">
9
- <a href=".">
10
- <img src="../hand3.png" class="hand3"/>
11
- <div class="goback">Go back to the web site</div>
12
- </a>
20
+ <body>
21
+ <div class="gear hidden-xs" data-0="transform:rotate(0deg)" data-5050="transform:rotate(700deg)"><img src="img/gear.png"></div>
22
+ <div class="gear3 hidden-xs" data-0="transform:rotate(0deg)" data-5050="transform:rotate(-700deg)"><img src="img/gear3.png"></div>
23
+ <div class="gear2 hidden-xs" data-0="transform:rotate(0deg)" data-5050="transform:rotate(2700deg)"><img src="img/gear2.png"></div>
24
+ <div id="menu" style="padding-top:150px">
25
+ <h1 class="index">- Index -</h1>
26
+ <ul>
27
+ <li> <a href="#section1">Introduction</a></li>
28
+ <li> <a href="#section15">Movie</a></li>
29
+ <li> <a href="#section2">Features</a></li>
30
+ <li> <a href="#section3">System description</a></li>
31
+ <li><a href="#section4">Philosophy</a></li>
32
+ </ul>
33
+ <div class="man">
34
+ <a id="man" href="docs" align="center">show the documentation<br><img class="manb" src="img/book.png"></a>
35
+ </div>
13
36
  </div>
14
- <div class="mp">
15
- <div class="nav">
16
- <ul>
17
-
18
-
19
- <li class="">
20
- <a href="docs/">Welcome</a>
21
- </li>
22
-
23
-
24
-
25
-
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>
49
- </li>
50
-
51
-
52
-
53
-
54
- <li>Commands
55
- <ul>
56
-
57
- <li class="">
58
- <a href="machinery-analyze.1/">Analyze</a>
59
- </li>
60
-
61
- <li class="">
62
- <a href="machinery-build.1/">Build</a>
63
- </li>
64
-
65
- <li class="">
66
- <a href="machinery-compare.1/">Compare</a>
67
- </li>
68
-
69
- <li class="">
70
- <a href="machinery-config.1/">Config</a>
71
- </li>
72
-
73
- <li class="">
74
- <a href="machinery-copy.1/">Copy</a>
75
- </li>
76
-
77
- <li class="">
78
- <a href="machinery-deploy.1/">Deploy</a>
79
- </li>
80
-
81
- <li class="">
82
- <a href="machinery-export-autoyast.1/">Export AutoYaST</a>
83
- </li>
84
-
85
- <li class="">
86
- <a href="machinery-export-kiwi.1/">Export Kiwi</a>
87
- </li>
88
-
89
- <li class="">
90
- <a href="machinery-export-html.1/">Export HTML</a>
91
- </li>
92
-
93
- <li class="">
94
- <a href="machinery-inspect.1/">Inspect</a>
95
- </li>
96
-
97
- <li class="">
98
- <a href="machinery-inspect-container.1/">Inspect Container</a>
99
- </li>
100
-
101
- <li class="">
102
- <a href="machinery-list.1/">List</a>
103
- </li>
104
-
105
- <li class="">
106
- <a href="machinery-man.1/">Man</a>
107
- </li>
108
-
109
- <li class="">
110
- <a href="machinery-move.1/">Move</a>
111
- </li>
112
-
113
- <li class="">
114
- <a href="machinery-remove.1/">Remove</a>
115
- </li>
116
-
117
- <li class="">
118
- <a href="machinery-serve.1/">Serve</a>
119
- </li>
120
-
121
- <li class="">
122
- <a href="machinery-show.1/">Show</a>
123
- </li>
124
-
125
- <li class="">
126
- <a href="machinery-upgrade-format.1/">Upgrade Format</a>
127
- </li>
128
-
129
- <li class="">
130
- <a href="machinery-validate.1/">Validate</a>
131
- </li>
132
-
133
- </ul>
134
- </li>
135
-
136
-
137
-
138
- </ul>
37
+
38
+ <img id="menu-btn1" src="img/navig.png" width="30px" height="30px">
39
+
40
+ <a href="#" class="scrollToTop">Scroll to top</a>
41
+
42
+ <div class="all-container">
43
+ <div class="container-fluid home-img" id="section1">
44
+ <!-- section 1 -->
45
+ <div class="row suse-experiment">
46
+ <div class="col-md-4">
47
+ <div class="line1"></div>
48
+ </div>
49
+ <div class="col-md-4 col-xs-12" align="center">
50
+ a SUSE Technology Experiment
51
+ </div>
52
+ <div class="col-md-4">
53
+ <div class="line2"></div>
54
+ </div>
55
+ </div>
56
+
57
+ <div class="row">
58
+ <div class="col-md-12 col-xs-12" >
59
+ <h1 class="headline" align="center">Machinery</h1>
60
+
61
+ <div class="pull-left" id="no-underline">
62
+
63
+ <div>
64
+ <div class="git">
65
+ <a class="btn btn-default" href="machinery.ymp">Install on openSUSE</a>
66
+ </div>
67
+ </div>
68
+
69
+ <div>
70
+ <div class="git">
71
+ <a class="btn btn-default" href="https://github.com/SUSE/machinery/wiki/Installation-on-Other-Distributions">Install on other systems</a>
72
+ </div>
73
+ </div>
74
+
75
+ <div>
76
+ <div class="git">
77
+ <a class="btn btn-default" href="docs/">Documentation</a>
78
+ </div>
79
+ </div>
80
+
81
+ <div>
82
+ <div class="install">
83
+ <a class="btn btn-default" href="http://github.com/SUSE/machinery">Get the source</a>
84
+ </div>
85
+ </div>
86
+ </div>
87
+
88
+ <div>
89
+ <div class="wrap-typewriter">
90
+ <p>A command line application for creating descriptions of Linux systems and working with them.</p><p>Machinery supports use cases such as<br><a href='#properties1'> configuration discovery</a>, <br/><a href='#properties2'>system validation</a>, <br/>and <a href='#properties3'>service migration</a>. </p><p>Machinery is based on the idea of an <br/><a href='#section3'> universal system description</a>.<br/>It is transparent,<br/>extensible, and crafted beautifully.</p><p>Machinery is made for the system administrator of the data center. Read more about the <a href='#section4'>philosophy</a> behind it.
91
+ <div class="movie"><a href="#section15">Watch the movie!</a></div>
92
+ </div>
93
+ <div class="ticket">
94
+ <a href="#section15"><img src="img/ticket2.png"></a>
95
+ </div><!-- close typewriter --></div>
96
+ </div>
97
+
98
+
99
+
100
+
101
+ </div>
102
+
103
+
104
+ </div><!-- close section -->
105
+
106
+ <div class="row section15" id="section15"> <!-- section 1.5 -->
107
+ <div class="col-md-5 col-md-offset-1">
108
+ <div class="embed-responsive embed-responsive-16by9" >
109
+ <iframe class="embed-responsive-item" src="https://www.youtube.com/embed/oXvZhRcw7CQ?&autohide=1&showinfo=0&rel=0&color=white" frameborder="0" allowfullscreen></iframe>
110
+ </div>
111
+ </div>
112
+
113
+ <div class="col-md-5">
114
+ <div class="second-text wrap-typewriter">
115
+ <p> Machinery is a command line application for creating descriptions of Linux systems and working with them. </p>
116
+ <p> You can use it to get insight into existing systems, to store and track their state, or to create new systems based on existing ones.</p>
117
+ <p> Machinery provides powerful views of individual and comparisons between systems.</p>
118
+ <p> It can also export descriptions to other tools for installation, migration, image building, containerization, or cloud deployment, and provides defined interfaces to work with system descriptions from your custom tools.</p>
119
+ <div class="movie">
120
+ <a href="https://github.com/SUSE/machinery/wiki/Quick-Start-Guide">Get started!</a>
121
+ </div>
122
+ </div>
123
+ </div>
124
+
125
+ <div class="row">
126
+ <div class="col-md-12 col-xs-12 continue" align="center">
127
+ <a href="#section2">Scroll for more information<img src="img/hand2.png" class="hand2"></a>
128
+ </div>
129
+ </div>
130
+
131
+ </div>
132
+
133
+
134
+ <!-- section 2 -->
135
+ <div class="row parallax-img-container" id="section2">
136
+ <div class="col-md-8 col-md-offset-2 hidden-xs properties" data-20="top:100%; opacity:1" data-150="top:0%;" >
137
+ <h2 class="title-parallax">Configuration discovery</h2>
138
+ <div id="properties1"></div>
139
+ <img src="img/configuration-discovery.png" class="propertiesOJ" data-200="opacity:0" data-600="opacity:1">
140
+ <p class="text-parallax">Inspect a system, extract configuration and installed software. Write a description which can be used to replicate the system, to track its history, or to use it as a reference for other systems.</p>
141
+ <br>
142
+ <a href="#properties2"><img src="img/hand.png" class="hand"></a>
143
+ </div>
144
+
145
+ <div class="col-xs-10 visible-xs">
146
+ <h2 class="title-parallax">Configuration discovery</h2>
147
+ <img src="img/configuration-discovery.png" class="propertiesOJ" data-500="opacity:0" data-900="opacity:1">
148
+ <p class="text-parallax">Inspect a system, extract configuration and installed software. Write a description which can be used to replicate the system, to track its history, or to use it as a reference for other systems.</p>
149
+ <br>
150
+ <a href="#properties2m"><img src="img/hand.png" class="hand"></a>
151
+ </div>
152
+
153
+ <div class="col-md-8 col-md-offset-2 hidden-xs properties" data-700="top:100%;opacity:1" data-800="top:0%;">
154
+ <h2 class="title-parallax">System validation</h2>
155
+ <div id="properties2"></div>
156
+ <img src="img/system-validation.png" class="propertiesOJ" data-1400="opacity:0" data-1600="opacity:1">
157
+ <p class="text-parallax">Validate systems by comparing against a known good state. Capture reference configuration in template descriptions. Track changes of configuration or installed files over time or compared to other systems.</p>
158
+ <br>
159
+ <a href="#properties3"><img src="img/hand.png" class="hand"></a>
160
+ </div>
161
+
162
+ <div class="col-xs-10 visible-xs" id="properties2m">
163
+ <h2 class="title-parallax">System validation</h2>
164
+ <img src="img/system-validation.png" class="propertiesOJ" data-1700="opacity:0" data-1900="opacity:1">
165
+ <p class="text-parallax">Validate systems by comparing against a known good state. Capture reference configuration in template descriptions. Track changes of configuration or installed files over time or compared to other systems.</p>
166
+ <br>
167
+ <a href="#properties3m"><img src="img/hand.png" class="hand"></a>
168
+ </div>
169
+
170
+ <div class="col-md-8 col-md-offset-2 hidden-xs properties" data-800="top:100%;opacity:1" data-1000="top:0%;">
171
+ <h2 class="title-parallax">Service migration</h2>
172
+ <div id="properties3"></div>
173
+ <img src="img/service-migration.png" class="propertiesOJ" data-700="opacity:0" data-800="opacity:1">
174
+ <p class="text-parallax">Migrate your services from one kind of system to another. Migrate physical systems to the cloud. Migrate from one operating system version to another. Do this in a repeatable, documented way, which can be adapted to your needs.</p>
175
+ <br>
176
+ <a href="#section3"><img src="img/hand.png" class="hand"></a>
177
+ </div>
178
+
179
+ <div class="col-xs-10 visible-xs" id="properties3m">
180
+ <h2 class="title-parallax">Service migration</h2>
181
+ <img src="img/service-migration.png" class="propertiesOJ" data-3000="opacity:0" data-3700="opacity:1">
182
+ <p class="text-parallax">Migrate your services from one kind of system to another. Migrate physical systems to the cloud. Migrate from one operating system version to another. Do this in a repeatable, documented way, which can be adapted to your needs.</p>
183
+ <br>
184
+ <a href="#section3"><img src="img/hand.png" class="hand"></a>
185
+ </div>
186
+ <!-- parallax img -->
187
+ <img class="parallax-move" data-vertical-position="900" data-horizontal-position="100" src="img/background/1.png">
188
+ <img class="parallax-move" data-vertical-position="1600" data-horizontal-position="700" src="img/background/2.png">
189
+ <img class="parallax-move" data-vertical-position="0" data-horizontal-position="10" src="img/background/3.png">
190
+ <img class="parallax-move" data-vertical-position="500" data-horizontal-position="500" src="img/background/4.png">
191
+ <img class="parallax-move" data-vertical-position="400" src="img/background/5.png">
192
+ <img class="parallax-move" data-vertical-position="300" data-horizontal-position="100" src="img/background/6.png">
193
+ <img class="parallax-move" data-vertical-position="100" src="img/background/7.png">
139
194
  </div>
140
- <div class="content">
141
-
195
+
196
+
197
+ <!-- section 3 -->
198
+ <div id="section3">
199
+ <div class="list-usd">
200
+ <div class="uni">Universal System Description</div>
201
+ <!-- Indicators -->
202
+ <ol class="carousel-indicators">
203
+ <li data-target="#carousel-example-generic" data-slide-to="0"><div type="button" class="btn btn-default ">The tools</div></li>
204
+ <li data-target="#carousel-example-generic" data-slide-to="1"><div type="button" class="btn btn-default USDbutton">Physical to cloud</div></li>
205
+ <li data-target="#carousel-example-generic" data-slide-to="2"><div type="button" class="btn btn-default USDbutton">From SLE 11 to SLE 12</div></li>
206
+ <li data-target="#carousel-example-generic" data-slide-to="3"><div type="button" class="btn btn-default USDbutton">Configuration discovery</div></li>
207
+ <li data-target="#carousel-example-generic" data-slide-to="4"><div type="button" class="btn btn-default USDbutton">Validate and show</div></li>
208
+ </ol>
209
+
210
+ </div>
211
+
212
+ <div id="carousel-example-generic" class="carousel slide" data-ride="carousel">
213
+
214
+
215
+
216
+ <!-- Wrapper for slides -->
217
+ <div class="carousel-inner">
218
+ <div class="item active">
219
+
220
+ <div class="col-md-1"></div>
221
+ <div class="col-md-4 col-xs-12">
222
+ <div class="usecase">
223
+ <div class="text-gallery">
224
+ <div class="usecase-title">
225
+ The tools
226
+ </div>
227
+ The system administrator is in the center. Machinery offers a set of tools, which the administrator can combine to work flows. They work on an universal description of a system, which connects the tools. See examples for some use cases here.
228
+ </div>
229
+ </div>
230
+ </div>
231
+ <div class="col-md-6 col-xs-12 img-forusercase">
232
+ <img src="img/usecase-default.png">
233
+ </div>
234
+ </div><!-- close item 1 -->
235
+
236
+
237
+ <div class="item">
238
+
239
+ <div class="col-md-1"></div>
240
+ <div class="col-md-4 col-xs-12">
241
+ <div class="usecase">
242
+ <div class="text-gallery">
243
+ <div class="usecase-title">
244
+ Use case: Physical to cloud
245
+ </div>
246
+ Migrate a system from a physical system to the cloud. Inspect the physical system and create a system description. Export the description to a configuration for <a href="http://en.opensuse.org/Portal:KIWI">Kiwi</a> to build an image suitable for the cloud.
247
+ </div>
248
+ </div>
249
+ </div>
250
+ <div class="col-md-6 col-xs-12 img-forusercase">
251
+ <img src="img/usecase1.png">
252
+ </div>
253
+
254
+
255
+ </div>
256
+
257
+ <div class="item">
258
+
259
+ <div class="col-md-1"></div>
260
+ <div class="col-md-4 col-xs-12">
261
+ <div class="usecase">
262
+ <div class="text-gallery">
263
+ <div class="usecase-title">
264
+ Use case: From SLE 11 to SLE 12
265
+ </div>
266
+ Migrate a system from SLES 11 to SLES 12. Inspect the system to be migrated and create a system description. Let Machinery adapt the description to SLES 12. Build an image to deploy the system. See the <a href="https://github.com/SUSE/machinery/wiki/How-to-upgrade-a-SLES-11-SP3-system-to-SLES-12">how-to</a> in the Machinery Wiki for more details.
267
+ </div>
268
+ </div>
269
+ </div>
270
+ <div class="col-md-6 col-xs-12 img-forusercase">
271
+ <img src="img/usecase2.png">
272
+ </div>
273
+ </div>
274
+
275
+ <div class="item">
276
+ <div class="col-md-1"></div>
277
+ <div class="col-md-4 col-xs-12">
278
+ <div class="usecase">
279
+ <div class="text-gallery">
280
+ <div class="usecase-title">
281
+ Use case: Configuration discovery
282
+ </div>
283
+ Inspect a running system and write its configuration as a system description. The written description can be shown and analyzed offline. It can also be used to perform subsequent operation on it, such as building a system image from it
284
+ </div>
285
+ </div>
286
+ </div>
287
+ <div class="col-md-6 col-xs-12 img-forusercase">
288
+ <img src="img/usecase3.png">
289
+ </div>
290
+ </div>
291
+
292
+
293
+ <div class="item">
294
+ <div class="col-md-1"></div>
295
+ <div class="col-md-4 col-xs-12">
296
+ <div class="usecase">
297
+ <div class="text-gallery">
298
+ <div class="usecase-title">
299
+ Use case: Validate and show
300
+ </div>
301
+ Inspect a running system and write a system description. Validate the system by viewing the description and manually confirm expectations. Validate the system by comparing its system description to a reference and showing the differences.
302
+ </div>
303
+ </div>
304
+ </div>
305
+ <div class="col-md-6 col-xs-12 img-forusercase">
306
+ <img src="img/usecase4.png">
307
+ </div>
308
+
309
+ </div>
310
+
311
+
312
+
313
+ </div>
314
+
315
+ </div>
316
+
317
+
318
+
319
+
320
+ <div class="row">
321
+ <div class="col-md-12 continue" align="center">
322
+ <a href="#section4">Go to philosophy<img src="img/hand2.png" class="hand2"></a>
323
+ </div>
324
+ </div>
325
+
326
+
327
+
328
+
329
+
330
+ </div><!-- close section 3 -->
331
+ </div>
332
+
333
+
334
+ <!-- section 4 -->
335
+ <div class="row" id="section4">
336
+ <div class="col-md-3">
337
+ </div>
338
+
339
+ <div class="col-md-6 philo">
340
+ <div class="philo-text">
341
+ <h1 class="headline-philosophy" align="center">Philosophy</h1>
342
+ <img src="img/moustache.png" class="moustache">
343
+ <h2>Made for the system administrator of the data center</h2>
344
+ <p>Machinery is made for the system administrator managing many machines in the data center. It helps in an environment where a high degree of automation, integration of diverse tools, and accountable management are key.</p>
345
+ <h2>Universal system description</h2>
346
+ <p>The architecture and design of Machinery is based on the idea of a universal system description. This describes the content of a system. The description can be stored, compared to other descriptions, analyzed, modified, or used to replicate a system from a description. You can call it "offline systems management".</p>
347
+ <h2>Integrate, not duplicate</h2>
348
+ <p>Machinery is not another configuration management system or monitoring tool. We don't intend to duplicate something which is already there. We want to fill the gaps and address use cases which aren't covered by existing tools. We want to integrate with other tools and bring together what people use.</p>
349
+ <h2>Open toolbox</h2>
350
+ <p>Machinery is an open toolbox. It provides a framework and building blocks for covering a variety of advanced systems management use cases. It's meant to be extensible and to provide a foundation for adding more functionality needed by specific users and their work flows. We welcome contributions.</p> <h2>Agile development</h2>
351
+ <p>Machinery is an open source project, and there is a team behind it at <a href="http://suse.com">SUSE</a>. We develop it in an agile fashion. We do two-week sprints and do frequent stable releases. Needs of users drive our priorities. We value feedback and try to address it as good as we can. We strive to continually improve, not only the software, but also how we create it.</p>
352
+ <h2>Technical excellence</h2>
353
+ <p>We hold ourself to high technical standards. We do mandatory code reviews, test-driven development, continuous integration and builds. We follow technical trends and consciously choose tools and frameworks.</p>
354
+ </div>
355
+ </div>
356
+
357
+ <div class="col-md-3">
358
+ </div>
359
+
360
+ <div class="col-md-offset-3 col-md-6 footer">
361
+ <a href="https://github.com/SUSE/machinery/issues">Questions, Feedback, Suggestions</a>
362
+ <div class="credit">© <a href="http://suse.com">SUSE</a> 2014-2018</div>
363
+ </div>
364
+
365
+
142
366
  </div>
143
367
  </div>
368
+ <!--====== JQuery Libraries ========== -->
369
+ <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
370
+ <script src="js/jquery.js"></script>
371
+ <script src="js/parallaxImg.js" type="text/javascript"></script>
372
+ <!-- Include all compiled plugins (below), or include individual files as needed -->
373
+ <script src="js/bootstrap.min.js"></script>
374
+ <script src="js/custom.js"></script>
375
+ <script type="text/javascript" src="js/skrollr.min.js"></script>
376
+ <script type="text/javascript">
377
+ $(document).on("ready",function(){
378
+ if (document.documentElement.clientWidth > 500) {
379
+ var s = skrollr.init();
380
+ }
381
+ })
382
+ </script>
383
+
384
+ <!-- Piwik -->
385
+ <script type="text/javascript">
386
+ var _paq = _paq || [];
387
+ _paq.push(['trackPageView']);
388
+ _paq.push(['enableLinkTracking']);
389
+ (function() {
390
+ var u="//beans.opensuse.org/piwik/";
391
+ _paq.push(['setTrackerUrl', u+'piwik.php']);
392
+ _paq.push(['setSiteId', 26]);
393
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
394
+ g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
395
+ })();
396
+ </script>
397
+ <noscript><p><img src="//beans.opensuse.org/piwik/piwik.php?idsite=26" style="border:0;" alt="" /></p></noscript>
398
+ <!-- End Piwik Code -->
144
399
  </body>
145
400
  </html>