Fabric Integration

chef.fabric.chef_roledefs(api=None, hostname_attr=['cloud.public_hostname', 'fqdn'], environment=<object object>)

Build a Fabric roledef dictionary from a Chef server.


from fabric.api import env, run, roles
from chef.fabric import chef_roledefs

env.roledefs = chef_roledefs()

def mytask():

hostname_attr can either be a string that is the attribute in the chef node that holds the hostname or IP to connect to, an array of such keys to check in order (the first which exists will be used), or a callable which takes a Node and returns the hostname or IP to connect to.

To refer to a nested attribute, separate the levels with '.' e.g. 'ec2.public_hostname'

environment is the Chef Environment name in which to search for nodes. If set to None, no environment filter is added. If set to a string, it is used verbatim as a filter string. If not passed as an argument at all, the value in the Fabric environment dict is used, defaulting to '_default'.


environment must be set to None if you are emulating Chef API version 0.9 or lower.

New in version 0.1.

New in version 0.2: Support for iterable and callable values for the``hostname_attr`` argument, and the environment argument.

chef.fabric.chef_environment(name, api=None)

A Fabric task to set the current Chef environment context.

This task works alongside chef_roledefs() to set the Chef environment to be used in future role queries.


from chef.fabric import chef_environment, chef_roledefs
env.roledefs = chef_roledefs()
$ fab env:production deploy

The task can be configured slightly via Fabric env values.

env.chef_environment_task_alias sets the task alias, defaulting to “env”. This value must be set before chef.fabric is imported.

env.chef_environment_validate sets if Environment names should be validated before use. Defaults to True.

New in version 0.2.

chef.fabric.chef_query(query, api=None, hostname_attr=['cloud.public_hostname', 'fqdn'], environment=<object object>)

A decorator to use an arbitrary Chef search query to find nodes to execute on.

This is used like Fabric’s roles() decorator, but accepts a Chef search query.


from chef.fabric import chef_query

@chef_query('roles:web AND tags:active')
def deploy():

New in version 0.2.1.

chef.fabric.chef_tags(*tags, **kwargs)

A decorator to use Chef node tags to find nodes to execute on.

This is used like Fabric’s roles() decorator, but accepts a list of tags.


from chef.fabric import chef_tags

@chef_tags('active', 'migrator')
def migrate():

New in version 0.2.1.