sous-chef 0.10.4

A small webapp for viewing and searching Chef nodes

A small webapp for viewing Chef nodes and other metadata. Currently supports nodes, roles, and environments, as well as package version information (see below).

Usage

Run Sous-chef using Gunicorn:

gunicorn 'sous_chef:create_app()'

Configuration

Sous-chef will read it’s configuration from one of two places, depending on how it was installed:

# Global install
/usr/var/sous_chef-instance/config.py

# Virtualenv install
$VIRTUALENV/var/sous_chef-instance/config.py

An example configuration file might look like this:

# The URL of the Chef server
CHEF_URL = 'http://chef.example.com'

# The client name and key to use
CHEF_CLIENT = 'sous'
CHEF_KEY = '/usr/var/sous_chef-instance/sous.pem'

If these are not set, PyChef’s autoconfigure function is used as a fallback, and will try and load it’s configuration from ~/.chef/knife.rb or /etc/chef/client.rb.

Package versions

Sous-chef will display package metadata from nodes if availible. It expects this data to be in the following format:

"packages": {
        "<package_type>": {
                "<package_name>": "<package_version",
                ...
        },
        ...
}

For example, an RPM Ohai plugin could set the following node attributes:

"packages": {
        "rpm": {
                "package-one": "0.1.0",
                "pacakge-two": "2.0.1"
        }
}

Debug mode

The app can be run in debug mode by using the create_debug_app function:

gunicorn 'sous_chef:create_debug_app()'

The flask-debugtoolbar package is availible, the DebugToolbar extension will be used.

Installation

Install Sous-chef and Gunicorn with:

pip install 'sous-chef[deploy]'

Requirements

Requires Flask and PyChef. Gunicorn is the simplest method of deployment, but is not a requirement (allowing alternate WSGI servers to be used). Optionally uses Flask Debug Toolbar using the debug application.

Compatibility

Targets Python 2.6 and 2.7.

PyChef is currently Python 2 only, but if or when it is availible for Python 3 Sous-chef should have no problems.

Licence

The MIT License (MIT)

Copyright (c) 2014 DataSift <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Authors

sous-chef was written by Sam Clements at DataSift.