RubyGems - machinery-tool - Versions diffs - 1.0.2 → 1.1.0 - Mend

machinery-tool 1.0.2 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (20) hide show

checksums.yaml +4 -4
data/NEWS +8 -0
data/lib/cli.rb +2 -1
data/lib/hint.rb +5 -0
data/lib/kiwi_config.rb +4 -2
data/lib/local_system.rb +4 -3
data/lib/os.rb +12 -0
data/lib/remote_system.rb +3 -1
data/lib/renderer.rb +0 -7
data/lib/version.rb +1 -1
data/plugins/model/changed_managed_files_model.rb +2 -1
data/plugins/model/config_files_model.rb +2 -1
data/plugins/model/file_scope.rb +66 -0
data/plugins/model/unmanaged_files_model.rb +29 -1
data/plugins/show/changed_managed_files_renderer.rb +12 -5
data/plugins/show/config_files_renderer.rb +13 -6
data/plugins/show/unmanaged_files_renderer.rb +16 -10
metadata +120 -120
data/man/generated/machinery.1.gz +0 -0
data/man/generated/machinery.1.html +0 -1056

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

Binary file

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

@@ -1,1056 +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="#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-kiwi-Export-System-Description-as-KIWI-Image-Description">export-kiwi — Export System Description as KIWI Image Description</a>
-    <a href="#generate-html-Generate-an-HTML-view-of-a-System-Description">generate-html — Generate an HTML view of a System Description</a>
-    <a href="#inspect-Inspect-Running-System">inspect — Inspect Running System</a>
-    <a href="#list-List-System-Descriptions">list — List System Descriptions</a>
-    <a href="#remove-Remove-System-Description">remove — Remove System Description</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-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>
-<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><p>changed-managed-files</p>
-<p>Contains the names and contents of all non-configuration files which have
-been changed compared to the files in the package.</p></li>
-<li><p>config-files</p>
-<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 is considered changed
-if either its content or its Linux permission bits have changed.</p></li>
-<li><p>groups</p>
-<p>Contains information about the system groups such as group attributes and the
-list of group members.</p></li>
-<li><p>os</p>
-<p>Contains information about the operating system, name, version, and
-architecture of the inspected system.</p></li>
-<li><p>packages</p>
-<p>Contains information on all installed RPM packages installed on the
-inspected system.</p></li>
-<li><p>patterns</p>
-<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></li>
-<li><p>repositories</p>
-<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>
-</ul>
-</li>
-<li><p>services</p>
-<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></li>
-<li><p>unmanaged-files</p>
-<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>/sys</code>, <code>/dev</code>,
-<code>/.snapshots/</code>, and <code>/var/run</code> 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></li>
-<li><p>users</p>
-<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></li>
-</ul>
-<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>
-<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>
-<h1>analyze — Analyze System Description</h1>
-<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-vmbxoot</code>.</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>
-</ul>
-<h3 id="BUILD-SUPPORT-MATRIX">BUILD SUPPORT MATRIX</h3>
-<p>The following combinations of build hosts and targets are supported:</p>
-<ul>
-<li><p>SUSE Linux Enterprise 12</p>
-<p>Can build SUSE Linux Enterprise 12</p></li>
-<li><p>openSUSE 13.1</p>
-<p>Can build SUSE Linux Enterprise 11 and openSUSE 13.1</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] 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>
-</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>
-</ul>
-<h2 id="config-Configure-Machinery">config — Configure Machinery</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<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="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-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 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/export</code>:</dt><dd><p></p>
-<p>$ <code>machinery</code> export-kiwi myhost --kiwi-dir=/tmp/export</p></dd>
-</dl>
-<h2 id="generate-html-Generate-an-HTML-view-of-a-System-Description">generate-html — Generate an HTML view of a System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery generate-html</code> NAME</p>
-<p><code>machinery</code> help generate-html</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>generate-html</code> generates an HTML view of a system description. The
-index.html file can be found in the according system description directory, e.g.
-~/.machinery/NAME/index.html.</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>Create an HTML view of the <code>moon</code> system description:</dt><dd><p></p>
-<p>$ <code>machinery</code> generate-html moon</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>-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>
-</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></li>
-<li><code>zypper</code></li>
-<li><code>rsync</code></li>
-<li><code>chkconfig</code></li>
-<li><code>cat</code></li>
-<li><code>sed</code></li>
-<li><code>find</code></li>
-<li><code>tar</code></li>
-</ul>
-</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>
-</ul>
-<h2 id="list-List-System-Descriptions">list — List System Descriptions</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery list</code></p>
-<p><code>machinery</code> help list</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>List all available system descriptions in the internal database.
-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>
-</dl>
-<h3 id="EXAMPLES">EXAMPLES</h3>
-<dl>
-<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>
-</dl>
-<h2 id="remove-Remove-System-Description">remove — Remove System Description</h2>
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery remove</code> [--all]
-    NAME</p>
-<p><code>machinery</code> help remove</p>
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-<p>The <code>remove</code> command removes a stored system description.</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 description.</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 all stored system descriptions:</dt><dd><p></p>
-<p>$ <code>machinery</code> remove --all</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>Open the system description in HTML format in your web browser using the <code>xdg-open</code> command.</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-2014 <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'>November 2014</li>
-    <li class='tr'>machinery(1)</li>
-  </ol>
-  </div>
-</body>
-</html>