# salt.modules.zcbuildout

Management of zc.buildout

Added in version 2014.1.0.

This module is inspired by minitage's buildout maker

Note

The zc.buildout integration is still in beta; the API is subject to change

## General notes

You have those following methods:

- upgrade_bootstrap

- bootstrap

- run_buildout

- buildout

salt.modules.zcbuildout.bootstrap(*a, **kw)

  Run the buildout bootstrap dance (python bootstrap.py).

  directory

    directory to execute in

  config

    alternative buildout configuration file to use

  runas

    User used to run buildout as

  env

    environment variables to set when running

  buildout_ver

    force a specific buildout version (1 | 2)

  test_release

    buildout accept test release

  offline

    are we executing buildout in offline mode

  distribute

    Forcing use of distribute

  new_st

    Forcing use of setuptools >= 0.7

  python

    path to a python executable to use in place of default (salt one)

  onlyif

    Only execute cmd if statement on the host return 0

  unless

    Do not execute cmd if statement on the host return 0

  use_vt

    Use the new salt VT to stream output [experimental]

  CLI Example:

      salt '*' buildout.bootstrap /srv/mybuildout

salt.modules.zcbuildout.buildout(*a, **kw)

  Run buildout in a directory.

  directory

    directory to execute in

  config

    buildout config to use

  parts

    specific buildout parts to run

  runas

    user used to run buildout as

  env

    environment variables to set when running

  buildout_ver

    force a specific buildout version (1 | 2)

  test_release

    buildout accept test release

  new_st

    Forcing use of setuptools >= 0.7

  distribute

    use distribute over setuptools if possible

  offline

    does buildout run offline

  python

    python to use

  debug

    run buildout with -D debug flag

  onlyif

    Only execute cmd if statement on the host return 0

  unless

    Do not execute cmd if statement on the host return 0

  newest

    run buildout in newest mode

  verbose

    run buildout in verbose mode (-vvvvv)

  use_vt

    Use the new salt VT to stream output [experimental]

  CLI Example:

      salt '*' buildout.buildout /srv/mybuildout

salt.modules.zcbuildout.run_buildout(*a, **kw)

  Run a buildout in a directory.

  directory

    directory to execute in

  config

    alternative buildout configuration file to use

  offline

    are we executing buildout in offline mode

  runas

    user used to run buildout as

  env

    environment variables to set when running

  onlyif

    Only execute cmd if statement on the host return 0

  unless

    Do not execute cmd if statement on the host return 0

  newest

    run buildout in newest mode

  force

    run buildout unconditionally

  verbose

    run buildout in verbose mode (-vvvvv)

  use_vt

    Use the new salt VT to stream output [experimental]

  CLI Example:

      salt '*' buildout.run_buildout /srv/mybuildout

salt.modules.zcbuildout.upgrade_bootstrap(*a, **kw)

  Upgrade current bootstrap.py with the last released one.

  Indeed, when we first run a buildout, a common source of problem is to have a locally stale bootstrap, we just try to grab a new copy

  directory

    directory to execute in

  offline

    are we executing buildout in offline mode

  buildout_ver

    forcing to use a specific buildout version (1 | 2)

  onlyif

    Only execute cmd if statement on the host return 0

  unless

    Do not execute cmd if statement on the host return 0

  CLI Example:

      salt '*' buildout.upgrade_bootstrap /srv/mybuildout