Skip to content
This repository

Knife plugin for Chef to draw dependency graphs for roles. Cut through the spaghetti with a knife.

branch: master
README.md

knife-role-spaghetti

Gem Version Dependency Status Build Status BuildHeroes Code Climate

Knife plugin for Chef to draw dependency graphs for roles that have become spaghetti.

Installation

Requirements

Ruby 1.9.2 and higher.

This plugin requires on Graphviz, and should be installed prior to installing the plugin.

Graphviz may be obtained through a variety of methods. On OSX an easy method is via Homebrew:

$ brew install graphviz

Gem install, via RubyGems:

$ gem install knife-role-spaghetti

Usage

NOTE: Ensure that your knife.rb has the role_path setting configured.

Since this is a Knife plugin, execution should be performed in your Chef repository.

Execute:

$ knife role spaghetti

with no arguments should result in a new file named role-spaghetti.png in your repo root.

$ knife role spaghetti "/tmp/someotherfilename.png"

will place the file in the specified location.

Execute knife role spaghetti -h for more options.

Examples

From a sample role, courtesy of @jtimberman, along with one from the Opscode Wiki, plus one more cyclic role model, produces this image:

Sample Roles

(full resolution here)

Running through the neato renderer (with the -N switch) produces this image:

Sample Roles Neato

(full resolution here)

License

Author:: Mike Fiedler (miketheman@gmail.com) endorse Copyright:: Copyright (c) 2012-2013 Mike Fiedler License:: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.