machinery-tool 1.21.0 → 1.22.0

data/lib/static_html.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+# Copyright (c) 2013-2016 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+class StaticHtml < Exporter
+  TEMPLATE_DIR = File.join(Machinery::ROOT, "html").freeze
+  PARTIAL_DIR = File.join(Machinery::ROOT, "html", "partials").freeze
+
+  include HamlHelpers
+
+  def initialize(description, directory)
+    @description = description
+    @directory = directory
+    @static_html = true
+  end
+  attr_reader :description
+
+  def haml(source, options = {})
+    Haml::Engine.new(source).render(binding, options.delete(:locals))
+  end
+
+  def write
+    @description.load_existing_diffs
+    render_html
+    copy_assets
+  end
+
+  def create_directory(force = false)
+    if File.exist?(@directory)
+      if force
+        FileUtils.rm_r(@directory)
+      else
+        raise Machinery::Errors::ExportFailed.new(
+          "The output directory '#{@directory}' already exists." \
+          " You can force overwriting it with the '--force' option."
+        )
+      end
+    end
+    FileUtils.mkdir_p(@directory)
+  end
+
+  private
+
+  def copy_assets
+    FileUtils.cp_r(File.join(TEMPLATE_DIR, "assets"), @directory)
+    FileUtils.rm_r(File.join(@directory, "assets", "compare"))
+  end
+
+  def render_html
+    File.open(File.join(@directory, "index.html"), "w") do |f|
+      f.puts Haml::Engine.new(static_index_path).render(self, description: @description)
+    end
+  end
+
+  def static_index_path
+    File.read(File.join(TEMPLATE_DIR, "index.html.haml"))
+  end
+
+  def partial_path(partial)
+    File.read(File.join(PARTIAL_DIR, "#{partial}.html.haml"))
+  end
+end

data/lib/system.rb

@@ -76,8 +76,9 @@ class System
     out = File.open(archive, "w")
     begin
       run_command(
-        "tar", "--create", "--gzip", "--null", "--files-from=-",
+        "tar", "--create", "--gzip",
         *exclude.flat_map { |f| ["--exclude", f]},
+        "--null", "--files-from=-",
         stdout: out,
         stdin: Array(file_list).join("\0"),
         privileged: true,

data/lib/system_description.rb

@@ -310,6 +310,16 @@ class SystemDescription < Machinery::Object
     end
   end
 
+  # Enrich description with the config file diffs
+  def load_existing_diffs
+    diffs_dir = scope_file_store("analyze/changed_config_files_diffs").path
+    return unless changed_config_files && diffs_dir
+    changed_config_files.each do |file|
+      path = File.join(diffs_dir, file.name + ".diff")
+      file.diff = DiffWidget.new(File.read(path)).widget if File.exist?(path)
+    end
+  end
+
   private
 
   def parse_variable_assignment(string, variable)

data/lib/version.rb

@@ -17,6 +17,6 @@
 
 module Machinery
 
-  VERSION = "1.21.0"
+  VERSION = "1.22.0"
 
 end

data/machinery-helper/version.go

@@ -2,4 +2,4 @@
 
 package main
 
-const VERSION = "cf6d038ddefdf0d539b132c206336e141c39b418"
+const VERSION = "964505b0908b5f767f7fb74053b19884ae2e0954"

data/manual/docs/README.md

@@ -4,13 +4,11 @@ This guide provides answers to writing and style questions commonly arising when
 documentation.
 The following rules are intentionally kept concise. Refer to our [SUSE Styleguide][1] for more information.
 
-
 ## Audience
 
 Our main audience for the documentation are system administrators. Adjust tone, style, and
 technicality of the text based on the intended audience.
 
-
 ## Physical Structure
 
 The documentation is written in Markdown and contains:
@@ -22,10 +20,8 @@ The documentation is written in Markdown and contains:
 
 * Scopes are described in the `documentation` attribute in `plugins/SCOPENAME/SCOPENAME.yml`
 
-
-**Tip:** To create a file for your subcommand, copy the `subcommand-template.1.md` template to
-`machinery-SUBCOMMAND.1.md` and edit the latter.
-
+**Tip:** To create a file for your subcommand, copy an existing one to
+`machinery-SUBCOMMAND.1.md` and edit the latter according to the following "Logical Structure".
 
 ## Logical Structure
 
@@ -37,18 +33,18 @@ The structure of each subcommand contains:
 
         ## SUBCOMMAND—Short Description
 
-* a section "SYNOPSIS"
+* a section "Synopsis"
 
   Contains the output of `machinery SUBCOMMAND --help` or `machinery help SUBCOMMAND`.
   Use square brackets for options which are optional.
 
-* a section "DESCRIPTION"
+* a section "Description"
 
   Summarize the purpose of the subcommand in a short, first paragraph. Leave an
   empty line, and then describe what the command does, what its output is, and
   which interaction may be needed.
 
-* a section "OPTIONS"
+* a section "Options"
 
   List all options. Use a separate list item for each option and wrap short and
   long option name in back ticks. State if the option is mandatory or optional
@@ -59,17 +55,17 @@ The structure of each subcommand contains:
 
   Capitalize any placeholders.
 
-* a section "PREREQUISITES"
+* a section "Prerequisites"
 
   List all the necessary topics, items, or other conditions that the user have
   to be fulfilled beforehand the subcommand can be executed.
 
-* a section "DEPENDENCIES"
+* a section "Dependencies"
 
   List only those dependencies which cannot be expressed as package dependencies.
   Package dependencies are automatically resolved when the `machinery` package is installed.
 
-* a section "EXAMPLES"
+* a section "Examples"
 
   Provide at least two meaningful examples of how to use the subcommand.
   Start with the most common or easy one and explain what it does. Include also a more unusual or difficult
@@ -79,7 +75,6 @@ The structure of each subcommand contains:
 
           machinery SUBCOMMAND --opt1 ...
 
-
 ## Level of Detail
 
 The Machinery documentation is mainly a reference: an overview of Machinery itself, its
@@ -92,7 +87,6 @@ For example, it is unimportant whether a subcommand uses `rpm`, `zypper`, or any
 to retrieve a package list. In that case, it is enough to mention that Machinery gets this list
 somehow and focus on what it does with this information.
 
-
 ## Language
 
 For language and spelling rules, refer to our [SUSE Styleguide, section "Language"][1] which covers most of your
@@ -100,7 +94,6 @@ questions already.
 
 If you are unsure about spelling, go to the [Merriam Webster][20] homepage or consult our [SUSE Terminology][3].
 
-
 ## Consistency Hints
 
 * Be consistent. For example, if you explain the `--name` option and start your description with a verb,
@@ -118,7 +111,6 @@ If you are unsure about spelling, go to the [Merriam Webster][20] homepage or co
 
 * Capitalize placeholders, for example, `machinery show NAME`.
 
-
 [1]: http://doc.opensuse.org/products/opensuse/Styleguide/opensuse_documentation_styleguide_sd/#sec.language       "SUSE Styleguide: Language"
 [2]: http://doc.opensuse.org/products/opensuse/Styleguide/opensuse_documentation_styleguide_sd/#sec.capitalization "SUSE Styleguide: Capitalization and Title Style"
 [3]: http://doc.opensuse.org/products/opensuse/Styleguide/opensuse_documentation_styleguide_sd/#sec.terminology    "SUSE Styleguide: Terminology"

data/manual/docs/docs.md

@@ -1,7 +1,45 @@
 # Machinery Documentation
 
-This is the documentation of Machinery.
+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.
 
-* [Overview](machinery_main_general.1/)
-* [Scopes](machinery_main_scopes.1/)
-* [Use cases](machinery_main_usecases.1/)
+# What is Machinery?
+
+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.
+
+# Work Flow Examples
+
+## Inspect a System and Show Results
+  - `machinery inspect --extract-files --name=NAME HOSTNAME`
+  - `machinery show NAME`
+
+## Export System Description as HTML
+
+  - `machinery export-html --html-dir=tmp NAME`
+
+## Inspect Two Systems and Compare Them
+  - `machinery inspect HOSTNAME1`
+  - `machinery inspect HOSTNAME2`
+  - `machinery compare HOSTNAME1 HOSTNAME2`
+
+## Fully Inspect a System and Export a Kiwi Description
+  - `machinery inspect --extract-files HOSTNAME`
+  - `machinery export-kiwi --kiwi-dir=~/kiwi HOSTNAME`
+
+## Fully Inspect a System and Export an AutoYaST Profile
+  - `machinery inspect --extract-files HOSTNAME`
+  - `machinery export-autoyast --autoyast-dir=~/autoyast HOSTNAME`
+
+## Fully Inspect a System and Deploy a Replicate to the Cloud
+  - `machinery inspect --extract-files HOSTNAME`
+  - `machinery deploy --cloud-config=~/openrc.sh HOSTNAME`
+
+## How to upgrade a SLES 11 SP3 system to SLES 12
+  - Machinery can help you to upgrade without affecting the original system.
+    For more details please read the Wiki Page: [How to upgrade a SLES 11 SP3 system to SLES 12](https://github.com/SUSE/machinery/wiki/How-to-upgrade-a-SLES-11-SP3-system-to-SLES-12).
+
+For a more detailed overview see [General Overview](machinery_main_general.1/).

data/manual/docs/index.html

@@ -72,7 +72,7 @@
                 </div>
               </div>
 
-                            <div>
+              <div>
                 <div class="git">
                   <a  class="btn btn-default" href="{{_base_url_}}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/docs/machinery-analyze.1.md

@@ -1,36 +1,32 @@
 # analyze — Analyze System Description
 
-## SYNOPSIS
+## Synopsis
 
 `machinery analyze` NAME -o | --operation=OPERATION
 
 `machinery` help analyze
 
-
-## DESCRIPTION
+## Description
 
 The `analyze` subcommand analyzes an existing system description and enriches
 it with additional information. Supported operations are:
 
   * `changed-config-files-diffs`:
     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 `machinery show --show-diffs`
 
-
-## ARGUMENTS
+## Arguments
 
   * `NAME` (required):
     Name of the system description.
 
-
-## OPTIONS
+## Options
 
   * `-o OPERATION`, `--operation=OPERATION` (required):
     The analyze operation to perform.
 
-
-## EXAMPLES
+## Examples
 
  * Analyze the config file diffs for the `myhost` system description:
 

data/manual/docs/machinery-build.1.md

@@ -1,20 +1,19 @@
 # build — Build Image from System Description
 
-## SYNOPSIS
+## Synopsis
 
 `machinery build` NAME -i IMAGE-DIR | --image-dir=IMAGE-DIR
 
 `machinery` help build
 
-
-## DESCRIPTION
+## Description
 
 The `build` 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.
 
 `machinery` uses the image building command line tool
-[KIWI](http://en.opensuse.org/Portal:KIWI) to perform the actual build. KIWI
+[KIWI](http://opensuse.github.io/kiwi/) 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 `build` command format for showing progress and
 diagnosing errors.
@@ -22,14 +21,12 @@ diagnosing errors.
 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.
 
-
-## ARGUMENTS
+## Arguments
 
   * `NAME` (required):
     Use specified system description.
 
-
-## OPTIONS
+## Options
 
   * `-i IMAGE-DIR`, `--image-dir=IMAGE-DIR` (required):
     Save image file under specified path.
@@ -40,8 +37,7 @@ built image. The list of filters is shown at the beginning of the build.
   * `-s`, `--enable-ssh` (optional):
     Enable SSH service in built image
 
-
-## PREREQUISITES
+## Prerequisites
 
   * The `build` command requires the packages `kiwi` and `kiwi-desc-vmxboot`.
 
@@ -54,7 +50,7 @@ built image. The list of filters is shown at the beginning of the build.
 
   * Machinery can only build x86_64 images on x86_64 systems at the moment.
 
-## EXAMPLES
+## Examples
 
  * To build an image from the system description named "tux" and to save the
    image under the `/tmp/tux/` directory:

data/manual/docs/machinery-compare.1.md

@@ -1,20 +1,17 @@
-
 # compare — Compare System Descriptions
 
-## SYNOPSIS
+## Synopsis
 
 `machinery compare` [-s SCOPE | --scope=SCOPE] [-e IGNORE-SCOPE | --ignore-scope=IGNORE-SCOPE] [--no-pager] [--show-all] [--html] NAME1 NAME2
 
 `machinery` help compare
 
-
-## DESCRIPTION
+## Description
 
 The `compare` command compares stored system descriptions. The scope option can
 be used to limit the output to the given scopes.
 
-
-## ARGUMENTS
+## Arguments
 
   * `NAME1` (required):
     First system description to compare.
@@ -22,8 +19,7 @@ be used to limit the output to the given scopes.
   * `NAME2` (required):
     Second system description to compare.
 
-
-## OPTIONS
+## Options
 
   * `-s SCOPE`, `--scope=SCOPE` (optional):
     Limit output to the specified scope.
@@ -42,8 +38,7 @@ be used to limit the output to the given scopes.
   * `--html` (optional):
     Shows the comparison of two system descriptions in the web browser.
 
-
-## EXAMPLES
+## Examples
 
   * Compare system descriptions saved as `earth` and `moon`:
 

data/manual/docs/machinery-config.1.md

@@ -1,7 +1,6 @@
-
 # config — Configure Machinery
 
-## SYNOPSIS
+## Synopsis
 
 `machinery config`
 
@@ -11,8 +10,7 @@
 
 `machinery` help config
 
-
-## DESCRIPTION
+## Description
 
 The `config` command shows or changes machinery's configuration.
 
@@ -22,15 +20,14 @@ If key and value are specified this configuration entry is set accordingly.
 
 The configuration is stored in `~/.machinery/machinery.config`.
 
-## ARGUMENTS
+## Arguments
   * `KEY`:
     Name of the configuration entry.
 
   * `VALUE`:
     Value of the configuration entry.
 
-
-## EXAMPLES
+## Examples
 
   * Turn off hints: