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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f19976fc2cd485e40e924ca5d471ae7d02af64443b99d44e10fa62e6b6433175
4
- data.tar.gz: 7b79b1b6dd3f7dad21febe96778d67dcd371271803b1ca2ecbe503a54462f54f
3
+ metadata.gz: b18ff32b6319d09cbda47049eee1615b4e30841325b599ca6ea6d9701741f080
4
+ data.tar.gz: 99cc37dd02776c8580589dc9b44017b95e83c81981ddce4f9006c330aed7072a
5
5
  SHA512:
6
- metadata.gz: dedaef9777f8160c200668fa035d4379bb3170e2040b7fa7da7777877a91737f3ac0c8052a077907825a53ef91c80470214065ce2c7011d603708ae0153077e3
7
- data.tar.gz: f2f3031be5d4fceca617ce9a0983d7c33b7f41ce402d7a3659b2268ff5386798d706b64fe8be8945fb5be8800b399cf87a48310abb4a2c6ec583c69f89cc5662
6
+ metadata.gz: e64c43a7f6554d08b5abb244b5439e390e16a49e870b357130e6fee63ef0af4cf38f7204187c0f33a40a63cd58963157afda78f4577c4789845f3945e8b15f15
7
+ data.tar.gz: b2de5d3f8b6b33d6a68bc795768b7cd70ca7e798c2840748b05ba00a87b453ac7cb1c1fd2d995fbebd9baf389306e6ad40553aa0311481246f7b9128de4e2040
@@ -1 +1 @@
1
- e489dbe0ef8a31fd814f1d8d8bc97725fa57c96a
1
+ 0fe812a08b84a1705f01d3a878ff4c9c3597c583
data/NEWS CHANGED
@@ -1,6 +1,10 @@
1
1
  # Machinery Release Notes
2
2
 
3
3
 
4
+ ## Version 1.24.1 - Wed Jul 03 15:27:23 CEST 2019 - thardeck@suse.de
5
+
6
+ * Fix HTML man page
7
+
4
8
  ## Version 1.24.0 - Tue Jul 02 15:22:38 CEST 2019 - thardeck@suse.de
5
9
 
6
10
  * Switch image building support from legacy Kiwi to Kiwi Next Generation
@@ -25,7 +25,7 @@ class Machinery::ManTask
25
25
  )[:description]
26
26
  scope_doc + "\n"
27
27
  end.join
28
- File.write("manual/docs/machinery_main_scopes.1.md", docs)
28
+ File.write("manual/docs/docs/machinery_main_scopes.1.md", docs)
29
29
  Dir.chdir(File.join(Machinery::ROOT, "manual")) do
30
30
  Cheetah.run("mkdocs", "build")
31
31
  end
@@ -17,6 +17,6 @@
17
17
 
18
18
  module Machinery
19
19
 
20
- VERSION = "1.24.0"
20
+ VERSION = "1.24.1"
21
21
 
22
22
  end
@@ -2,4 +2,4 @@
2
2
 
3
3
  package main
4
4
 
5
- const VERSION = "e489dbe0ef8a31fd814f1d8d8bc97725fa57c96a"
5
+ const VERSION = "0fe812a08b84a1705f01d3a878ff4c9c3597c583"
Binary file
File without changes
@@ -2,12 +2,12 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8"/>
5
- <link href="{{ base_url }}/custom.css" rel="stylesheet">
5
+ <link href="{{ base_url }}/css/custom.css" rel="stylesheet">
6
6
  </head>
7
7
  <body id="manpage">
8
8
  <div id="back">
9
9
  <a href="{{ base_url }}">
10
- <img src="../hand3.png" class="hand3"/>
10
+ <img src="{{ base_url }}/img/hand3.png" class="hand3"/>
11
11
  <div class="goback">Go back to the web site</div>
12
12
  </a>
13
13
  </div>
@@ -20,14 +20,14 @@
20
20
  <ul>
21
21
  {% for nav_item in nav_item.children %}
22
22
  <li class="{% if nav_item.active%}current{%endif%}">
23
- <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
23
+ <a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
24
24
  </li>
25
25
  {% endfor %}
26
26
  </ul>
27
27
  </li>
28
28
  {% else %}
29
29
  <li class="{% if nav_item.active%}current{%endif%}">
30
- <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
30
+ <a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
31
31
  </li>
32
32
  {% endif %}
33
33
 
@@ -35,7 +35,7 @@
35
35
  </ul>
36
36
  </div>
37
37
  <div class="content">
38
- {{ content }}
38
+ {{ page.content }}
39
39
  </div>
40
40
  </div>
41
41
  </body>
@@ -40,7 +40,8 @@ ol.man-decor {width:100%}
40
40
  ol.man-decor li.tl {text-align:left}
41
41
  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
42
  ol.man-decor li.tr {text-align:right;float:right}
43
-
43
+ tr th {text-decoration:underline;padding-left:20pt;}
44
+ td {padding-left:20pt;}
44
45
 
45
46
  body {
46
47
  background: #bcb7a5;
@@ -786,3 +787,18 @@ font-size: 16px;
786
787
  .embed-responsive-4by3 {
787
788
  padding-bottom: 75%;
788
789
  }
790
+
791
+ .mp {
792
+ width: 980px;
793
+ margin: auto;
794
+ }
795
+
796
+ .nav {
797
+ float: right;
798
+ width: 250px;
799
+ }
800
+
801
+ .content {
802
+ float: left;
803
+ width: 670px;
804
+ }
@@ -42,4 +42,4 @@ flows. Machinery is targeted at the system administrator of the data center.
42
42
  - Machinery can help you to upgrade without affecting the original system.
43
43
  For more details please read the Wiki Page: [How to upgrade a SLES 11 SP3 system to SLES 12](https://github.com/SUSE/machinery/wiki/How-to-upgrade-a-SLES-11-SP3-system-to-SLES-12).
44
44
 
45
- For a more detailed overview see [General Overview](machinery_main_general.1/).
45
+ For a more detailed overview see [General Overview](machinery_main_general.1.md).
@@ -37,11 +37,11 @@ trigger errors.
37
37
 
38
38
  * `-s SCOPE`, `--scope=SCOPE` (optional):
39
39
  Inspect image for specified scope.
40
- See the [Scope section](machinery_main_scopes.1/) for more information.
40
+ See the [Scope section](machinery_main_scopes.1.md) for more information.
41
41
 
42
42
  * `-e SCOPE`, `--ignore-scope=IGNORE-SCOPE` (optional):
43
43
  Inspect image for all scopes except the specified scope.
44
- See the [Scope section](machinery_main_scopes.1/) for more information.
44
+ See the [Scope section](machinery_main_scopes.1.md) for more information.
45
45
 
46
46
  * `-x`, `--extract-files` (optional):
47
47
  Extract changed configuration and unmanaged files from the inspected container.
@@ -35,11 +35,11 @@ Tasks on Debian-like systems are treated as patterns.
35
35
 
36
36
  * `-s SCOPE`, `--scope=SCOPE` (optional):
37
37
  Inspect system for specified scope.
38
- See the [Scope section](machinery_main_scopes.1/) for more information.
38
+ See the [Scope section](machinery_main_scopes.1.md) for more information.
39
39
 
40
40
  * `-e SCOPE`, `--ignore-scope=IGNORE-SCOPE` (optional):
41
41
  Inspect system for all scopes except the specified scope.
42
- See the [Scope section](machinery_main_scopes.1/) for more information.
42
+ See the [Scope section](machinery_main_scopes.1.md) for more information.
43
43
 
44
44
  * `-r USER`, `--remote-user=USER` (optional):
45
45
  Defines the user which is used to access the inspected system via SSH.
@@ -22,13 +22,13 @@ in local time are shown in the title of each scope section.
22
22
 
23
23
  * `-s SCOPE`, `--scope=SCOPE` (optional):
24
24
  Limit output to the specified scope.
25
- See the [Scope section](machinery_main_scopes.1/) for more information.
25
+ See the [Scope section](machinery_main_scopes.1.md) for more information.
26
26
  If displaying information related to a scope fails, `show` will print an error message what has failed.
27
27
  In case of an error, no content is displayed.
28
28
 
29
29
  * `-e IGNORE-SCOPE`, `--ignore-scope=IGNORE-SCOPE` (optional):
30
30
  Skip output of the specified scope.
31
- See the [Scope section](machinery_main_scopes.1/) for more information.
31
+ See the [Scope section](machinery_main_scopes.1.md) for more information.
32
32
 
33
33
  * `--no-pager` (optional):
34
34
  Do not pipe output into a pager.
@@ -84,7 +84,7 @@ repositories, or changed configuration files.
84
84
  For example, if you are only interested in the installed packages, limit the
85
85
  scope to `packages`. This will output only the requested information.
86
86
 
87
- See the [Scopes documentation](machinery_main_scopes.1/) for a list of all supported scopes.
87
+ See the [Scopes documentation](machinery_main_scopes.1.md) for a list of all supported scopes.
88
88
 
89
89
  # Options for All Subcommands
90
90
  <!--- These are 'global' options of machinery -->
@@ -6,7 +6,7 @@ Machinery.
6
6
  ## Inspection
7
7
 
8
8
  Machinery inspects several parts of a system which are covered by Machinery's scopes.
9
- Information about scopes is listed [here](machinery_main_scopes.1/).
9
+ Information about scopes is listed [here](machinery_main_scopes.1.md).
10
10
 
11
11
  Users of Machinery who inspect systems need to be aware of the security implications
12
12
  to take the right decisions on how to protect the retrieved data.
@@ -14,7 +14,7 @@ to take the right decisions on how to protect the retrieved data.
14
14
  ## Retrieval of Data
15
15
  Machinery transfers data from one end point to another via SSH (Secure Shell, using public key authentication).
16
16
 
17
- Depending on the scope, Machinery [collects information](machinery_main_scopes.1/)
17
+ Depending on the scope, Machinery [collects information](machinery_main_scopes.1.md)
18
18
  about files on the system. Additionally, when the `--extract-files` option is given for the
19
19
  `inspect` command, not only the meta data about the files (e.g. permission bits, owner, group etc
20
20
  .) but also the file content is extracted. Machinery does not distinguish between sensitive
@@ -24,7 +24,7 @@ description has automatically access to **all** extracted files and contained se
24
24
  #### root/sudo Privileges
25
25
  An inspection can only be done, when the user on the inspected system is either root or has
26
26
  sudo privileges. Information about the required sudo configuration can be found
27
- [here](machinery-inspect.1/#prerequisites).
27
+ [here](machinery-inspect.1.md#prerequisites).
28
28
 
29
29
  ## Storage of Data
30
30
  #### Access Restrictions
@@ -1,32 +1,46 @@
1
1
  site_name: Machinery Documentation
2
- pages:
3
- - Welcome: docs.md
4
- - "General Overview": machinery_main_general.1.md
5
- - Scopes: machinery_main_scopes.1.md
6
- - "Use cases": machinery_main_usecases.1.md
7
- - "Security Implications": machinery_main_security_implications.1.md
2
+ nav:
3
+ - Welcome: docs/index.md
4
+ - "General Overview": docs/machinery_main_general.1.md
5
+ - Scopes: docs/machinery_main_scopes.1.md
6
+ - "Use cases": docs/machinery_main_usecases.1.md
7
+ - "Security Implications": docs/machinery_main_security_implications.1.md
8
8
  - Commands:
9
- - Analyze: machinery-analyze.1.md
10
- - Build: machinery-build.1.md
11
- - Compare: machinery-compare.1.md
12
- - Config: machinery-config.1.md
13
- - Copy: machinery-copy.1.md
14
- - Deploy: machinery-deploy.1.md
15
- - "Export AutoYaST": machinery-export-autoyast.1.md
16
- - "Export Kiwi": machinery-export-kiwi.1.md
17
- - "Export HTML": machinery-export-html.1.md
18
- - Inspect: machinery-inspect.1.md
19
- - "Inspect Container": machinery-inspect-container.1.md
20
- - List: machinery-list.1.md
21
- - Man: machinery-man.1.md
22
- - Move: machinery-move.1.md
23
- - Remove: machinery-remove.1.md
24
- - Serve: machinery-serve.1.md
25
- - Show: machinery-show.1.md
26
- - "Upgrade Format": machinery-upgrade-format.1.md
27
- - Validate: machinery-validate.1.md
9
+ - Analyze: docs/machinery-analyze.1.md
10
+ - Build: docs/machinery-build.1.md
11
+ - Compare: docs/machinery-compare.1.md
12
+ - Config: docs/machinery-config.1.md
13
+ - Copy: docs/machinery-copy.1.md
14
+ - Deploy: docs/machinery-deploy.1.md
15
+ - "Export AutoYaST": docs/machinery-export-autoyast.1.md
16
+ - "Export Kiwi": docs/machinery-export-kiwi.1.md
17
+ - "Export HTML": docs/machinery-export-html.1.md
18
+ - Inspect: docs/machinery-inspect.1.md
19
+ - "Inspect Container": docs/machinery-inspect-container.1.md
20
+ - List: docs/machinery-list.1.md
21
+ - Man: docs/machinery-man.1.md
22
+ - Move: docs/machinery-move.1.md
23
+ - Remove: docs/machinery-remove.1.md
24
+ - Serve: docs/machinery-serve.1.md
25
+ - Show: docs/machinery-show.1.md
26
+ - "Upgrade Format": docs/machinery-upgrade-format.1.md
27
+ - Validate: docs/machinery-validate.1.md
28
28
  theme:
29
- name: mkdocs
29
+ name: null
30
30
  custom_dir: custom_theme
31
31
  extra_templates:
32
32
  - 'index.html'
33
+ extra_css:
34
+ - 'custom.css'
35
+ - 'css/bootstrap.min.css'
36
+ - 'css/custom.css'
37
+ - 'css/fixed-positioning.css'
38
+ extra_javascript:
39
+ - 'js/bootstrap.min.js'
40
+ - 'js/custom.js'
41
+ - 'js/jquery.js'
42
+ - 'js/jquery.nicescroll.min.js'
43
+ - 'js/jquery.pageslide.min.js'
44
+ - 'js/parallaxImg.js'
45
+ - 'js/skrollr.min.js'
46
+ strict: true
@@ -40,7 +40,8 @@ ol.man-decor {width:100%}
40
40
  ol.man-decor li.tl {text-align:left}
41
41
  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
42
  ol.man-decor li.tr {text-align:right;float:right}
43
-
43
+ tr th {text-decoration:underline;padding-left:20pt;}
44
+ td {padding-left:20pt;}
44
45
 
45
46
  body {
46
47
  background: #bcb7a5;
@@ -786,3 +787,18 @@ font-size: 16px;
786
787
  .embed-responsive-4by3 {
787
788
  padding-bottom: 75%;
788
789
  }
790
+
791
+ .mp {
792
+ width: 980px;
793
+ margin: auto;
794
+ }
795
+
796
+ .nav {
797
+ float: right;
798
+ width: 250px;
799
+ }
800
+
801
+ .content {
802
+ float: left;
803
+ width: 670px;
804
+ }
@@ -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
9
  <a href="..">
10
- <img src="../hand3.png" class="hand3"/>
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,7 +17,7 @@
17
17
 
18
18
 
19
19
  <li class="current">
20
- <a href="docs/">Welcome</a>
20
+ <a href="./">Welcome</a>
21
21
  </li>
22
22
 
23
23
 
@@ -138,7 +138,52 @@
138
138
  </ul>
139
139
  </div>
140
140
  <div class="content">
141
-
141
+ <h1 id="machinery-documentation">Machinery Documentation</h1>
142
+ <p>Welcome! The Machinary documentation is a reference aimed at system administrators.
143
+ It will give you an overview of Machinery itself, its subcommands, and usage examples.</p>
144
+ <h1 id="what-is-machinery">What is Machinery?</h1>
145
+ <p>Machinery is a systems management toolkit for Linux. It supports configuration
146
+ discovery, system validation, and service migration. Machinery is based on the
147
+ idea of a universal system description. Machinery has a set of commands which
148
+ work with this system description. These commands can be combined to form work
149
+ flows. Machinery is targeted at the system administrator of the data center.</p>
150
+ <h1 id="work-flow-examples">Work Flow Examples</h1>
151
+ <h2 id="inspect-a-system-and-show-results">Inspect a System and Show Results</h2>
152
+ <ul>
153
+ <li><code>machinery inspect --extract-files --name=NAME HOSTNAME</code></li>
154
+ <li><code>machinery show NAME</code></li>
155
+ </ul>
156
+ <h2 id="export-system-description-as-html">Export System Description as HTML</h2>
157
+ <ul>
158
+ <li><code>machinery export-html --html-dir=tmp NAME</code></li>
159
+ </ul>
160
+ <h2 id="inspect-two-systems-and-compare-them">Inspect Two Systems and Compare Them</h2>
161
+ <ul>
162
+ <li><code>machinery inspect HOSTNAME1</code></li>
163
+ <li><code>machinery inspect HOSTNAME2</code></li>
164
+ <li><code>machinery compare HOSTNAME1 HOSTNAME2</code></li>
165
+ </ul>
166
+ <h2 id="fully-inspect-a-system-and-export-a-kiwi-description">Fully Inspect a System and Export a Kiwi Description</h2>
167
+ <ul>
168
+ <li><code>machinery inspect --extract-files HOSTNAME</code></li>
169
+ <li><code>machinery export-kiwi --kiwi-dir=~/kiwi HOSTNAME</code></li>
170
+ </ul>
171
+ <h2 id="fully-inspect-a-system-and-export-an-autoyast-profile">Fully Inspect a System and Export an AutoYaST Profile</h2>
172
+ <ul>
173
+ <li><code>machinery inspect --extract-files HOSTNAME</code></li>
174
+ <li><code>machinery export-autoyast --autoyast-dir=~/autoyast HOSTNAME</code></li>
175
+ </ul>
176
+ <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>
177
+ <ul>
178
+ <li><code>machinery inspect --extract-files HOSTNAME</code></li>
179
+ <li><code>machinery deploy --cloud-config=~/openrc.sh HOSTNAME</code></li>
180
+ </ul>
181
+ <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>
182
+ <ul>
183
+ <li>Machinery can help you to upgrade without affecting the original system.
184
+ For more details please read the Wiki Page: <a href="https://github.com/SUSE/machinery/wiki/How-to-upgrade-a-SLES-11-SP3-system-to-SLES-12">How to upgrade a SLES 11 SP3 system to SLES 12</a>.</li>
185
+ </ul>
186
+ <p>For a more detailed overview see <a href="machinery_main_general.1/">General Overview</a>.</p>
142
187
  </div>
143
188
  </div>
144
189
  </body>
@@ -0,0 +1,174 @@
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="">
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="current">
58
+ <a href="./">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="analyze-analyze-system-description">analyze — Analyze System Description</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery analyze</code> NAME -o | --operation=OPERATION</p>
144
+ <p><code>machinery</code> help analyze</p>
145
+ <h2 id="description">Description</h2>
146
+ <p>The <code>analyze</code> subcommand analyzes an existing system description and enriches
147
+ it with additional information. Supported operations are:</p>
148
+ <ul>
149
+ <li><code>changed-config-files-diffs</code>:
150
+ Generates the diffs between the extracted changed configuration files from the
151
+ system and the original versions from the packages.
152
+ The diffs can be shown using <code>machinery show --show-diffs</code></li>
153
+ </ul>
154
+ <h2 id="arguments">Arguments</h2>
155
+ <ul>
156
+ <li><code>NAME</code> (required):
157
+ Name of the system description.</li>
158
+ </ul>
159
+ <h2 id="options">Options</h2>
160
+ <ul>
161
+ <li><code>-o OPERATION</code>, <code>--operation=OPERATION</code> (required):
162
+ The analyze operation to perform.</li>
163
+ </ul>
164
+ <h2 id="examples">Examples</h2>
165
+ <ul>
166
+ <li>
167
+ <p>Analyze the config file diffs for the <code>myhost</code> system description:</p>
168
+ <p>$ <code>machinery</code> analyze myhost --operation=changed-config-files-diffs</p>
169
+ </li>
170
+ </ul>
171
+ </div>
172
+ </div>
173
+ </body>
174
+ </html>