Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Knife plugin for Chef to draw dependency graphs for roles. Cut through the spaghetti with a knife.
Ruby
Branch: master
Pull request Compare This branch is 1 commit ahead, 30 commits behind miketheman:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
features
lib
.gitignore
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
knife-role-spaghetti.gemspec

README.md

knife-role-spaghetti

Build Status Dependency Status 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

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Test your changes (rake test)
  4. Commit your changes (git commit -am 'Added some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

Changelog

v0.0.4

  • Allows for better Chef version dependency management, thanks @patcon!
  • Better Travis testing: more Chef versions, better timeout handling
  • Locked down a bunch of gem dependencies
  • Updated minimum required ruby to 1.9.2

v0.0.3

  • Fixed JSON roles loading #7 - Thanks @miah & @tezz!
  • Re-implemented the DRY proposed by @jtimberman in #1, with a different method
  • Prevent a role and recipe sharing the same name from colliding
  • Figured out correct testing requirements matrix for Travis
  • Added some more verbose logging options

v0.0.2

  • Updated CLI banner to reflect that filename is not required, renamed for clarity
  • Improved handling cases where a role contains recipes named the same as the role
  • Added handling for roles in JSON format

v0.0.1

  • Initial commit

License

Author:: Mike Fiedler (miketheman@gmail.com) Copyright:: Copyright (c) 2012 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.