0.1
No release in over a year
Machinery is a systems management toolkit for Linux. It supports configuration discovery, system validation, and service migration. It's based on the idea of a universal system description.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

Machinery

Gem Version Build Status

Machinery is a systems management toolkit for Linux. It supports configuration discovery, system validation, and service migration. It's based on the idea of a universal system description.

A spin-off project of Machinery is Pennyworth, which is used to manage the integration test environment.

For more information, visit our website.

Contents

  • Installation
  • Usage
  • Documentation
  • Development
  • Contact

Installation

Machinery runs on most Linux distributions. Install it by following one of these methods:

Usage

Machinery is a command-line tool. You can invoke it using the bin/machinery command. It accepts subcommands (similarly to git or bundle).

To display a short overview of available commands and their descriptions, use the help command:

$ machinery help

For more information about the commands, see Machinery Documentation.

Documentation

Development

The following steps are only recommended if you want to build Machinery from sources, work on the codebase or test the latest development changes. For other distributions than SUSE look also here.

  1. Install Git

    $ sudo zypper in git
    
  2. Install basic Ruby environment

    $ sudo zypper in ruby rubygem-bundler
    

    After the installation, make sure that your ruby version is at least 2.0.0.p247-3.11.1:

    $ ruby -v
    

    With lower versions, bundle install won't work because of a bug.

  3. Install Machinery's dependencies

    Install packages needed to compile Gems with native extensions:

    $ sudo zypper in gcc-c++ make patch ruby-devel libxslt-devel libxml2-devel libvirt-devel
    

    Install Go in order to compile the machinery-helper:

    $ sudo zypper in go
    
  4. Clone Machinery repository and install Gem dependencies

    $ git clone git@github.com:SUSE/machinery.git
    $ cd machinery
    $ bundle config build.nokogiri --use-system-libraries
    $ bundle install
    
  5. Done!

    You can now start using Machinery by running bin/machinery.

  6. Contribute

    Now that you have Machinery running from git on your machine you are ready to hack. If you would like to get some overview of architecture and design of Machinery have a look at our Developer Documentation.

    We are happy if you share your changes with us as pull requests. Read the Contribution Guidelines for details how to do that.

Contact

If you have any question, feel free to open an issue on our GitHub page.