Skip to content
This repository was archived by the owner on Nov 8, 2021. It is now read-only.

Latest commit

 

History

History
97 lines (63 loc) · 3.2 KB

README.md

File metadata and controls

97 lines (63 loc) · 3.2 KB

Chef Network Visualiser

Also known as "the bouncy thing".

This little application was written over the course of a weekend during Christmas 2015. The application came about because I wanted to see the Network schema from the viewpoint of the nodes registered with our Chef server. There were hard coded elements so that I could see how the Network topology was organised. For example

  • load balancer connect to application firewall
  • application firewall connect to varnish servers
  • varnish servers connect to web servers ... etc

Requirements

You will need

Optional

  • Access to a Chef server with Chef client configuration file

Installation

Clone or download the source code.

Go to the root of this application and use bundler to install gems

$ bundle install

This project was originally built on a Windows 8 (then 10) laptop and the Gemfile.lock contains win32-api gem.

If using Linux then update the bundle with

$ bundle update

Running

This application is built on top of Sinatra, a RACK friendly application. Run the web application with bundle exec

$ bundle exec rackup

The application will look for a Chef client configuration file in the following locations

  • Root of this folder
  • ~/.chef (users home folder, then .chef folder)

The command line should inform whether it is using a Chef client configuration file (client.rb or knife.rb) or using Chef zero for the purposes of demo.

Image of application run with bundle exec rackup

The command line will also tell you which port the application is running on (default 9292).

Open a browser, enter the address as localhost plus the port the application is running on, press return and the index.html page will fire up ...

Image of browser with index page loaded

Usage

The application has two modes out of the box

  • View network by Chef Roles
  • View network by Chef Environments

To switch between the modes you'll have to alter the code in application.rb, only one view can be active at any one time.

The first thing to do is select Role/Environment from the Cloud drop down.

Image of cloud selection

After selecting the Role or Environment the matching nodes should appear.

Image of network nodes

From now you'll be able to

  • Click a node to obtain more detail (displayed in the right hand pane)
  • Search for a node/Role/Environment using the Search text box
  • Put cursor on the nodes and flick them about (the bouncy thing)

Ruby versions

Works with Ruby versions

  • 1.9.3
  • 2.3.1p112 (2016-04-26 revision 54768) [i386-mingw32]
  • ruby 2.4.2p198 (2017-09-14 revision 59899) [x64-mingw32]

Other

This was written for demo purposes / fun, code is not production ready, may contain bugs, does not contain nuts, some enjoyment maybe possible with the bouncy thing.

If you like this application or wish to improve it then please feel free to do so.

Next: An improved UI? ... to be continued.