Skip to main content

ZC Buildout recipe for organizing startup scripts.

Project description

Code repository: http://svn.plone.org/svn/collective/buildout/plone.recipe.cluster/

Change history

trunk (2008-08-11)

  • xxx [Ingeniweb]

0.1.0 (unreleased)

  • Initial implementation of Linux daemon. [tarek]

  • Created recipe with ZopeSkel. [tarek]

Detailed Documentation

Supported options

The recipe supports the following options:

debug

default option is 0. When set to 1, allows tests to run on a non-blocking daemon.

start

Multiline option. Each line is a command line that will be called by the daemon when it is called with the start option. The commands must return immediatly, because the daemon waits for it before it launches the next command.

It is possible though, to push a command line in the background with the background: prefix.

stop

Multiline option. Each line is a command line that will be called by the daemon when it is called with the stop option. The commands must return immediatly, because the daemon waits for it before it launches the next command.

It is possible to ask the daemon to kill a given process, by providing a pid:value command line. Where value is either a PID number, either a text files that contains a pid.

The background: prefix is also available.

restart

Multiline option. Each line is a command line that will be called by the daemon when it is called with the restart option. The commands must return immediatly, because the daemon waits for it before it launches the next command.

It is possible to ask the daemon to kill a given process, by providing a pid:value command line. Where value is either a PID number, either a text files that contains a pid.

The background: prefix is also available.

pid-file

Defines the path to the PID file of the daemon.

Example usage

The cluster recipe allows you to create composite commands for your buildout. There are three commands:

  • start

  • stop

  • restart

Each command is a variable with a list of commands to be run. The recipe then launches: - a daemon under Linux based system - a NT service under Windows

A typical usage for instance is to start zeo, zope and pound:

[buildout]

...

[cluster]
recipe = plone.recipe.cluster

poundctl = ${buildout:bin-directory}/pound -f ${buildout:directory}/parts/pound/etc/pound.cfg -c ${buildout:directory}/pound.pid


start =
    ${buildout:bin-directory}/zeoserver start
    ${buildout:bin-directory}/instance start
    ${cluster:poundctl}

stop =
    ${buildout:bin-directory}/zeoserver stop
    ${buildout:bin-directory}/instance stop
    pid:${buildout:directory}/pound.pid

restart =
    ${buildout:bin-directory}/zeoserver restart
    ${buildout:bin-directory}/instance restart
    ${cluster:poundctl}

Let’s try this:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = cluster
... index = http://pypi.python.org/simple
... [cluster]
... recipe = plone.recipe.cluster
... debug = 1
... start =
...    background:${buildout:bin-directory}/script1
...    ${buildout:bin-directory}/script2 start
...
... stop =
...    ${buildout:bin-directory}/script2 stop
...
... restart =
...    background:${buildout:bin-directory}/script1
...    ${buildout:bin-directory}/script2 restart
...
... """)

Running the buildout gives us:

>>> print system(buildout)
Getting distribution for 'zc.recipe.egg'.
Got zc.recipe.egg 1.0.0.
Installing cluster.
Generated script '/.../bin/cluster'.
<BLANKLINE>

Now let’s see the script that was created:

>>> script = join(sample_buildout, 'bin', 'cluster')
>>> print open(script).read()
#!...python
<BLANKLINE>
import sys
sys.path[0:0] = [
  ...
  ]
<BLANKLINE>
import plone.recipe.cluster.ctl
<BLANKLINE>
if __name__ == '__main__':
    plone.recipe.cluster.ctl.main(...)
<BLANKLINE>

Let’s create false scripts:

>>> script2 = join(sample_buildout, 'bin', 'script2')
>>> f = open(script2, 'w')
>>> f.write('echo script 2')
>>> f.close()
>>> import os
>>> os.chmod(script2, 0770)

>>> script1 = join(sample_buildout, 'bin', 'script1')
>>> f = open(script1, 'w')
>>> import sys
>>> f.write("""\
... #!%s
... import time
... while 1:
...     time.sleep(0.1)
... """ % sys.executable)
>>> f.close()
>>> os.chmod(script1, 0770)

Let’s try to execute it:

>>> print system(script)
usage: /sample-buildout/bin/cluster start|stop|restart|status
<BLANKLINE>

Let’s ask for the status:

>>> print system('%s status' % script)
Not running.

Ah right, let’s start it !

>>> print system('%s start' % script)
Cluster is starting...
Running in background ...script1
Background pid is ...
Background subpid is ...
Running ...script2 start
script 2
Child PIDs: ..., ...
Started with pid ...
Cluster is alive...
<BLANKLINE>

Let’s ask for the status:

>>> print system('%s status' % script)
Running.

We should not be able to start it twice:

>>> print system('%s start' % script)
<BLANKLINE>
Start aborded since pid file '...' exists.
<BLANKLINE>

Let’s stop it:

>>> print system('%s stop' % script)
<BLANKLINE>
Cluster is going down...
<BLANKLINE>

Let’s restart it:

>>> print system('%s restart' % script)
Could not stop, pid file 'cluster.pid' missing.
<BLANKLINE>

Oh right, it was stopped !

Contributors

Tarek Ziade, Author

Download

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plone.recipe.cluster-0.1.0.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

plone.recipe.cluster-0.1.0-py2.4.egg (40.1 kB view details)

Uploaded Source

File details

Details for the file plone.recipe.cluster-0.1.0.tar.gz.

File metadata

File hashes

Hashes for plone.recipe.cluster-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4230aec69c0a743aeef85be0f869fbfb29482974f18a7ed9860d060d3b791c70
MD5 1c0ee12a8308970d8c4f3203641b3fd8
BLAKE2b-256 3bf6989f1283e44dda28437aba97ada14e73f2a23f8fb8cf2fc99df6760c6817

See more details on using hashes here.

Provenance

File details

Details for the file plone.recipe.cluster-0.1.0-py2.4.egg.

File metadata

File hashes

Hashes for plone.recipe.cluster-0.1.0-py2.4.egg
Algorithm Hash digest
SHA256 83578acadd2602afa7e9f768f5792cbc8bcd6f87d09ec6a8b72343be14efe9ac
MD5 e49fc70887da3c0d34421536c1daec8d
BLAKE2b-256 a6d56a76b7ebf0d3f366345f95f81603f11ed92d504f83859a6bf15b0a05fc44

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page