knife-graph

knife-graph plugin

A knife plugin that creates a graph out of various Chef resources.

Currently the only supported output is the mapping from roles to other roles and recipes (run_list).

Requirements

• graphviz

Output Legend

• Box: Role
• Ellipse: Recipe

SUBCOMMANDS

Only one knife subcommand is supported. More will probably be added later, to support different resource mappings.

knife graph

This plugin uses graphviz's dot to render the graph to jpg. Running the following command will create the file knife-graph.jpg with the exported data.

knife graph # => knife-graph.jpg

A couple of options are available:

Environment

If environment is set (-E|--environment), the plugin will use the environment specific run_list if exists. i.e. the same resolving Chef does when executing a run_list.

-O FILENAME, --output=FILENAME

Sets the output filename (and type according to the extension, supported types) If the .dot extension is used, no rendering is performed. With .dot you could use the file, to make custom manipulations or render it using your favorite tool. Use a dash (-) to set output to STDOUT.

-t TYPE, --type=TYPE

If STDOUT output is used, this option sets the type. Otherwise, ignored. (Default is jpg)

Examples

knife graph -E production # => knife-graph.jpg using environment run_list of production if available
knife graph -O knife-graph.bmp # => knife-graph.bmp
knife graph -O knife-graph.dot # => knife-graph.dot
knife graph -O- -tjpg > my-chef-installation.jpg # => JPG output to STDOUT

Build and Install

$ rake gem
$ gem install pkg/knife-graph-VERSION.gem