machinery-tool 1.21.0 → 1.22.0

data/manual/docs/{machinery_security_implications.1.md → machinery_main_security_implications.1.md}

@@ -1,19 +1,20 @@
-# SECURITY IMPLICATIONS
+# Security Implications
+
 This document describes security related issues administrators need to be aware of when using
 Machinery.
 
 ## Inspection
-Machinery inspects several parts of a system which are covered by Machinery's scopes. A list
-of the available scopes and information about what they do can be found
-[here](machinery_main_scopes.1/index.html).
 
-Users of Machinery who inspect systems need to be aware of the security implications in order
+Machinery inspects several parts of a system which are covered by Machinery's scopes.
+Information about scopes is listed [here](machinery_main_scopes.1/).
+
+Users of Machinery who inspect systems need to be aware of the security implications
 to take the right decisions on how to protect the retrieved data.
 
 ## Retrieval of Data
-Machinery transfers data from one end point to another via SSH (using public key authentication).
+Machinery transfers data from one end point to another via SSH (Secure Shell, using public key authentication).
 
-Depending on the scope, Machinery [collects information](machinery_main_scopes.1/index.html)
+Depending on the scope, Machinery [collects information](machinery_main_scopes.1/)
 about files on the system. Additionally, when the `--extract-files` option is given for the
 `inspect` command, not only the meta data about the files (e.g. permission bits, owner, group etc
 .) but also the file content is extracted. Machinery does not distinguish between sensitive
@@ -23,7 +24,7 @@ description has automatically access to **all** extracted files and contained se
 #### root/sudo Privileges
 An inspection can only be done, when the user on the inspected system is either root or has
 sudo privileges. Information about the required sudo configuration can be found
-[here](machinery-inspect.1/index.html#prerequisites).
+[here](machinery-inspect.1/#prerequisites).
 
 ## Storage of Data
 #### Access Restrictions
@@ -70,17 +71,16 @@ is specified, the default port which is configured in the machinery config file
 
 ## Export of Data
 #### export-autoyast
-The `export-autoyast` command creates an AutoYaST profile for an automated installation. The result
-are also tar balls containing the extracted files from the system description. These files
+The `export-autoyast` command creates an AutoYaST profile for an automated installation. This will result
+in tar balls containing the extracted files from the system description. These files
 potentially contain sensitive data (e.g. passwords). This fact needs to be kept in mind, especially
 if these files are copied to a web server for an AutoYaST installation via HTTP.
 
 #### export-kiwi
-The program Kiwi allows you to build OS images what you can use for installation. Machinery gives
-you the opportunity to build a complete Kiwi configuration from a system description. This
-configuration can be used to build an image via Kiwi. The `export-kiwi` command creates a
-directory, where it stores the Kiwi configuration and the files of a system description. These
-files potentially contain sensitive data (e.g. passwords).
+The program **kiwi** allows you to build OS images for deployment. Machinery gives
+you the opportunity to export a KIWI description. This description can be used to build an image via Kiwi.
+The `export-kiwi` command creates a directory, where it stores the Kiwi configuration and the files
+of a system description. These files potentially contain sensitive data (e.g. passwords).
 
 #### build
 The created image potentially contains sensitive data (e.g. passwords) from extracted files.

data/manual/docs/machinery_main_usecases.1.md

@@ -1,21 +1,4 @@
-
-## System Description
-
-The System Description format and file structure is documented in the machinery
-wiki: [https://github.com/SUSE/machinery/wiki/System-Description-Format](https://github.com/SUSE/machinery/wiki/System-Description-Format)
-
-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 `machinery validate` command.
-
-
-## Use Cases
+# Use Cases
 
 Some of the important use cases of Machinery are:
 
@@ -35,15 +18,4 @@ Some of the important use cases of Machinery are:
   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.
-
-
-# OPTIONS FOR ALL SUBCOMMANDS
-<!--- These are 'global' options of machinery -->
-
-  * `--version`:
-    Displays version of `machinery` tool. Exit when done.
-
-  * `--debug`:
-    Enable debug mode. Machinery writes additional information into the log
-    file which can be useful to track down problems.
+  can then for example be deployed to a cloud environment.

data/manual/mkdocs.yml

@@ -1,11 +1,10 @@
 site_name: Machinery Documentation
 pages:
 - Welcome: docs.md
-- Home:
-  - General: machinery_main_general.1.md
-  - Scopes: machinery_main_scopes.1.md
-  - "Use cases": machinery_main_usecases.1.md
-  - "Security Implications": machinery_security_implications.1.md
+- "General Overview": machinery_main_general.1.md
+- Scopes: machinery_main_scopes.1.md
+- "Use cases": machinery_main_usecases.1.md
+- "Security Implications": machinery_main_security_implications.1.md
 - Commands:
   - Analyze: machinery-analyze.1.md
   - Build: machinery-build.1.md
@@ -13,17 +12,18 @@ pages:
   - Config: machinery-config.1.md
   - Copy: machinery-copy.1.md
   - Deploy: machinery-deploy.1.md
-  - Export AutoYaST: machinery-export-autoyast.1.md
-  - Export Kiwi: machinery-export-kiwi.1.md
+  - "Export AutoYaST": machinery-export-autoyast.1.md
+  - "Export Kiwi": machinery-export-kiwi.1.md
+  - "Export HTML": machinery-export-html.1.md
   - Inspect: machinery-inspect.1.md
-  - Inspect Docker: machinery-inspect-docker.1.md
+  - "Inspect Container": machinery-inspect-container.1.md
   - List: machinery-list.1.md
   - Man: machinery-man.1.md
   - Move: machinery-move.1.md
   - Remove: machinery-remove.1.md
   - Serve: machinery-serve.1.md
   - Show: machinery-show.1.md
-  - Upgrade Format: machinery-upgrade-format.1.md
+  - "Upgrade Format": machinery-upgrade-format.1.md
   - Validate: machinery-validate.1.md
 theme_dir: 'custom_theme'
 extra_templates:

data/manual/site/docs/index.html

@@ -23,26 +23,29 @@
 
           
               
-                  <li>Home
-                      <ul>
-                      
-                          <li class="">
-                              <a href="../machinery_main_general.1/">General</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_security_implications.1/">Security Implications</a>
-                          </li>
-                      
-                      </ul>
+                  <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>
               
 
@@ -83,12 +86,16 @@
                               <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-docker.1/">Inspect Docker</a>
+                              <a href="../machinery-inspect-container.1/">Inspect Container</a>
                           </li>
                       
                           <li class="">
@@ -132,12 +139,51 @@
       </div>
       <div class="content">
         <h1 id="machinery-documentation">Machinery Documentation</h1>
-<p>This is the documentation of Machinery.</p>
+<p>Welcome! The Machinary documentation is a reference aimed at system administrators.
+It will give you an overview of Machinery itself, its subcommands, and usage examples.</p>
+<h1 id="what-is-machinery">What is Machinery?</h1>
+<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 a 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>
+<h1 id="work-flow-examples">Work Flow Examples</h1>
+<h2 id="inspect-a-system-and-show-results">Inspect a System and Show Results</h2>
+<ul>
+<li><code>machinery inspect --extract-files --name=NAME HOSTNAME</code></li>
+<li><code>machinery show NAME</code></li>
+</ul>
+<h2 id="export-system-description-as-html">Export System Description as HTML</h2>
+<ul>
+<li><code>machinery export-html --html-dir=tmp NAME</code></li>
+</ul>
+<h2 id="inspect-two-systems-and-compare-them">Inspect Two Systems and Compare Them</h2>
+<ul>
+<li><code>machinery inspect HOSTNAME1</code></li>
+<li><code>machinery inspect HOSTNAME2</code></li>
+<li><code>machinery compare HOSTNAME1 HOSTNAME2</code></li>
+</ul>
+<h2 id="fully-inspect-a-system-and-export-a-kiwi-description">Fully Inspect a System and Export a Kiwi Description</h2>
+<ul>
+<li><code>machinery inspect --extract-files HOSTNAME</code></li>
+<li><code>machinery export-kiwi --kiwi-dir=~/kiwi HOSTNAME</code></li>
+</ul>
+<h2 id="fully-inspect-a-system-and-export-an-autoyast-profile">Fully Inspect a System and Export an AutoYaST Profile</h2>
+<ul>
+<li><code>machinery inspect --extract-files HOSTNAME</code></li>
+<li><code>machinery export-autoyast --autoyast-dir=~/autoyast HOSTNAME</code></li>
+</ul>
+<h2 id="fully-inspect-a-system-and-deploy-a-replicate-to-the-cloud">Fully Inspect a System and Deploy a Replicate to the Cloud</h2>
+<ul>
+<li><code>machinery inspect --extract-files HOSTNAME</code></li>
+<li><code>machinery deploy --cloud-config=~/openrc.sh HOSTNAME</code></li>
+</ul>
+<h2 id="how-to-upgrade-a-sles-11-sp3-system-to-sles-12">How to upgrade a SLES 11 SP3 system to SLES 12</h2>
 <ul>
-<li><a href="../machinery_main_general.1/">Overview</a></li>
-<li><a href="../machinery_main_scopes.1/">Scopes</a></li>
-<li><a href="../machinery_main_usecases.1/">Use cases</a></li>
+<li>Machinery can help you to upgrade without affecting the original system.
+    For more details please read the Wiki Page: <a href="https://github.com/SUSE/machinery/wiki/How-to-upgrade-a-SLES-11-SP3-system-to-SLES-12">How to upgrade a SLES 11 SP3 system to SLES 12</a>.</li>
 </ul>
+<p>For a more detailed overview see <a href="../machinery_main_general.1/">General Overview</a>.</p>
       </div>
     </div>
   </body>

data/manual/site/index.html

@@ -72,7 +72,7 @@
                 </div>
               </div>
 
-                            <div>
+              <div>
                 <div class="git">
                   <a  class="btn btn-default" href="docs/">Documentation</a>
                 </div>
@@ -84,7 +84,11 @@
                 </div>
               </div>
 
-
+              <div>
+                <div class="git">
+                  <a  class="btn btn-default" href="https://machinery-project.blogspot.de/">Machinery Blog</a>
+                </div>
+              </div>
             </div>
 
             <div>

data/manual/site/machinery-analyze.1/index.html

@@ -23,26 +23,29 @@
 
           
               
-                  <li>Home
-                      <ul>
-                      
-                          <li class="">
-                              <a href="../machinery_main_general.1/">General</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_security_implications.1/">Security Implications</a>
-                          </li>
-                      
-                      </ul>
+                  <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>
               
 
@@ -83,12 +86,16 @@
                               <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-docker.1/">Inspect Docker</a>
+                              <a href="../machinery-inspect-container.1/">Inspect Container</a>
                           </li>
                       
                           <li class="">
@@ -132,29 +139,29 @@
       </div>
       <div class="content">
         <h1 id="analyze-analyze-system-description">analyze — Analyze System Description</h1>
-<h2 id="synopsis">SYNOPSIS</h2>
+<h2 id="synopsis">Synopsis</h2>
 <p><code>machinery analyze</code> NAME -o | --operation=OPERATION</p>
 <p><code>machinery</code> help analyze</p>
-<h2 id="description">DESCRIPTION</h2>
+<h2 id="description">Description</h2>
 <p>The <code>analyze</code> subcommand analyzes an existing system description and enriches
 it with additional information. Supported operations are:</p>
 <ul>
 <li><code>changed-config-files-diffs</code>:
     Generates the diffs between the extracted changed configuration files from the
-    system and the original versions from the RPM packages.
+    system and the original versions from the packages.
     The diffs can be shown using <code>machinery show --show-diffs</code></li>
 </ul>
-<h2 id="arguments">ARGUMENTS</h2>
+<h2 id="arguments">Arguments</h2>
 <ul>
 <li><code>NAME</code> (required):
     Name of the system description.</li>
 </ul>
-<h2 id="options">OPTIONS</h2>
+<h2 id="options">Options</h2>
 <ul>
 <li><code>-o OPERATION</code>, <code>--operation=OPERATION</code> (required):
     The analyze operation to perform.</li>
 </ul>
-<h2 id="examples">EXAMPLES</h2>
+<h2 id="examples">Examples</h2>
 <ul>
 <li>
 <p>Analyze the config file diffs for the <code>myhost</code> system description:</p>

data/manual/site/machinery-build.1/index.html

@@ -23,26 +23,29 @@
 
           
               
-                  <li>Home
-                      <ul>
-                      
-                          <li class="">
-                              <a href="../machinery_main_general.1/">General</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_security_implications.1/">Security Implications</a>
-                          </li>
-                      
-                      </ul>
+                  <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>
               
 
@@ -83,12 +86,16 @@
                               <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-docker.1/">Inspect Docker</a>
+                              <a href="../machinery-inspect-container.1/">Inspect Container</a>
                           </li>
                       
                           <li class="">
@@ -132,26 +139,26 @@
       </div>
       <div class="content">
         <h1 id="build-build-image-from-system-description">build — Build Image from System Description</h1>
-<h2 id="synopsis">SYNOPSIS</h2>
+<h2 id="synopsis">Synopsis</h2>
 <p><code>machinery build</code> NAME -i IMAGE-DIR | --image-dir=IMAGE-DIR</p>
 <p><code>machinery</code> help build</p>
-<h2 id="description">DESCRIPTION</h2>
+<h2 id="description">Description</h2>
 <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
+<a href="http://opensuse.github.io/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>
-<h2 id="arguments">ARGUMENTS</h2>
+<h2 id="arguments">Arguments</h2>
 <ul>
 <li><code>NAME</code> (required):
     Use specified system description.</li>
 </ul>
-<h2 id="options">OPTIONS</h2>
+<h2 id="options">Options</h2>
 <ul>
 <li>
 <p><code>-i IMAGE-DIR</code>, <code>--image-dir=IMAGE-DIR</code> (required):
@@ -166,7 +173,7 @@ built image. The list of filters is shown at the beginning of the build.</p>
     Enable SSH service in built image</p>
 </li>
 </ul>
-<h2 id="prerequisites">PREREQUISITES</h2>
+<h2 id="prerequisites">Prerequisites</h2>
 <ul>
 <li>
 <p>The <code>build</code> command requires the packages <code>kiwi</code> and <code>kiwi-desc-vmxboot</code>.</p>
@@ -184,7 +191,7 @@ built image. The list of filters is shown at the beginning of the build.</p>
 <p>Machinery can only build x86_64 images on x86_64 systems at the moment.</p>
 </li>
 </ul>
-<h2 id="examples">EXAMPLES</h2>
+<h2 id="examples">Examples</h2>
 <ul>
 <li>
 <p>To build an image from the system description named "tux" and to save the