RubyGems - machinery-tool - Versions diffs - 1.17.0 → 1.18.0 - Mend

machinery-tool 1.17.0 → 1.18.0

Files changed (310) hide show

checksums.yaml +4 -4
data/.git_revision +1 -1
data/NEWS +17 -1
data/bin/machinery +1 -1
data/export_helpers/merge_users_and_groups.pl.erb +1 -1
data/html/comparison.html.haml +14 -9
data/html/index.html.haml +5 -2
data/html/landing_page.html.haml +4 -1
data/html/partials/changed_managed_files.html.haml +2 -0
data/html/partials/compare/alert.html.haml +1 -1
data/html/partials/compare/unmanaged_file_list.html.haml +12 -0
data/html/partials/config_files.html.haml +2 -0
data/html/partials/landing_page/alert.html.haml +1 -1
data/html/partials/unmanaged_files.html.haml +14 -0
data/inspect_helpers/changed_files.sh +1 -1
data/inspect_helpers/dpkg_unmanaged_files.sh +1 -1
data/inspect_helpers/yum_repositories.py +1 -1
data/lib/analyze_config_file_diffs_task.rb +1 -1
data/lib/array.rb +1 -1
data/lib/autoyast.rb +34 -34
data/lib/build_task.rb +1 -1
data/lib/cli.rb +21 -6
data/lib/compare_task.rb +1 -1
data/lib/comparison.rb +1 -1
data/lib/config.rb +1 -1
data/lib/config_base.rb +1 -1
data/lib/config_task.rb +1 -1
data/lib/constants.rb +2 -2
data/lib/containerize_task.rb +1 -1
data/lib/containerized_app.rb +1 -1
data/lib/copy_task.rb +1 -1
data/lib/current_user.rb +1 -1
data/lib/deploy_task.rb +1 -1
data/lib/docker_system.rb +4 -5
data/lib/dpkg_database.rb +2 -2
data/lib/element_filter.rb +1 -1
data/lib/exceptions.rb +2 -2
data/lib/export_task.rb +1 -1
data/lib/exporter.rb +1 -1
data/lib/file_diff.rb +1 -1
data/lib/file_scope.rb +1 -1
data/lib/file_validator.rb +1 -1
data/lib/filter.rb +1 -1
data/lib/filter_option_parser.rb +1 -1
data/lib/helper.rb +1 -1
data/lib/hint.rb +1 -1
data/lib/html.rb +1 -1
data/lib/inspect_task.rb +1 -1
data/lib/inspector.rb +1 -1
data/lib/json_schema_monkey_patch.rb +35 -0
data/lib/json_validation_error_cleaner.rb +1 -1
data/lib/json_validator.rb +1 -1
data/lib/kiwi_config.rb +69 -67
data/lib/list_task.rb +1 -1
data/lib/local_system.rb +1 -1
data/lib/logged_cheetah.rb +1 -1
data/lib/machinery.rb +6 -2
data/lib/machinery_helper.rb +28 -8
data/lib/machinery_logger.rb +1 -1
data/lib/man_task.rb +50 -5
data/lib/managed_files_database.rb +24 -17
data/lib/manifest.rb +3 -2
data/lib/migration.rb +1 -1
data/lib/mountpoints.rb +1 -1
data/lib/move_task.rb +1 -1
data/lib/object.rb +1 -1
data/lib/remote_system.rb +2 -2
data/lib/remove_task.rb +1 -1
data/lib/renderer.rb +1 -1
data/lib/renderer_helper.rb +1 -1
data/lib/rpm.rb +1 -1
data/lib/rpm_database.rb +1 -1
data/lib/scope.rb +1 -1
data/lib/scope_file_store.rb +1 -1
data/lib/serve_html_task.rb +1 -1
data/lib/server.rb +32 -2
data/lib/show_task.rb +1 -1
data/lib/system.rb +1 -1
data/lib/system_description.rb +2 -2
data/lib/system_description_memory_store.rb +1 -1
data/lib/system_description_store.rb +1 -1
data/lib/system_file.rb +1 -1
data/lib/tarball.rb +1 -1
data/lib/tee_io.rb +39 -0
data/lib/try.rb +1 -1
data/lib/ui.rb +1 -1
data/lib/upgrade_format_task.rb +1 -1
data/lib/validate_task.rb +1 -1
data/lib/version.rb +2 -2
data/lib/workload_mapper.rb +1 -1
data/lib/workload_mapper_dsl.rb +1 -1
data/lib/zypper.rb +3 -3
data/machinery-helper/Rakefile +2 -8
data/machinery-helper/file_utils.go +28 -0
data/machinery-helper/file_utils_test.go +21 -0
data/machinery-helper/machinery_helper.go +121 -8
data/machinery-helper/machinery_helper_test.go +102 -0
data/machinery-helper/mountpoints_test.go +33 -33
data/machinery-helper/version.go +1 -1
data/man/generated/machinery.1.gz +0 -0
data/manual/custom_theme/base.html +42 -0
data/manual/docs/CNAME +1 -0
data/manual/docs/README.md +128 -0
data/manual/docs/css/bootstrap.min.css +7 -0
data/manual/docs/css/custom.css +788 -0
data/manual/docs/css/fixed-positioning.css +45 -0
data/manual/docs/custom.css +804 -0
data/manual/docs/docs.md +7 -0
data/manual/docs/favicon.png +0 -0
data/manual/docs/hand3.png +0 -0
data/manual/docs/img/arrow.png +0 -0
data/manual/docs/img/background/1.png +0 -0
data/manual/docs/img/background/2.png +0 -0
data/manual/docs/img/background/3.png +0 -0
data/manual/docs/img/background/4.png +0 -0
data/manual/docs/img/background/5.png +0 -0
data/manual/docs/img/background/6.png +0 -0
data/manual/docs/img/background/7.png +0 -0
data/manual/docs/img/bk-cloud.png +0 -0
data/manual/docs/img/bk-sec-15.png +0 -0
data/manual/docs/img/book.png +0 -0
data/manual/docs/img/configuration-discovery.png +0 -0
data/manual/docs/img/dot-line-left.png +0 -0
data/manual/docs/img/dot-line-right.png +0 -0
data/manual/docs/img/gear.png +0 -0
data/manual/docs/img/gear2.png +0 -0
data/manual/docs/img/gear3.png +0 -0
data/manual/docs/img/hand.png +0 -0
data/manual/docs/img/hand2.png +0 -0
data/manual/docs/img/hand3.png +0 -0
data/manual/docs/img/home2.png +0 -0
data/manual/docs/img/moustache.png +0 -0
data/manual/docs/img/navig.png +0 -0
data/manual/docs/img/philo.png +0 -0
data/manual/docs/img/service-migration.png +0 -0
data/manual/docs/img/system-validation.png +0 -0
data/manual/docs/img/ticket2.png +0 -0
data/manual/docs/img/usecase-default.png +0 -0
data/manual/docs/img/usecase1.png +0 -0
data/manual/docs/img/usecase2.png +0 -0
data/manual/docs/img/usecase3.png +0 -0
data/manual/docs/img/usecase4.png +0 -0
data/manual/docs/img/wheels.png +0 -0
data/manual/docs/index.html +402 -0
data/manual/docs/js/bootstrap.min.js +6 -0
data/manual/docs/js/custom.js +148 -0
data/manual/docs/js/jquery.js +4 -0
data/manual/docs/js/jquery.nicescroll.min.js +116 -0
data/manual/docs/js/jquery.pageslide.min.js +11 -0
data/manual/docs/js/parallaxImg.js +146 -0
data/manual/docs/js/skrollr.min.js +2 -0
data/manual/docs/machinery-analyze.1.md +37 -0
data/manual/docs/machinery-build.1.md +62 -0
data/manual/docs/machinery-compare.1.md +63 -0
data/manual/docs/machinery-config.1.md +45 -0
data/manual/docs/machinery-copy.1.md +31 -0
data/manual/docs/machinery-deploy.1.md +71 -0
data/manual/docs/machinery-export-autoyast.1.md +58 -0
data/manual/docs/machinery-export-kiwi.1.md +38 -0
data/manual/docs/machinery-inspect-docker.1.md +108 -0
data/manual/docs/machinery-inspect.1.md +145 -0
data/manual/docs/machinery-list.1.md +51 -0
data/manual/docs/machinery-man.1.md +16 -0
data/manual/docs/machinery-move.1.md +29 -0
data/manual/docs/machinery-remove.1.md +44 -0
data/manual/docs/machinery-serve.1.md +45 -0
data/manual/docs/machinery-show.1.md +63 -0
data/manual/docs/machinery-upgrade-format.1.md +47 -0
data/manual/docs/machinery-validate.1.md +34 -0
data/manual/docs/machinery.ymp +114 -0
data/manual/docs/machinery_main_general.1.md +139 -0
data/manual/docs/machinery_main_scopes.1.md +98 -0
data/manual/docs/machinery_main_usecases.1.md +49 -0
data/manual/docs/machinery_security_implications.1.md +89 -0
data/manual/docs/subcommand-template.1.md +46 -0
data/manual/docs/wheels.png +0 -0
data/manual/mkdocs.yml +30 -0
data/manual/site/CNAME +1 -0
data/manual/site/base.html +42 -0
data/manual/site/css/bootstrap.min.css +7 -0
data/manual/site/css/custom.css +788 -0
data/manual/site/css/fixed-positioning.css +45 -0
data/manual/site/custom.css +804 -0
data/manual/site/docs/index.html +144 -0
data/manual/site/favicon.png +0 -0
data/manual/site/hand3.png +0 -0
data/manual/site/img/arrow.png +0 -0
data/manual/site/img/background/1.png +0 -0
data/manual/site/img/background/2.png +0 -0
data/manual/site/img/background/3.png +0 -0
data/manual/site/img/background/4.png +0 -0
data/manual/site/img/background/5.png +0 -0
data/manual/site/img/background/6.png +0 -0
data/manual/site/img/background/7.png +0 -0
data/manual/site/img/bk-cloud.png +0 -0
data/manual/site/img/bk-sec-15.png +0 -0
data/manual/site/img/book.png +0 -0
data/manual/site/img/configuration-discovery.png +0 -0
data/manual/site/img/dot-line-left.png +0 -0
data/manual/site/img/dot-line-right.png +0 -0
data/manual/site/img/gear.png +0 -0
data/manual/site/img/gear2.png +0 -0
data/manual/site/img/gear3.png +0 -0
data/manual/site/img/hand.png +0 -0
data/manual/site/img/hand2.png +0 -0
data/manual/site/img/hand3.png +0 -0
data/manual/site/img/home2.png +0 -0
data/manual/site/img/moustache.png +0 -0
data/manual/site/img/navig.png +0 -0
data/manual/site/img/philo.png +0 -0
data/manual/site/img/service-migration.png +0 -0
data/manual/site/img/system-validation.png +0 -0
data/manual/site/img/ticket2.png +0 -0
data/manual/site/img/usecase-default.png +0 -0
data/manual/site/img/usecase1.png +0 -0
data/manual/site/img/usecase2.png +0 -0
data/manual/site/img/usecase3.png +0 -0
data/manual/site/img/usecase4.png +0 -0
data/manual/site/img/wheels.png +0 -0
data/manual/site/index.html +402 -0
data/manual/site/js/bootstrap.min.js +6 -0
data/manual/site/js/custom.js +148 -0
data/manual/site/js/jquery.js +4 -0
data/manual/site/js/jquery.nicescroll.min.js +116 -0
data/manual/site/js/jquery.pageslide.min.js +11 -0
data/manual/site/js/parallaxImg.js +146 -0
data/manual/site/js/skrollr.min.js +2 -0
data/manual/site/machinery-analyze.1/index.html +167 -0
data/manual/site/machinery-build.1/index.html +198 -0
data/manual/site/machinery-compare.1/index.html +200 -0
data/manual/site/machinery-config.1/index.html +175 -0
data/manual/site/machinery-copy.1/index.html +164 -0
data/manual/site/machinery-deploy.1/index.html +200 -0
data/manual/site/machinery-export-autoyast.1/index.html +188 -0
data/manual/site/machinery-export-kiwi.1/index.html +169 -0
data/manual/site/machinery-inspect-docker.1/index.html +242 -0
data/manual/site/machinery-inspect.1/index.html +283 -0
data/manual/site/machinery-list.1/index.html +180 -0
data/manual/site/machinery-man.1/index.html +148 -0
data/manual/site/machinery-move.1/index.html +162 -0
data/manual/site/machinery-remove.1/index.html +175 -0
data/manual/site/machinery-serve.1/index.html +174 -0
data/manual/site/machinery-show.1/index.html +199 -0
data/manual/site/machinery-upgrade-format.1/index.html +173 -0
data/manual/site/machinery-validate.1/index.html +161 -0
data/manual/site/machinery.ymp +114 -0
data/manual/site/machinery_main_general.1/index.html +260 -0
data/manual/site/machinery_main_scopes.1/index.html +242 -0
data/manual/site/machinery_main_usecases.1/index.html +182 -0
data/manual/site/machinery_security_implications.1/index.html +223 -0
data/manual/site/mkdocs/js/lunr-0.5.7.min.js +7 -0
data/manual/site/mkdocs/js/mustache.min.js +1 -0
data/manual/site/mkdocs/js/require.js +36 -0
data/manual/site/mkdocs/js/search-results-template.mustache +4 -0
data/manual/site/mkdocs/js/search.js +88 -0
data/manual/site/mkdocs/js/text.js +390 -0
data/manual/site/mkdocs/search_index.json +824 -0
data/manual/site/sitemap.xml +152 -0
data/manual/site/wheels.png +0 -0
data/plugins/changed_managed_files/changed_managed_files_inspector.rb +1 -1
data/plugins/changed_managed_files/changed_managed_files_model.rb +1 -1
data/plugins/changed_managed_files/changed_managed_files_renderer.rb +1 -1
data/plugins/changed_managed_files/schema/system-description-changed-managed-files.schema-v7.json +160 -0
data/plugins/config_files/config_files_inspector.rb +1 -1
data/plugins/config_files/config_files_model.rb +1 -1
data/plugins/config_files/config_files_renderer.rb +1 -1
data/plugins/config_files/schema/system-description-config-files.schema-v7.json +160 -0
data/plugins/environment/environment_inspector.rb +1 -1
data/plugins/environment/environment_model.rb +1 -1
data/plugins/environment/schema/system-description-environment.schema-v7.json +17 -0
data/plugins/groups/groups_inspector.rb +1 -1
data/plugins/groups/groups_model.rb +1 -1
data/plugins/groups/groups_renderer.rb +1 -1
data/plugins/groups/schema/system-description-groups.schema-v7.json +49 -0
data/plugins/os/os_inspector.rb +1 -1
data/plugins/os/os_model.rb +1 -1
data/plugins/os/os_renderer.rb +1 -1
data/plugins/os/schema/system-description-os.schema-v7.json +21 -0
data/plugins/packages/packages_inspector.rb +1 -1
data/plugins/packages/packages_model.rb +1 -1
data/plugins/packages/packages_renderer.rb +1 -1
data/plugins/packages/schema/system-description-packages.schema-v7.json +115 -0
data/plugins/patterns/patterns_inspector.rb +6 -6
data/plugins/patterns/patterns_model.rb +1 -1
data/plugins/patterns/patterns_renderer.rb +1 -1
data/plugins/patterns/schema/system-description-patterns.schema-v7.json +58 -0
data/plugins/repositories/repositories_inspector.rb +16 -16
data/plugins/repositories/repositories_model.rb +1 -1
data/plugins/repositories/repositories_renderer.rb +1 -1
data/plugins/repositories/schema/system-description-repositories.schema-v7.json +165 -0
data/plugins/services/schema/system-description-services.schema-v7.json +93 -0
data/plugins/services/services_inspector.rb +1 -1
data/plugins/services/services_model.rb +1 -1
data/plugins/services/services_renderer.rb +1 -1
data/plugins/unmanaged_files/schema/system-description-unmanaged-files.schema-v6.json +19 -61
data/plugins/unmanaged_files/schema/system-description-unmanaged-files.schema-v7.json +124 -0
data/plugins/unmanaged_files/unmanaged_files_inspector.rb +21 -436
data/plugins/unmanaged_files/unmanaged_files_model.rb +2 -2
data/plugins/unmanaged_files/unmanaged_files_renderer.rb +2 -2
data/plugins/users/schema/system-description-users.schema-v7.json +86 -0
data/plugins/users/users_inspector.rb +1 -1
data/plugins/users/users_model.rb +1 -1
data/plugins/users/users_renderer.rb +1 -1
data/schema/migrations/migrate1to2.rb +1 -1
data/schema/migrations/migrate6to7.rb +38 -0
data/schema/system-description-global.schema-v7.json +43 -0
data/tools/go.rb +92 -0
data/tools/helper_builder.rb +16 -49
metadata +182 -6
data/man/generated/machinery.1.html +0 -1399

data/man/generated/machinery.1.html DELETED Viewed

@@ -1,1399 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta http-equiv='content-type' value='text/html;charset=utf8'>
-  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
-  <title>machinery(1) - Machinery — A Systems Management Toolkit for Linux</title>
-  <style type='text/css' media='all'>
-  /* style: man */
-  body#manpage {margin:0}
-  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
-  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
-  .mp h2 {margin:10px 0 0 0}
-  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
-  .mp h3 {margin:0 0 0 4ex}
-  .mp dt {margin:0;clear:left}
-  .mp dt.flush {float:left;width:8ex}
-  .mp dd {margin:0 0 0 9ex}
-  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
-  .mp pre {margin-bottom:20px}
-  .mp pre+h2,.mp pre+h3 {margin-top:22px}
-  .mp h2+pre,.mp h3+pre {margin-top:5px}
-  .mp img {display:block;margin:auto}
-  .mp h1.man-title {display:none}
-  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
-  .mp h2 {font-size:16px;line-height:1.25}
-  .mp h1 {font-size:20px;line-height:2}
-  .mp {text-align:justify;background:#fff}
-  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
-  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
-  .mp u {text-decoration:underline}
-  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
-  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
-  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
-  .mp b.man-ref {font-weight:normal;color:#434241}
-  .mp pre {padding:0 4ex}
-  .mp pre code {font-weight:normal;color:#434241}
-  .mp h2+pre,h3+pre {padding-left:0}
-  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
-  ol.man-decor {width:100%}
-  ol.man-decor li.tl {text-align:left}
-  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
-  ol.man-decor li.tr {text-align:right;float:right}
-  </style>
-</head>
-<!--
-  The following styles are deprecated and will be removed at some point:
-  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
-  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
-  .man-navigation should be used instead.
--->
-<body id='manpage'>
-  <div class='mp' id='man'>
-  <div class='man-navigation' style='display:none'>
-    <a href="#SYNOPSIS">SYNOPSIS</a>
-    <a href="#DESCRIPTION">DESCRIPTION</a>
-    <a href="#WORK-FLOW-EXAMPLES">WORK FLOW EXAMPLES</a>
-    <a href="#CONCEPTUAL-OVERVIEW">CONCEPTUAL OVERVIEW</a>
-    <a href="#OPTIONS-FOR-ALL-SUBCOMMANDS">OPTIONS FOR ALL SUBCOMMANDS</a>
-    <a href="#analyze-Analyze-System-Description">analyze — Analyze System Description</a>
-    <a href="#build-Build-Image-from-System-Description">build — Build Image from System Description</a>
-    <a href="#compare-Compare-System-Descriptions">compare — Compare System Descriptions</a>
-    <a href="#config-Configure-Machinery">config — Configure Machinery</a>
-    <a href="#copy-Copy-System-Description">copy — Copy System Description</a>
-    <a href="#deploy-Deploy-Image-to-OpenStack-Cloud">deploy — Deploy Image to OpenStack Cloud</a>
-    <a href="#export-autoyast-Export-System-Description-as-AutoYasST-profile">export-autoyast — Export System Description as AutoYasST profile</a>
-    <a href="#export-kiwi-Export-System-Description-as-KIWI-Image-Description">export-kiwi — Export System Description as KIWI Image Description</a>
-    <a href="#inspect-Inspect-Running-System">inspect — Inspect Running System</a>
-    <a href="#inspect-container-Inspect-Container">inspect-container — Inspect Container</a>
-    <a href="#list-List-System-Descriptions">list — List System Descriptions</a>
-    <a href="#man-Shows-Man-Page">man — Shows Man Page</a>
-    <a href="#move-Move-System-Description">move — Move System Description</a>
-    <a href="#remove-Remove-System-Descriptions">remove — Remove System Descriptions</a>
-    <a href="#serve-Serve-System-Descriptions-Using-A-Web-Server">serve — Serve System Descriptions Using A Web Server</a>
-    <a href="#show-Show-System-Description">show — Show System Description</a>
-    <a href="#upgrade-format-Upgrade-System-Description">upgrade-format — Upgrade System Description</a>
-    <a href="#validate-Validate-System-Description">validate — Validate System Description</a>
-    <a href="#FILES-AND-DEVICES">FILES AND DEVICES</a>
-    <a href="#ENVIRONMENT">ENVIRONMENT</a>
-    <a href="#COPYRIGHT">COPYRIGHT</a>
-  </div>
-  <ol class='man-decor man-head man head'>
-    <li class='tl'>machinery(1)</li>
-    <li class='tc'></li>
-    <li class='tr'>machinery(1)</li>
-  </ol>
-  <h1>Machinery — A Systems Management Toolkit for Linux</h1>
-<!--
-General procedure:
-1. Add the short description of a new command into the COMMANDS section
-2. Copy the subcommand-template.1.md to machinery-SUBCOMMAND.1.md
-3. Insert your description in your machinery-SUBCOMMAND.1.md file
--->
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-<p><code>machinery</code> SUBCOMMAND [options] <br />
-<code>machinery</code> help [SUBCOMMAND]</p>
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-<p>Machinery is a systems management toolkit for Linux. It supports configuration
-discovery, system validation, and service migration. Machinery is based on the
-idea of an universal system description. Machinery has a set of commands which
-work with this system description. These commands can be combined to form work
-flows. Machinery is targeted at the system administrator of the data center.</p>
-<h2 id="WORK-FLOW-EXAMPLES">WORK FLOW EXAMPLES</h2>
-<h3 id="Inspect-a-System-and-Show-Results">Inspect a System and Show Results</h3>
-<ul>
-<li><code>machinery inspect --extract-files --name=NAME HOSTNAME</code></li>
-<li><code>machinery show NAME</code></li>
-</ul>
-<h3 id="Inspect-Two-Systems-and-Compare-Them">Inspect Two Systems and Compare Them</h3>
-<ul>
-<li><code>machinery inspect HOSTNAME1</code></li>
-<li><code>machinery inspect HOSTNAME2</code></li>
-<li><code>machinery compare HOSTNAME1 HOSTNAME2</code></li>
-</ul>
-<h3 id="Fully-Inspect-a-System-and-Export-a-Kiwi-Description">Fully Inspect a System and Export a Kiwi Description</h3>
-<ul>
-<li><code>machinery inspect --extract-files HOSTNAME</code></li>
-<li><code>machinery export-kiwi --kiwi-dir=~/kiwi HOSTNAME</code></li>
-</ul>
-<h3 id="Fully-Inspect-a-System-and-Export-an-AutoYaST-Profile">Fully Inspect a System and Export an AutoYaST Profile</h3>
-<ul>
-<li><code>machinery inspect --extract-files HOSTNAME</code></li>
-<li><code>machinery export-autoyast --autoyast-dir=~/autoyast HOSTNAME</code></li>
-</ul>
-<h3 id="Fully-Inspect-a-System-and-Deploy-a-Replicate-to-the-Cloud">Fully Inspect a System and Deploy a Replicate to the Cloud</h3>
-<ul>
-<li><code>machinery inspect --extract-files HOSTNAME</code></li>
-<li><code>machinery deploy --cloud-config=~/openrc.sh HOSTNAME</code></li>
-</ul>
-<h3 id="How-to-upgrade-a-SLES-11-SP3-system-to-SLES-12">How to upgrade a SLES 11 SP3 system to SLES 12</h3>
-<ul>
-<li>Machinery can help you to upgrade without affecting the original system.
-For more details please read the Wiki Page: <br />
-https://github.com/SUSE/machinery/wiki/How-to-upgrade-a-SLES-11-SP3-system-to-SLES-12</li>
-</ul>
-<h2 id="CONCEPTUAL-OVERVIEW">CONCEPTUAL OVERVIEW</h2>
-<p>Machinery's core concept is the complete representation of a system by a
-universal system description.
-System descriptions are managed independently of the described
-systems which allows for system state conservation and offline preparation of
-modifications.</p>
-<p>Machinery's subcommands work on the system description as the connecting
-element.
-System descriptions are obtained by inspecting systems, importing from other
-formats, manual creation or merging other descriptions.
-Machinery can store and modify system descriptions to allow changes to
-described state of the system.
-System descriptions can be compared to find similarities and differences
-between them or analyzed to deepen the knowledge about particular aspects of
-the system.
-System descriptions may be exported to other formats and can be used to
-migrate or replicate systems.</p>
-<p>Subcommands can be combined in different ways to accomodate higher-level work
-flows and use cases.
-These are some implemented and planned use cases:</p>
-<p>Migrate a physical system to a virtual environment:</p>
-<ul>
-<li>Inspect a system to obtain a system description</li>
-<li>Export the system description to a Kiwi configuration</li>
-<li>Build a cloud image from the configuration</li>
-<li>Deploy the image to the cloud</li>
-</ul>
-<p>Migrate a system while changing the configuration:</p>
-<ul>
-<li>Inspect a system to obtain a system description</li>
-<li>Modify the system description</li>
-<li>Build image for deployment</li>
-</ul>
-<p>Using Machinery as an extension from other formats:</p>
-<ul>
-<li>Import AutoYaST profile as system description</li>
-<li>Build image for deployment</li>
-</ul>
-<p>Machinery provides an extensible set of tools which can be combined to create
-higher-level work flows.
-It is designed for environments which focus on automation, integration
-of diverse tools and accountable management.
-Machinery integrates with existing configuration management solutions to
-address use cases currently not covered by them.</p>
-<h3 id="The-machinery-Command">The machinery Command</h3>
-<p>Machinery is implemented as a command line tool named <code>machinery</code>. The
-<code>machinery</code> command has several subcommands for specific tasks. All
-subcommands work with the same system description identified by an optional
-name which can be used by all subcommands.</p>
-<h3 id="Scopes">Scopes</h3>
-<p>The system description is structured into "scopes". A scope covers a specific
-part of the configuration of the inspected system such as installed packages,
-repositories, or configuration files.</p>
-<p>For example, if you are only interested in the installed packages, limit the
-scope to <code>packages</code>. This will output only the requested information.</p>
-<p>Machinery supports the following scopes:</p>
-<ul>
-<li>os</li>
-</ul>
-<p>Contains information about the operating system, name, version, and
-architecture of the inspected system.</p>
-<ul>
-<li>packages</li>
-</ul>
-<p>Contains information on all installed RPM packages installed on the
-inspected system.</p>
-<ul>
-<li>patterns</li>
-</ul>
-<p>Contains all patterns installed on the inspected system. A pattern is a
-collection of software packages.
-The meaning of software patterns depends on the package manager of the
-distribution. Therefore, the pattern scope on SUSE based systems uses the
-<code>zypper</code> command to obtain the information about installed pattern names.</p>
-<ul>
-<li>repositories</li>
-</ul>
-<p>Contains all information about software repositories configured on the
-inspected system. The information about repositories depends on the package
-manager of the distribution. Thus on SUSE-based systems the <code>zypper</code> command
-is used. Machinery collects the following information from each configured repository:</p>
-<ul>
-<li><p>The alias name of the repository.</p></li>
-<li><p>The repository type, rpm-md and YaST types that are used on SUSE systems.</p></li>
-<li><p>The path to the repository. This could be a local path, a remote location,
-a device, or a file.</p></li>
-<li><p>A boolean flag that indicates if this repository is in use or not.</p></li>
-<li><p>A boolean flag that indicates if this repository should update the locally
-stored metadata files with metadata files from the origin automatically or
-not.</p></li>
-<li><p>A boolean flag that indicates if packages which would be installed from
-this repository should be checked by their gpg key or not.</p></li>
-<li><p>A numeric value for a priority. The priority of a repository is compared
-to the priorities of all other activated repositories. Values can
-range from 1 (highest) to 99 (lowest, default).</p></li>
-<li><p>users</p></li>
-</ul>
-<p>Contains information about the system users including user and group ids,
-login information, such as password hashes and - if available - additional
-password properties.</p>
-<ul>
-<li>groups</li>
-</ul>
-<p>Contains information about the system groups such as group attributes and the
-list of group members.</p>
-<ul>
-<li>services</li>
-</ul>
-<p>Services are applications running in the background doing continuous work
-or waiting for requests to do work.
-The scope determines which services are configured to be started in which
-runlevel. It uses the <code>chkconfig</code> command to obtain that information.
-The xinetd services that are also displayed by <code>chkconfig</code> are switched
-on/off by editing config files and are ignored in this context.</p>
-<ul>
-<li>config_files</li>
-</ul>
-<p>Contains all configuration files which have been changed since they were
-installed.
-Configuration files are all those files which are marked as such in the
-package which has installed them. A configuration file change is reported
-if its content or its attributes like Linux permission bits or ownership
-have changed.</p>
-<ul>
-<li>changed_managed_files</li>
-</ul>
-<p>Contains the names and contents of all non-configuration files which have
-been changed compared to the files in the package. A file change is reported
-if its content or its attributes like Linux permission bits or ownership
-have changed.</p>
-<ul>
-<li>unmanaged_files</li>
-</ul>
-<p>Contains the names and contents of all files which are not part of any RPM
-package. The list of unmanaged files contains only plain files and
-directories. Special files like device nodes, named pipes and Unix domain
-sockets are ignored. The directories <code>/tmp</code>,  <code>/var/tmp</code>, <code>/.snapshots/</code>,
-<code>/var/run</code> and special mounts like procfs and sysfs are ignored, too.
-If a directory is in this list, no file or directory below it belongs to a
-RPM package.</p>
-<p>Meta data information of unmanaged files is only available if the files were
-extracted during inspection.</p>
-<p>Using the <code>--extract-unmanaged-files</code> option, the files are transferred from
-the system and stored in the system description. Depending on the content of
-the inspected system, the amount of data stored may be huge.</p>
-<h3 id="System-Description">System Description</h3>
-<p>The System Description format and file structure is documented in the machinery
-wiki: <a href="https://github.com/SUSE/machinery/wiki/System-Description-Format" data-bare-link="true">https://github.com/SUSE/machinery/wiki/System-Description-Format</a></p>
-<p>Machinery validates descriptions on load. It checks that the JSON structure of
-the manifest file, which contains the primary and meta data of a description, is
-correct and it adheres to the schema. Validation errors are reported as warnings.
-It also checks that the information about extracted files is consistent. Missing
-files or extra files without reference in the manifest are treated also as
-warnings. All other issues are errors which need to be fixed so that Machinery
-can use the description</p>
-<p>To manually validate a description use the <code>machinery validate</code> command.</p>
-<h3 id="Use-Cases">Use Cases</h3>
-<p>Some of the important use cases of Machinery are:</p>
-<ul>
-<li><p>Inspecting a System and Collecting Information</p>
-<p>Collecting a variety of information. Limit the gathered
-information with scopes (see section about scopes). Each inspection step
-updates the system description.</p></li>
-<li><p>Reviewing System Description</p>
-<p>After a successful inspection, the system description can be displayed on
-the console or the output can be fed into other tools.</p></li>
-<li><p>Cloning a System</p>
-<p>An inspected system can be cloned. The inspection step returns a system
-description which is used as the basis for cloning physical or virtual
-instances. Machinery can build a system image from the description, which
-can then for example be deployed to a cloud.</p></li>
-</ul>
-<h2 id="OPTIONS-FOR-ALL-SUBCOMMANDS">OPTIONS FOR ALL SUBCOMMANDS</h2>
-<dl>
-<dt><code>--version</code></dt><dd><p>Displays version of <code>machinery</code> tool. Exit when done.</p></dd>
-<dt class="flush"><code>--debug</code></dt><dd><p>Enable debug mode. Machinery writes additional information into the log
-file which can be useful to track down problems.</p></dd>
-</dl>
-<h2 id="analyze-Analyze-System-Description">analyze — Analyze System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery analyze</code> NAME -o | --operation=OPERATION</p>
-<p><code>machinery</code> help analyze</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>analyze</code> subcommand analyzes an existing system description and enriches
-it with additional information. Supported operations are:</p>
-<dl>
-<dt><code>config-file-diffs</code></dt><dd>Generates the diffs between the extracted changed config files from the
-system and the original versions from the RPM packages.
-The diffs can be shown using <code>machinery show --show-diffs</code></dd>
-</dl>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Name of the system description.</dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-o OPERATION</code>, <code>--operation=OPERATION</code> (required)</dt><dd>The analyze operation to perform.</dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Analyze the config file diffs for the <code>myhost</code> system description:</dt><dd><p></p>
-<p>$ <code>machinery</code> analyze myhost --operation=config-file-diffs</p></dd>
-</dl>
-<h2 id="build-Build-Image-from-System-Description">build — Build Image from System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery build</code> NAME -i IMAGE-DIR | --image-dir=IMAGE-DIR</p>
-<p><code>machinery</code> help build</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>build</code> command builds an image from a system description. The image is a
-system image in the qcow2 format, which can be used with the KVM hypervisor.
-It can be run locally or deployed to a cloud environment.</p>
-<p><code>machinery</code> uses the image building command line tool
-<a href="http://en.opensuse.org/Portal:KIWI">KIWI</a> to perform the actual build. KIWI
-data is stored to a temporary directory and cleaned up after the build. The KIWI
-log is shown as output of the <code>build</code> command format for showing progress and
-diagnosing errors.</p>
-<p>When building an image, Machinery filters out some files which would break the
-built image. The list of filters is shown at the beginning of the build.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Use specified system description.</dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-i IMAGE-DIR</code>, <code>--image-dir=IMAGE-DIR</code> (required)</dt><dd><p>Save image file under specified path.</p></dd>
-<dt><code>-d</code>, <code>--enable-dhcp</code> (optional)</dt><dd><p>Enable DHCP client on first network card of built image</p></dd>
-<dt><code>-s</code>, <code>--enable-ssh</code> (optional)</dt><dd><p>Enable SSH service in built image</p></dd>
-</dl>
-<h3 id="PREREQUISITES">PREREQUISITES</h3>
-<ul>
-<li><p>The <code>build</code> command requires the packages <code>kiwi</code> and <code>kiwi-desc-vmxboot</code>.</p></li>
-<li><p>The necessary vmxboot template for the machinery being built must be
-installed (i.e. if you want to build an openSUSE Leap machine then the
-template <code>/usr/share/kiwi/image/vmxboot/suse-leap42.1</code> is required)</p></li>
-<li><p>All repositories in the system description must be accessible from the
-build machine on which <code>machinery build</code> is called.</p></li>
-<li><p>Machinery can only build x86_64 images on x86_64 systems at the moment.</p></li>
-</ul>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<ul>
-<li><p>To build an image from the system description named "tux" and to save the
-image under the <code>/tmp/tux/</code> directory:</p>
-<p>$ <code>machinery</code> build tux -i /tmp/tux/</p></li>
-</ul>
-<h2 id="compare-Compare-System-Descriptions">compare — Compare System Descriptions</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery compare</code> [-s SCOPE | --scope=SCOPE] [-e EXCLUDE-SCOPE | --exclude-scope=EXCLUDE-SCOPE] [--no-pager] [--show-all] [--html] NAME1 NAME2</p>
-<p><code>machinery</code> help compare</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>compare</code> command compares stored system descriptions. The scope option can
-be used to limit the output to the given scopes.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME1</code> (required)</dt><dd><p>First system description to compare.</p></dd>
-<dt><code>NAME2</code> (required)</dt><dd><p>Second system description to compare.</p></dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional)</dt><dd><p>Limit output to the specified scope.
-See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
-<dt><code>-e SCOPE</code>, <code>--exclude-scope=EXCLUDE-SCOPE</code> (optional)</dt><dd><p>Skip output of the specified scope.
-See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
-<dt><code>--no-pager</code> (optional)</dt><dd><p>Do not pipe output into a pager.</p></dd>
-<dt><code>--show-all</code> (optional)</dt><dd><p>Show also common properties of the descriptions (not only the differences).</p></dd>
-<dt><code>--html</code> (optional)</dt><dd><p>Shows the comparison of two system descriptions in the web browser.</p></dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<ul>
-<li><p>Compare system descriptions saved as <code>earth</code> and <code>moon</code>:</p>
-<p>$ <code>machinery</code> compare earth moon</p></li>
-<li><p>Compare system descriptions, but limit the scope to repositories only:</p>
-<p>$ <code>machinery</code> compare earth moon -s repositories</p></li>
-<li><p>Compare lists of changed managed files and include the common ones in the
-list:</p>
-<p>$ <code>machinery</code> compare earth moon --scope=changed-managed-files --show-all</p></li>
-<li><p>Compares system descriptions and shows the result in HTML format in your web browser:</p>
-<p>  $ machinery compare --html earth moon</p></li>
-</ul>
-<h2 id="config-Configure-Machinery">config — Configure Machinery</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery config</code></p>
-<p><code>machinery config</code> KEY</p>
-<p><code>machinery config</code> KEY=VALUE</p>
-<p><code>machinery</code> help config</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>config</code> command shows or changes machinery's configuration.</p>
-<p>If no arguments are passed the <code>config</code> command lists all configuration
-entries and their values. If only the key is provided its value is shown.
-If key and value are specified this configuration entry is set accordingly.</p>
-<p>The configuration is stored in <code>~/.machinery/machinery.config</code>.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt class="flush"><code>KEY</code></dt><dd><p>Name of the configuration entry.</p></dd>
-<dt class="flush"><code>VALUE</code></dt><dd><p>Value of the configuration entry.</p></dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Turn off hints:</dt><dd><p></p>
-<p>$ <code>machinery</code> config hints=off</p></dd>
-<dt>Show current configuration of hints:</dt><dd><p></p>
-<p>$ <code>machinery</code> config hints</p></dd>
-<dt>List all configuration entries and their values:</dt><dd><p></p>
-<p>$ <code>machinery</code> config</p></dd>
-</dl>
-<h2 id="copy-Copy-System-Description">copy — Copy System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery copy</code>
-    FROM_NAME TO_NAME</p>
-<p><code>machinery</code> help copy</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>copy</code> command copies a stored system description. It creates a new
-description named TO_NAME containing the same content as the description
-FROM_NAME.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>FROM_NAME</code> (required)</dt><dd><p>Name of the source system description.</p></dd>
-<dt><code>TO_NAME</code> (required)</dt><dd><p>Name of the target system description.</p></dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Create a copy of the system description <code>earth</code> under the name <code>moon</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> copy earth moon</p></dd>
-</dl>
-<h2 id="deploy-Deploy-Image-to-OpenStack-Cloud">deploy — Deploy Image to OpenStack Cloud</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery deploy</code> NAME -c CONFIG_FILE | --cloud-config=CONFIG_FILE
-   [-i IMAGE_DIR | --image-dir=IMAGE_DIR]
-   [-n CLOUD_IMAGE_NAME | --cloud-image-name=CLOUD_IMAGE_NAME]
-   [-s | --insecure ]</p>
-<p><code>machinery</code> help [deploy]</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>deploy</code> command builds and deploys an image to an OpenStack cloud.
-This command is particularly useful for testing, debugging, or for validation.</p>
-<blockquote><h4 id="NOTE-Set-Password-for-Unattended-Work">NOTE: Set Password for Unattended Work</h4>
-<p>Machinery asks for a password when sourcing the configuration
-file. This interrupts the work flow and the user has to enter
-this password.
-If you prefer to leave it uninterrupted and unattented, remove
-the following line in your cloud configuration file (see the <code>-c</code> option):</p>
-<p>  read -s OS_PASSWORD_INPUT</p>
-<p>and set the password in the <code>OS_PASSWORD</code> variable:</p>
-<pre><code>export OS_PASSWORD=YOUR_PASSWORD
-</code></pre></blockquote>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Name of the system description.</dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-c CONFIG_FILE</code>, <code>--cloud-config=CONFIG_FILE</code> (required)</dt><dd><p>Path to file where the cloud config (openrc.sh) is located.
-The configuration file is sourced by Machinery.</p></dd>
-<dt><code>-i IMAGE_DIR</code>, <code>--image-dir=IMAGE_DIR</code> (optional)</dt><dd><p>Image file under specific path.</p></dd>
-<dt><code>-n CLOUD_IMAGE_NAME</code>, <code>--cloud-image-name=CLOUD_IMAGE_NAME</code> (required)</dt><dd><p>Name of the image in the cloud.</p></dd>
-<dt><code>-s</code>, <code>--insecure</code> (optional)</dt><dd><p>Allow to make "insecure" HTTPS requests, without checking the SSL
-certificate when uploading to the cloud.</p></dd>
-</dl>
-<h3 id="PREREQUISITES">PREREQUISITES</h3>
-<ul>
-<li>The <code>deploy</code> command requires the packages <code>kiwi</code> for building the image
-and <code>python-glanceclient</code> for uploading the image to the cloud.</li>
-</ul>
-<h3 id="SUPPORTED-ARCHITECTURES">SUPPORTED ARCHITECTURES</h3>
-<p>Machinery only supports deploying x86_64 images on x86_64 systems.</p>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<ul>
-<li><p>Build an image under the system description named <code>jeos</code>.
-Deploy it to the OpenStack cloud name <code>tux-cloud</code> by using the
-configuration file <code>openrc.sh</code> in directory <code>tux</code>:</p>
-<p>$ <code>machinery</code> deploy jeos -n tux-cloud -c tux/openrc.sh</p></li>
-</ul>
-<h2 id="export-autoyast-Export-System-Description-as-AutoYasST-profile">export-autoyast — Export System Description as AutoYasST profile</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery export-autoyast</code> -a | --autoyast-dir NAME
-   --force</p>
-<p><code>machinery</code> help export-autoyast</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>export-autoyast</code> subcommand exports a stored system description as a AutoYaST
-profile.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Name of the system description.</dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-a AUTOYAST_DIR</code>, <code>--autoyast-dir=AUTOYAST_DIR</code> (required)</dt><dd><p>Write the AutoYaST profile to a subdirectory at the specified directory. The directory
-will be created if it does not exist yet.</p></dd>
-<dt><code>--force</code> (optional)</dt><dd><p>Overwrite existing system description</p></dd>
-</dl>
-<h3 id="SYSTEM-REGISTRATION">SYSTEM REGISTRATION</h3>
-<ul>
-<li><p>To register a SLES 12 system automatically with AutoYaST, it is required to
-edit the generated profile. The following example registers the system with
-the SUSE Customer Center.</p>
-<pre><code class="xml">&lt;suse_register&gt;
-  &lt;do_registration config:type="boolean"&gt;true&lt;/do_registration&gt;
-  &lt;email&gt;tux@example.com&lt;/email&gt;
-  &lt;reg_code&gt;MY_SECRET_REGCODE&lt;/reg_code&gt;
-  &lt;install_updates config:type="boolean"&gt;true&lt;/install_updates&gt;
-  &lt;slp_discovery config:type="boolean"&gt;false&lt;/slp_discovery&gt;
-&lt;/suse_register&gt;
-</code></pre></li>
-<li>More information can be found at the SUSE AutoYaST documentation.
-https://www.suse.com/documentation/sles-12/singlehtml/book_autoyast/book_autoyast.html</li>
-</ul>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Export the <code>myhost</code> system description to <code>/tmp/myhost-autoyast</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> export-autoyast myhost --autoyast-dir=/tmp</p></dd>
-</dl>
-<h2 id="export-kiwi-Export-System-Description-as-KIWI-Image-Description">export-kiwi — Export System Description as KIWI Image Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery export-kiwi</code> -k | --kiwi-dir NAME
-   --force</p>
-<p><code>machinery</code> help export-kiwi</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>export-kiwi</code> subcommand exports a stored system description as a KIWI
-image description.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Name of the system description.</dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-k KIWI_DIR</code>, <code>--kiwi-dir=KIWI_DIR</code> (required)</dt><dd><p>Write the KIWI image description to a subdirectory at the specified directory. The directory
-will be created if it does not exist yet.</p></dd>
-<dt><code>--force</code> (optional)</dt><dd><p>Overwrite existing system description</p></dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Export the <code>myhost</code> system description to <code>/tmp/myhost-kiwi</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> export-kiwi myhost --kiwi-dir=/tmp</p></dd>
-</dl>
-<h2 id="inspect-Inspect-Running-System">inspect — Inspect Running System</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery inspect</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">OPTIONS</a> HOSTNAME</p>
-<p><code>machinery</code> help inspect</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>inspect</code> command inspects a running system and generates a system
-description from the gathered data.</p>
-<p>The system data is structured into scopes, controlled by the
-<code>--scope</code> option.</p>
-<p><strong>Note</strong>:
-Machinery will always inspect all specified scopes, and skip scopes which
-trigger errors.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>HOSTNAME</code> (required)</dt><dd>The host name of the system to be inspected. The host name will also be
-used as the name of the stored system description unless another name is
-provided with the <code>--name</code> option.</dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-n NAME</code>, <code>--name=NAME</code> (optional)</dt><dd><p>Store the system description under the specified name.</p></dd>
-<dt><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional)</dt><dd><p>Inspect system for specified scope.
-See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
-<dt><code>-e SCOPE</code>, <code>--exclude-scope=EXCLUDE-SCOPE</code> (optional)</dt><dd><p>Inspect system for all scopes except the specified scope.
-See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
-<dt><code>-r USER</code>, <code>--remote-user=USER</code> (optional)</dt><dd><p>Defines the user which is used to access the inspected system via SSH.
-This user needs to be allowed to run certain commands using sudo (see
-PREREQUISITES for more information).
-To change the default-user use <code>machinery config remote-user=USER</code></p></dd>
-<dt><code>-p SSH-PORT</code>, <code>--ssh-port SSH-PORT</code> (optional)</dt><dd><p>Specifies the SSH port of the remote SSH server.</p></dd>
-<dt><code>-i SSH-IDENTITY-FILE</code>, <code>--ssh-identity-file SSH-IDENTITY-FILE</code> (optional)</dt><dd><p>Specifies the SSH private key what should be used to authenticate with the
-remote SSH server. Keys with a passphrase are not allowed here. Use the ssh-agent
-instead.</p></dd>
-<dt><code>-x</code>, <code>--extract-files</code> (optional)</dt><dd><p>Extract changed configuration and unmanaged files from the inspected system.
-Shortcut for the combination of <code>--extract-changed-config-files</code>,
-<code>--extract-unmanaged-files</code>, and <code>--extract-changed-managed-files</code></p></dd>
-<dt><code>--extract-changed-config-files</code> (optional)</dt><dd><p>Extract changed configuration files from the inspected system.</p></dd>
-<dt><code>--extract-unmanaged-files</code> (optional)</dt><dd><p>Extract unmanaged files from the inspected system.</p></dd>
-<dt><code>--extract-changed-managed-files</code> (optional)</dt><dd><p>Extract changed managed files from inspected system.</p></dd>
-<dt><code>--skip-files</code> (optional)</dt><dd><p>Do not consider given files or directories during inspection. Either provide
-one file or directory name or a list of names separated by commas. You can
-also point to a file which contains a list of files to filter (one per line)
-by adding an '@' before the path, e.g.</p>
-<p>  $ <code>machinery</code> inspect --skip-files=@/path/to/filter_file myhost</p>
-<p>If a filename contains a comma it needs to be escaped, e.g.</p>
-<p>  $ <code>machinery</code> inspect --skip-files=/file\,with_comma myhost</p>
-<p><strong>Note</strong>: File or directory names are not expanded, e.g. '../path' is taken
-  literally and not expanded.</p></dd>
-<dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which are used during inspection.</p></dd>
-</dl>
-<h3 id="PREREQUISITES">PREREQUISITES</h3>
-<ul>
-<li><p>Inspecting a local system requires running <code>machinery</code> as root.</p></li>
-<li><p>Inspecting a remote system requires passwordless SSH login as root on the
-inspected system.
-Use <code>ssh-agent</code> or asymmetric keys (you can transfer the current SSH key
-via <code>ssh-copy-id</code> to the inspected host, e.g.: <code>ssh-copy-id root@HOSTNAME</code>)</p></li>
-<li><p>The system to be inspected needs to have the following commands:</p>
-<ul>
-<li><code>rpm</code> or <code>dpkg</code></li>
-<li><code>zypper</code>, <code>yum</code> or <code>apt-cache</code></li>
-<li><code>rsync</code></li>
-<li><code>chkconfig</code>, <code>initctl</code> or <code>systemctl</code></li>
-<li><code>cat</code></li>
-<li><code>sed</code></li>
-<li><code>find</code></li>
-<li><code>tar</code></li>
-</ul>
-</li>
-<li><p>When inspecting as non-root the user has to have the following command
-whitelist given in the sudoers file.</p>
-<dl>
-<dt>On rpm based systems, like SUSE or Red Hat:</dt><dd><p></p>
-<p>machinery ALL=(ALL) NOPASSWD: /usr/bin/find,/usr/bin/cat,/bin/cat,/usr/bin/rsync,/bin/rpm -Va *,/bin/tar --create *,/usr/bin/stat</p></dd>
-<dt>On dpkg based systems, like Debian or Ubuntu:</dt><dd><p></p>
-<p>machinery ALL=(ALL) NOPASSWD: /usr/bin/find,/usr/bin/cat,/bin/cat,/usr/bin/rsync,/bin/tar --create *,/usr/bin/stat,/usr/bin/dpkg,/bin/readlink</p></dd>
-</dl>
-</li>
-<li><p>To add a remote <code>machinery</code> user run as root:</p>
-<h1><code>useradd -m machinery -c "remote user for machinery"</code></h1>
-<p>To configure a password for the new user run:</p>
-<h1><code>passwd machinery</code></h1></li>
-</ul>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<ul>
-<li><p>Inspect remote system <code>myhost</code> and save system description under name
-'MySystem':</p>
-<p>$ <code>machinery</code> inspect --name=MySystem myhost</p></li>
-<li><p>Inspect the installed packages of your local system and save system description
-under the name 'localhost' (you need to become root):</p>
-<p># <code>machinery</code> inspect --scope="packages" localhost</p></li>
-<li><p>Extracts changed managed files and saves them in the same way as changed
-configuration files are saved:</p>
-<p>$ <code>machinery</code> inspect --scope=changed-managed-files --extract-files myhost</p></li>
-<li><p>To inspect the remote system <code>myhost</code> with the user <code>machinery</code>:</p>
-<p>$ <code>machinery</code> inspect --remote-user machinery myhost</p></li>
-</ul>
-<h2 id="inspect-container-Inspect-Container">inspect-container — Inspect Container</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery inspect-container</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">OPTIONS</a> IMAGENAME</p>
-<p><code>machinery inspect-container</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">OPTIONS</a> IMAGEID</p>
-<p><code>machinery</code> help inspect-container</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>inspect-container</code> command inspects a container image. It creates and starts the container from the provided image before inspection
-and generates a system description from the gathered data. After the inspection the container will be killed and removed again.
-This approach ensures that no containers and images are affected by the inspection.</p>
-<p>Right now we support only images from the type <code>docker</code>.</p>
-<p>The system data is structured into scopes, controlled by the
-<code>--scope</code> option.</p>
-<p><strong>Note</strong>:
-Machinery will always inspect all specified scopes, and skip scopes which
-trigger errors.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>IMAGENAME / IMAGEID</code> (required)</dt><dd>The name or id of the image to be inspected. The provided name or id will also be
-used as the name of the stored system description unless another name is
-provided with the <code>--name</code> option.</dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-n NAME</code>, <code>--name=NAME</code> (optional)</dt><dd><p>Store the system description under the specified name.</p></dd>
-<dt><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional)</dt><dd><p>Inspect image for specified scope.
-See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
-<dt><code>-e SCOPE</code>, <code>--exclude-scope=EXCLUDE-SCOPE</code> (optional)</dt><dd><p>Inspect image for all scopes except the specified scope.
-See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
-<dt><code>-x</code>, <code>--extract-files</code> (optional)</dt><dd><p>Extract changed configuration and unmanaged files from the inspected container.
-Shortcut for the combination of <code>--extract-changed-config-files</code>,
-<code>--extract-unmanaged-files</code>, and <code>--extract-changed-managed-files</code></p></dd>
-<dt><code>--extract-changed-config-files</code> (optional)</dt><dd><p>Extract changed configuration files from the inspected image.</p></dd>
-<dt><code>--extract-unmanaged-files</code> (optional)</dt><dd><p>Extract unmanaged files from the inspected image.</p></dd>
-<dt><code>--extract-changed-managed-files</code> (optional)</dt><dd><p>Extract changed managed files from inspected image.</p></dd>
-<dt><code>--skip-files</code> (optional)</dt><dd><p>Do not consider given files or directories during inspection. Either provide
-one file or directory name or a list of names separated by commas. You can
-also point to a file which contains a list of files to filter (one per line)
-by adding an '@' before the path, e.g.</p>
-<p>  $ <code>machinery</code> inspect-container --skip-files=@/path/to/filter_file mycontainer</p>
-<p>If a filename contains a comma it needs to be escaped, e.g.</p>
-<p>  $ <code>machinery</code> inspect-container --skip-files=/file\,with_comma mycontainer</p>
-<p><strong>Note</strong>: File or directory names are not expanded, e.g. '../path' is taken
-  literally and not expanded.</p></dd>
-<dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which are used during inspection.</p></dd>
-</dl>
-<h3 id="PREREQUISITES">PREREQUISITES</h3>
-<ul>
-<li><p>Inspecting a container requires an image specified by the name or id.</p></li>
-<li><p>The image to be inspected needs to have the following commands:</p>
-<ul>
-<li><code>rpm</code> or <code>dpkg</code></li>
-<li><code>zypper</code>, <code>yum</code> or <code>apt-cache</code></li>
-<li><code>rsync</code></li>
-<li><code>cat</code></li>
-<li><code>sed</code></li>
-<li><code>find</code></li>
-</ul>
-</li>
-</ul>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Inspect docker-container <code>mycontainer</code> and save system description under name 'MyContainer':</dt><dd><p></p>
-<p>$ <code>machinery</code> inspect-container --name=MyContainer mycontainer</p></dd>
-<dt>Inspect docker-container <code>076f46c1bef1</code> and save system description under name 'MySecondContainer':</dt><dd><p></p>
-<p>$ <code>machinery</code> inspect-container --name=MySecondContainer 076f46c1bef1</p></dd>
-<dt>Extracts changed managed files and saves them:</dt><dd><p></p>
-<p>$ <code>machinery</code> inspect-container --scope=changed-managed-files --extract-files mycontainer</p></dd>
-</dl>
-<h2 id="list-List-System-Descriptions">list — List System Descriptions</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery list</code> [OPTIONS] [NAME[,NAME2[,NAME3]]]</p>
-<p><code>machinery</code> help list</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>List the specified system descriptions if parameter name is given.
-List all available system descriptions in the internal database if no name parameter is given.
-The list is sorted alphabetically and contains a name and the
-scopes for each system.</p>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>--verbose</code> (optional)</dt><dd>Print additional information about the origin of scopes.
-Currently displays [HOSTNAME] and (DATE).</dd>
-<dt><code>--short</code> (optional)</dt><dd>List only descripton names.</dd>
-<dt><code>--html</code> (optional)</dt><dd>Run a web server and open the list of system descriptions in HTML format in
-your web browser using the <code>xdg-open</code> command.</dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Lists the two specified system descriptions <code>a</code> and <code>b</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> list a b</p></dd>
-<dt>Lists all available system descriptions:</dt><dd><p></p>
-<p>$ <code>machinery</code> list</p></dd>
-<dt>Same as previous command, but additionally prints the date of each scope:</dt><dd><p></p>
-<p>$ <code>machinery</code> list --verbose</p></dd>
-<dt>Lists all available system description names without any additional details:</dt><dd><p></p>
-<p>$ <code>machinery</code> list --short</p></dd>
-<dt>Opens HTML view of list of all available system descriptions in web browser:</dt><dd><p></p>
-<p>$ <code>machinery</code> list --html</p></dd>
-</dl>
-<h2 id="man-Shows-Man-Page">man — Shows Man Page</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p>  <code>machinery man</code></p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>man</code> command shows the Machinery man page.</p>
-<h2 id="move-Move-System-Description">move — Move System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery move</code>
-    FROM_NAME TO_NAME</p>
-<p><code>machinery</code> help move</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>move</code> command renames a stored system description from <code>FROM_NAME</code> to <code>TO_NAME</code>.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>FROM_NAME</code> (required)</dt><dd><p>Current name of the system description.</p></dd>
-<dt><code>TO_NAME</code> (required)</dt><dd><p>New name of the system description.</p></dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Rename the system description <code>earth</code> to <code>moon</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> move earth moon</p></dd>
-</dl>
-<h2 id="remove-Remove-System-Descriptions">remove — Remove System Descriptions</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery remove</code> [--all]
-    [NAME[,NAME2[,NAME3]]]</p>
-<p><code>machinery</code> help remove</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>remove</code> command removes all specified system descriptions.</p>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>--all</code> (optional)</dt><dd><p>Remove all stored system descriptions.</p></dd>
-<dt><code>--verbose</code> (optional)</dt><dd><p>Explain what is being done.</p></dd>
-</dl>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME...</code> (required)</dt><dd>Remove specified system descriptions.</dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Remove the system description stored as <code>earth</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> remove earth</p></dd>
-<dt>Remove the system descriptions stored as <code>earth</code> and <code>moon</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> remove earth moon</p></dd>
-<dt>Remove all stored system descriptions:</dt><dd><p></p>
-<p>$ <code>machinery</code> remove --all</p></dd>
-</dl>
-<h2 id="serve-Serve-System-Descriptions-Using-A-Web-Server">serve — Serve System Descriptions Using A Web Server</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery serve</code> [-p PORT | --port=PORT] [--public]</p>
-<p><code>machinery</code> help serve</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>serve</code> command spawns a web server to view system descriptions as an HTML
-view.</p>
-<p>By default the server is available from http://127.0.0.1:7585 but both the
-IP address and the port can be configured using the according options.</p>
-<p>Specific descriptions are available from http://127.0.0.1:7585/NAME, where NAME
-is the name of the system description. If no name is specified in the URL an
-overview of all descriptions is served.</p>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the HTML view: Default: 7585</p>
-<p>Ports can be selected in a range between 2-65535. Ports between 2 and 1023 can only be
-chosen when <code>machinery</code> will be executed as <code>root</code> user.</p></dd>
-<dt><code>--public</code> (optional)</dt><dd><p>Specifying this option, lets the server listen on each configured IP address. By default
-the server will only listen on the localhost IP address 127.0.0.1</p></dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Start the server with default options:</dt><dd><p></p>
-<p>$ <code>machinery</code> serve</p></dd>
-<dt>Make the server available to other machines on the network on port 3000:</dt><dd><p></p>
-<p>$ <code>machinery</code> serve --public --port 3000</p></dd>
-</dl>
-<h2 id="show-Show-System-Description">show — Show System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery show</code> [-s SCOPE | --scope=SCOPE] [-e EXCLUDE-SCOPE | --exclude-scope=EXCLUDE-SCOPE] [--no-pager] [--show-diffs] [--html] NAME</p>
-<p><code>machinery</code> help show</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>show</code> command displays a stored system description.
-Scopes are supported and limit the output to the given scope.
-The hostname of the inspected system and the last modification
-in local time are shown in the title of each scope section.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Use specified system description.</dd>
-</dl>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional)</dt><dd><p>Limit output to the specified scope.
-See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.
-If displaying information related to a scope fails, <code>show</code> will print an error message what has failed.
-In case of an error, no content is displayed.</p></dd>
-<dt><code>-e EXCLUDE-SCOPE</code>, <code>--exclude-scope=EXCLUDE-SCOPE</code> (optional)</dt><dd><p>Skip output of the specified scope.
-See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
-<dt><code>--no-pager</code> (optional)</dt><dd><p>Do not pipe output into a pager.</p></dd>
-<dt><code>--show-diffs</code> (optional)</dt><dd><p>Include the generated diffs in the output if available (see <code>machinery help analyze</code>
-for more information).</p></dd>
-<dt><code>--html</code> (optional)</dt><dd><p>Run a web server and open the system description in HTML format in your web browser using the
-<code>xdg-open</code> command.</p></dd>
-<dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which were applied before showing the system description.</p></dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Show the system description taken from the last inspection, saved as <code>earth</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> show earth</p></dd>
-<dt>Show the system description, but limit the scope to repositories only:</dt><dd><p></p>
-<p>$ <code>machinery</code> show earth -s repositories</p></dd>
-<dt>Show the list of changed managed files:</dt><dd><p></p>
-<p>$ <code>machinery</code> show earth --scope=changed-managed-files</p></dd>
-</dl>
-<h2 id="upgrade-format-Upgrade-System-Description">upgrade-format — Upgrade System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery upgrade-format</code> --all</p>
-<p><code>machinery upgrade-format</code> NAME</p>
-<p><code>machinery</code> help upgrade-format</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>upgrade-format</code> command upgrades a system description to the latest format
-version.</p>
-<p>The <code>format</code> in this context is the structure of the internal system description
-data. If the format version of a system description does not match the current
-<code>machinery</code> format version, <code>machinery</code> is no longer able to work with the data
-until it is upgraded. The current format version can be retrieved using
-<code>machinery --version</code>. The format version of a system description can be found
-in the <code>meta</code> section of the according <code>manifest.json</code> file.</p>
-<p>If the <code>--all</code> switch is given all local descriptions will be upgraded.</p>
-<h3 id="OPTIONS">OPTIONS</h3>
-<dl>
-<dt><code>--all</code> (optional)</dt><dd>Upgrade all stored system descriptions.</dd>
-</dl>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME</code> (optional)</dt><dd>Upgrade specified system description.</dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Upgrade the system description stored as <code>earth</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> upgrade-format earth</p></dd>
-<dt>Upgrade all stored system descriptions:</dt><dd><p></p>
-<p>$ <code>machinery</code> upgrade-format --all</p></dd>
-</dl>
-<h2 id="validate-Validate-System-Description">validate — Validate System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery validate</code> NAME</p>
-<p><code>machinery</code> help validate</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>validate</code> subcommand validates an existing system description.
-It checks, that the description has the correct structure and the data stored
-there conforms to the required schema. It also verifies that all extracted files
-are present on disk and that all files have meta information.</p>
-<p>In case of issues errors are shown with additional information.</p>
-<p>The main purpose of this command is to verify the system description after
-manually editing it.</p>
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Name of the system description.</dd>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<dt>Validate the system description with the name <code>myhost</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> validate myhost</p></dd>
-</dl>
-<h2 id="FILES-AND-DEVICES">FILES AND DEVICES</h2>
-<dl>
-<dt><code>~/.machinery/machinery.config</code>:</dt><dd><p></p>
-<p>Configuration file.</p></dd>
-<dt><code>~/.machinery/machinery.log</code>:</dt><dd><p></p>
-<p>Central log file, in the format date, time, process id, and log message.</p></dd>
-<dt><code>eth0</code> (SLE11) and <code>lan0</code> (SLE12):</dt><dd><p></p>
-<p>First network device is used when DHCP in built image is enabled.</p></dd>
-</dl>
-<h2 id="ENVIRONMENT">ENVIRONMENT</h2>
-<dl>
-<dt><code>MACHINERY_LOG_FILE</code>:</dt><dd><p></p>
-<p>Location of Machinery's log file (defaults to <code>~/.machinery/machinery.log</code>)</p></dd>
-</dl>
-<h2 id="COPYRIGHT">COPYRIGHT</h2>
-<p>Copyright (c) 2013-2015 <a href="http://www.suse.com">SUSE LLC</a></p>
-  <ol class='man-decor man-foot man foot'>
-    <li class='tl'></li>
-    <li class='tc'>January 2016</li>
-    <li class='tr'>machinery(1)</li>
-  </ol>
-  </div>
-</body>
-</html>