Welcome to supervisorctl-serialrestart’s documentation!¶

Contents:

Supervisor serialrestart¶

Adds serialrestart command to Supervisor. This command works simmilar to restart but if you have multiple services, it sometimes is preferable to restart them one after another to minimize downtime.

It even supports wildcards.

Free software: BSD license
Documentation: http://supervisor-serialrestart.rtfd.org.

Installation¶

At the command line:

$ easy_install supervisor-serialrestart

Or:

$ pip install supervisor-serialrestart

And then add into your supervisor.conf:

[ctlplugin:serialrestart]
supervisor.ctl_factory = supervisorserialrestart.controllerplugin:make_serialrestart_controllerplugin

Usage¶

supervisor> status
baz:bar                          RUNNING
baz:foo                          RUNNING
one                              RUNNING

supervisor> serialrestart all
baz:bar: stopped
baz:bar: started
baz:foo: stopped
baz:foo: started
one: stopped
one: started

supervisor> serialrestart baz:*
baz:bar: stopped
baz:bar: started
baz:foo: stopped
baz:foo: started

$supervisor> serialrestart baz:b*
baz:bar: stopped
baz:bar: started

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/native2k/supervisor-serialrestart/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/native2k/supervisor-serialrestart/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up supervisor-serialrestart for local development.

Fork the supervisor-serialrestart repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/supervisor-serialrestart.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv supervisor-serialrestart
$ cd supervisor-serialrestart/
$ python setup.py develop
```

Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

  $ flake8 supervisorserialrestart tests
        $ python setup.py test
  $ tox

To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, and 2.7 and for PyPy. Check https://travis-ci.org/native2k/supervisor-serialrestart/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_supervisor-serialrestart