Skip to content

Experimental Features

Sebastian Vollath edited this page Oct 7, 2016 · 42 revisions

Machinery gets lots of new features that might be interesting for users. As these features might not be stable enough for every day use, we have added an experimental feature option in the Machinery configuration file. We also list current experimental features available for Machinery on this wiki page to give an overview.

Enabling experimental features

In order to enable experimental features run the machinery config command:

machinery config experimental_features on

To see if you have enabled any experimental features, run:

machinery config experimental_features

To turn off any experimental features, run:

machinery config experimental_features off

Current Experimental Features

--exclude option

DESCRIPTION

This option filters the given path when using the inspect or show commands.

USAGE

  • Using filters in their generic form is possible with the

    	--exclude=FILTER_DEFINITION 
    

option which is available in all commands.

  • Multiple filters can be read from a file by using an @-prefixed file name as argument:

    	--exclude=@FILENAME.
    
  • When applying the filters you can decide whether to use black and white listening.

    • Blacklist: Excludes the given path or directory

        $ machinery COMMAND --exclude=FILTER_DEFINITION HOSTNAME
      
  • Whitelist: Excludes everything but the given path or directory

       $ machinery inspect --exclude=/unmanaged_files/name!=/var/cache/ myhost
    
  • Each filter has to begin with a scope followed by an argument. The filter argument can be compared with the term given behind the equals sign. Available scopes and arguments can be seen on System Description Format.

For more information about filtering visit: Filtering System Descriptions

EXAMPLES

  • Excludes /var/cache from unmanaged files on inspection of host myhost:

          $ machinery inspect --exclude=/unmanaged_files/name=/var/cache/ myhost
    
  • Show all enabled services in description myhost:

      	  $ machinery show --exclude='/services/state!=enabled' myhost
    
  • Excludes filters, which are line separated in given myfile.txt file:

      	  $ machinery inspect --exclude=@/tux/home/myfile.txt myhost
    

--extract-metadata option for machinery inspect

When this option is given machinery extracts the metadata of unmanaged files (e.g. owner, group, size etc.) even if the files itself are not extracted.

command containerize for containerizing system descriptions

DESCRIPTION

This command detects workloads from a system description and creates a recommendation for a corresponding container setup.

USAGE

$ machinery [global options] containerize --output-dir DIRECTORY DESCRIPTION 

in which DIRECTORY points to the location where the container files will be stored. Can also be specified as -o DIRECTORY. This option is required and defaults to none.