collective.recipe.supervisorprograms 0.1.0

Offers a new syntax to configure collective.recipe.supervisor

Overview

This recipe helps to configure the programs option of the collective.recipe.supervisor recipe.

Instead of doing this:

[supervisor]
recipe = collective.recipe.supervisor
# (...)
programs =
      10 process1 ${buildout:bin-directory}/process1
      20 process2 ${buildout:bin-directory}/process2

You’ll do this:

[supervisor]
recipe = collective.recipe.supervisor
programs = ${supervisor-programs:programs}

[supervisor-programs]
recipe = collective.recipe.supervisorprograms

[process1-program]
priority = 10
command = {buildout:bin-directory}/process1

[process2-program]
priority = 20
command = {buildout:bin-directory}/process2

All options accepted by collective.recipe.supervisor are supported.

Configuring programs

The recipe will scan the buildout configuration looking for all sections with names ending in -program. Each section will specify one program to be controlled by supervisor. The programs option of this recipe then will contain the value to be passed to the programs option of the collective.recipe.supervisor part.

The *-program sections accepts the following options:

• priority

• command

• args

• directory

• redirect-stderr

• user

Only priority and command are required. The value of the args option should not be between []. Any other options will be inserted into the process_opts field of collective.recipe.supervisor.

The process_name will be extracted from the section name.

Example usage

We’ll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = fake-supervisor
...
... [fake-supervisor]
... recipe = collective.recipe.supervisorprograms:printer
... programs = ${supervisor-programs:programs}
...
... [supervisor-programs]
... recipe = collective.recipe.supervisorprograms
...
... [program-base]
... redirect-stderr = true
...
... [first-program]
... <= program-base
... priority = 10
... command = bin/first
... directory = /tmp/first
...
... [second-program]
... <= program-base
... priority = 20
... command = bin/second
... directory = /tmp/second
... user = www-data
... args = -a -b --verbose=1
... startsecs = 10
...
... """)

The :printer recipe is used to print out the generated programs option. We don’t want to install supervisor just to test. In real life you would replace the fake-supervisor section by:

[supervisor]
recipe = collective.recipe.supervisor
# (...)
programs = ${supervisor-programs:programs}

Also, we’re using the inheritance feature of buildout (<= program-base) to show how to define default parameters for all programs. Its use is optional.

Running the buildout gives us:

>>> print 'start', system(buildout)
start...
programs = 10 first bin/first /tmp/first true
20 second (startsecs=10) bin/second [-a -b --verbose=1] /tmp/second true www-data
<BLANKLINE>

Handling multiple similar programs

There are some use cases when you have multiple programs which are very similar. For example, it’s common to have multiple Zope instances in a cluster setup.

The :multiplier recipe supports this use case in a limited but useful way. Given a base program section it clones it N times, varying only the command option by appending a -{index} suffix. This means you can have a base program with command being bin/instance and multiply it N times generating bin/instance-1, bin/instance-2 and so on.

Here’s an example:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = program-multiplier fake-supervisor
...
... [fake-supervisor]
... recipe = collective.recipe.supervisorprograms:printer
... programs = ${supervisor-programs:programs}
...
... [supervisor-programs]
... recipe = collective.recipe.supervisorprograms
...
... [foo-program]
... priority = 10
... command = /path/to/foo
... directory = /tmp/foo
...
... [program-multiplier]
... recipe = collective.recipe.supervisorprograms:multiplier
... program-section = foo-program
... count = 2
... """)

Running the buildout gives us:

>>> print 'start', system(buildout)
start...
programs = 10 foo /path/to/foo /tmp/foo
10 foo-1 /path/to/foo-1 /tmp/foo
10 foo-2 /path/to/foo-2 /tmp/foo
<BLANKLINE>

Changelog

0.1.0 (2017-07-20)

• Added :multiplier recipe.

• Sort programs in a meaningful way for better readability.

0.0.1 (2016-11-24)

• First release.