supervisorclusterctl’s documentation¶

Control Machine Requirements¶

supervisorclusterctl requires Ansible to be installed on the control machine. You only need to install Ansible on one machine and it can control an entire fleet of remote nodes from that central point.

Currently Ansible can be run from any machine with Python 2.6 installed (Windows isn’t supported for the control machine). This includes Red Hat, Debian, CentOS, OS X, any of the BSDs, and so on.

Ansible can be installed via “pip”, the Python package manager. If ‘pip’ isn’t already available in your version of Python, you can get pip by:

$ sudo easy_install pip

Then install Ansible with:

$ sudo pip install ansible

Managed Node Requirements¶

supervisorclusterctl requires Supervisor to be installed on the remote nodes.

Supervisor can be installed via “pip”:

$ sudo pip install supervisor

Installing supervisorclusterctl¶

$ sudo pip install supervisorclusterctl

$ git clone https://github.com/RobWin/supervisorclusterctl.git
$ cd ./supervisorclusterctl
$ sudo python setup.py install

$ sudo python setup.py bdist_rpm

Running supervisorclusterctl¶

Now that you’ve installed supervisorclusterctl, it’s time to get started with some basics.

Run help to see all available command-line commands, arguments and options

$ supervisorclusterctl -h
     usage: supervisorclusterctl [-h] [-v] [-s] [-V]
                                 host-pattern
                                 {status,reread,reload,update,start,stop,restart,remove}
                                 ...

     supervisorclusterctl is a cmd line tool that allows to control a cluster of
     processes by utilizing Supervisor and Ansible.

     positional arguments:
       host-pattern          A host-pattern usually refers to a group of hosts. For
                             more details, see Ansible documentation about
                             Patterns.
       {status,reread,reload,update,start,stop,restart,remove}
                             One of the available supervisorctl actions.
         status              Get status info of all processes.
         reread              Reread the configuration files of supervisord
         reload              Restart remote supervisord
         update              Reload the configuration files of supervisord and
                             add/remove processes as necessary
         start               Start a process by name
         stop                Stop a process by name
         restart             Restart a process by name
         remove              Remove a process by name

     optional arguments:
       -h, --help            show this help message and exit
       -v, --verbose         run in verbose mode (-vvv for more, -vvvv to enable
                             connection debugging)
       -s, --sudo            run supervisorctl actions with sudo (nopasswd))
       -V, --version         show program's version number and exit

Run subcommand help to see all available arguments and options of the subcommand

$ supervisorclusterctl production restart -h
     usage: supervisorclusterctl host-pattern start [-h] process-name

     positional arguments:
       process-name  Name of the process

     optional arguments:
       -h, --help    show this help message and exit

Now edit /etc/ansible/hosts and put one or more remote systems in it, for which you have your SSH key in authorized_keys:

[production]
192.168.0.11
192.168.0.12
[development]
192.168.0.10

This is an inventory file, which is explained in greater detail in Ansible’s documentation

Run the supervisorclusterctl <host-pattern> status command to get the status of all Supervisor managed processes on all of your configured production nodes:

$ supervisorclusterctl production status
     192.168.0.11 | success | rc=0 >>
     managed_service         RUNNING    pid 12136, uptime 21:50:02

     192.168.0.12 | success | rc=0 >>
     managed_service         RUNNING    pid 12261, uptime 21:50:02

Now you are able to restart the managed_service process on all of your configured production nodes:

$ supervisorclusterctl production restart managed_service
     192.168.0.11 | success | rc=0 >>
     managed_service: stopped
     managed_service: started

     192.168.0.12 | success | rc=0 >>
     managed_service: stopped
     managed_service: started

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up supervisorclusterctl for local development.

1. Fork the supervisorclusterctl repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/supervisorclusterctl.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv supervisorclusterctl
   $ cd supervisorclusterctl/
   $ python setup.py develop
   

4. 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 are working:

   $ python setup.py test
   

6. 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
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

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

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated.
3. The pull request should work for Python 2.6 and 2.7. Check https://travis-ci.org/RobWin/supervisorclusterctl/pull_requests and make sure that the tests pass for all supported Python versions.

Development Lead¶

• Robert Winkler <rbrtwnklr@gmail.com>

Contributors¶

None yet. Why not be the first?

0.1.2¶

• Fixed issue #1: reload not working

0.1.1¶

• supervisorclusterctl returns the return code of the ansible call now
• Added new unit tests and fixed the setup.py

0.1.0¶

• Initial release.