RubyGems - machinery-tool - Versions diffs - 1.24.0 → 1.24.1 - Mend

machinery-tool 1.24.0 → 1.24.1

Files changed (109) hide show

data/manual/site/docs/machinery-validate.1/index.html ADDED

@@ -0,0 +1,168 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8"/>
+    <link href="../../css/custom.css" rel="stylesheet">
+  </head>
+  <body id="manpage">
+    <div id="back">
+      <a href="../..">
+        <img src="../../img/hand3.png" class="hand3"/>
+        <div class="goback">Go back to the web site</div>
+      </a>
+    </div>
+    <div class="mp">
+      <div class="nav">
+        <ul>
+                  <li class="">
+                      <a href="../">Welcome</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_general.1/">General Overview</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_scopes.1/">Scopes</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_usecases.1/">Use cases</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_security_implications.1/">Security Implications</a>
+                  </li>
+                  <li>Commands
+                      <ul>
+                          <li class="">
+                              <a href="../machinery-analyze.1/">Analyze</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-build.1/">Build</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-compare.1/">Compare</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-config.1/">Config</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-copy.1/">Copy</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-deploy.1/">Deploy</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-html.1/">Export HTML</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-inspect.1/">Inspect</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-inspect-container.1/">Inspect Container</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-list.1/">List</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-man.1/">Man</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-move.1/">Move</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-remove.1/">Remove</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-serve.1/">Serve</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-show.1/">Show</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
+                          </li>
+                          <li class="current">
+                              <a href="./">Validate</a>
+                          </li>
+                      </ul>
+                  </li>
+        </ul>
+      </div>
+      <div class="content">
+        <h1 id="validate-validate-system-description">validate — Validate System Description</h1>
+<h2 id="synopsis">Synopsis</h2>
+<p><code>machinery validate</code> NAME</p>
+<p><code>machinery</code> help validate</p>
+<h2 id="description">Description</h2>
+<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>
+<h2 id="arguments">Arguments</h2>
+<ul>
+<li><code>NAME</code> (required):
+    Name of the system description.</li>
+</ul>
+<h2 id="examples">Examples</h2>
+<ul>
+<li>
+<p>Validate the system description with the name <code>myhost</code>:</p>
+<p>$ <code>machinery</code> validate myhost</p>
+</li>
+</ul>
+      </div>
+    </div>
+  </body>
+</html>

data/manual/site/docs/machinery_main_general.1/index.html ADDED

@@ -0,0 +1,253 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8"/>
+    <link href="../../css/custom.css" rel="stylesheet">
+  </head>
+  <body id="manpage">
+    <div id="back">
+      <a href="../..">
+        <img src="../../img/hand3.png" class="hand3"/>
+        <div class="goback">Go back to the web site</div>
+      </a>
+    </div>
+    <div class="mp">
+      <div class="nav">
+        <ul>
+                  <li class="">
+                      <a href="../">Welcome</a>
+                  </li>
+                  <li class="current">
+                      <a href="./">General Overview</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_scopes.1/">Scopes</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_usecases.1/">Use cases</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_security_implications.1/">Security Implications</a>
+                  </li>
+                  <li>Commands
+                      <ul>
+                          <li class="">
+                              <a href="../machinery-analyze.1/">Analyze</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-build.1/">Build</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-compare.1/">Compare</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-config.1/">Config</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-copy.1/">Copy</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-deploy.1/">Deploy</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-html.1/">Export HTML</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-inspect.1/">Inspect</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-inspect-container.1/">Inspect Container</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-list.1/">List</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-man.1/">Man</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-move.1/">Move</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-remove.1/">Remove</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-serve.1/">Serve</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-show.1/">Show</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-validate.1/">Validate</a>
+                          </li>
+                      </ul>
+                  </li>
+        </ul>
+      </div>
+      <div class="content">
+        <h1 id="machinery-a-systems-management-toolkit-for-linux">Machinery — A Systems Management Toolkit for Linux</h1>
+<h1 id="synopsis">Synopsis</h1>
+<p><code>machinery</code> SUBCOMMAND [options] <br>
+<code>machinery</code> help [SUBCOMMAND]</p>
+<h1 id="conceptual-overview">Conceptual Overview</h1>
+<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 existing 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 accommodate 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>
+<h2 id="the-machinery-command">The machinery Command</h2>
+<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>
+<h2 id="system-description">System Description</h2>
+<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">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.
+To manually validate a description use the <code>machinery validate</code> command.</p>
+<h2 id="scopes">Scopes</h2>
+<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 changed 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>See the <a href="../machinery_main_scopes.1/">Scopes documentation</a> for a list of all supported scopes.</p>
+<h1 id="options-for-all-subcommands">Options for All Subcommands</h1>
+<!--- These are 'global' options of machinery -->
+<ul>
+<li>
+<p><code>--version</code>:
+    Displays version of <code>machinery</code> tool. Exit when done.</p>
+</li>
+<li>
+<p><code>--debug</code>:
+    Enable debug mode. Machinery writes additional information into the log
+    file which can be useful to track down problems.</p>
+</li>
+</ul>
+<h1 id="files-and-devices">Files and Devices</h1>
+<ul>
+<li>
+<p><code>~/.machinery/machinery.config</code>:</p>
+<p>Configuration file.</p>
+</li>
+<li>
+<p><code>~/.machinery/machinery.log</code>:</p>
+<p>Central log file, in the format date, time, process id, and log message.</p>
+</li>
+<li>
+<p><code>em1 (openSUSE 13.2 / openSUSE leap)</code>, <code>eth0</code> (SLE11) and <code>lan0</code> (SLE12):</p>
+<p>First network device is used when DHCP in built image is enabled.</p>
+</li>
+</ul>
+<h1 id="environment">Environment</h1>
+<ul>
+<li>
+<p><code>MACHINERY_LOG_FILE</code>:</p>
+<p>Location of Machinery's log file (defaults to <code>~/.machinery/machinery.log</code>).</p>
+</li>
+</ul>
+<h1 id="copyright">Copyright</h1>
+<p>Copyright (c) 2013-2016 <a href="http://www.suse.com">SUSE LLC</a></p>
+      </div>
+    </div>
+  </body>
+</html>

data/manual/site/docs/machinery_main_scopes.1/index.html ADDED

@@ -0,0 +1,249 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8"/>
+    <link href="../../css/custom.css" rel="stylesheet">
+  </head>
+  <body id="manpage">
+    <div id="back">
+      <a href="../..">
+        <img src="../../img/hand3.png" class="hand3"/>
+        <div class="goback">Go back to the web site</div>
+      </a>
+    </div>
+    <div class="mp">
+      <div class="nav">
+        <ul>
+                  <li class="">
+                      <a href="../">Welcome</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_general.1/">General Overview</a>
+                  </li>
+                  <li class="current">
+                      <a href="./">Scopes</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_usecases.1/">Use cases</a>
+                  </li>
+                  <li class="">
+                      <a href="../machinery_main_security_implications.1/">Security Implications</a>
+                  </li>
+                  <li>Commands
+                      <ul>
+                          <li class="">
+                              <a href="../machinery-analyze.1/">Analyze</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-build.1/">Build</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-compare.1/">Compare</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-config.1/">Config</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-copy.1/">Copy</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-deploy.1/">Deploy</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-export-html.1/">Export HTML</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-inspect.1/">Inspect</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-inspect-container.1/">Inspect Container</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-list.1/">List</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-man.1/">Man</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-move.1/">Move</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-remove.1/">Remove</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-serve.1/">Serve</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-show.1/">Show</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
+                          </li>
+                          <li class="">
+                              <a href="../machinery-validate.1/">Validate</a>
+                          </li>
+                      </ul>
+                  </li>
+        </ul>
+      </div>
+      <div class="content">
+        <h1 id="scopes">Scopes</h1>
+<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 packages installed on the
+inspected system.</p>
+<ul>
+<li>patterns</li>
+</ul>
+<p>Contains all patterns or tasks installed on the inspected system. A pattern is a
+collection of software packages, similar to the idea of tasks on Debian/Ubuntu-
+like systems. The meaning of software patterns depends on the package manager of the
+distribution.</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. 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 configuration files and are ignored in this context.</p>
+<ul>
+<li>changed-config-files</li>
+</ul>
+<p>Contains all configuration files which have been changed since they were
+installed.
+Changed 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 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
+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>
+      </div>
+    </div>
+  </body>
+</html>