A centralized supervisor UI (Web & CLI)
- Processes status always up to date
- Reactivity through asynchronous actions
- Notifications when state changes
- Mobile aware, SPA web page
- Powerful filters
- Interactive CLI
# Fetch the project:
git clone https://github.com/tiagocoutinho/multivisor
cd multivisor
# Install frontend dependencies
npm install
# Build for production with minification
npm run build
# install backend: feel free to use your favorite python virtual environment
# here. Otherwise you will need administrative privileges
pip install .
# Launch a few supervisors
mkdir examples/full_example/log
supervisord -c examples/full_example/supervisord_lid001.conf
supervisord -c examples/full_example/supervisord_lid002.conf
supervisord -c examples/full_example/supervisord_baslid001.conf
# Finally, launch multivisor:
multivisor -c examples/full_example/multivisor.confThat's it!
Start a browser pointing to localhost:22000. On a mobile device it should look something like this:
Type on the command line:
multivisor-cli
The multivisor backend runs a flask web server.
The multivisor-cli runs a
prompt-toolkit 2 based console.
The frontend is based on vue + vuex + vuetify.
Make sure multivisor is installed in the same environment as the one supervisor(s) is(are) running. Then, configure the multivisor rpc interface by adding the following lines to your supervisord.conf:
[rpcinterface:multivisor]
supervisor.rpcinterface_factory = multivisor.rpc:make_rpc_interface
bind=*:9002
If no bind is given, it defaults to *:9002.
Repeat the above procedure for every supervisor you have running.
The multivisor web server relies on the multivisor rpc interface running on
each supervisor.
The multivisor web server is configured with a INI like configuration file (much like supervisor itself). It is usually named multivisor.conf and it must be passed as argument to multivisor when starting the server.
It consists of a global section where you can give an optional name to your
multivisor instance (default is multivisor. This name will appear on the top
left corner of multivisor the web page).
To add a new supervisor to the list simply add a section [supervisor:<name>].
It accepts an optional url in the format [<host>][:<port>]. The default
is <name>:9002.
Here is some basic example:
[global]
name=ACME
[supervisor:roadrunner]
# since no url is given it will be roadrunner:9002
[supervisor:coyote]
# no host is given: defaults to coyote
url=:9011
[supervisor:bugsbunny]
# no port is given: defaults to 9002
url=bugsbunny.acme.org
[supervisor:daffyduck]
url=daffyduck.acme.org:9007
Of course the multivisor itself can be configured in supervisor as a normal program.
To protect multivisor from unwanted access, you can enable required authentication.
Specify username and password parameters in global section of your configuration file e.g.:
[global]
username=test
password=testYou can also specify password as SHA-1 hash in hex, with {SHA} prefix: e.g.
{SHA}a94a8fe5ccb19ba61c4c0873d391e987982fbbd3 (example hash is test in SHA-1).
In order to use authentication, you also need to set MULTIVISOR_SECRET_KEY environmental variable,
as flask sessions module needs some secret value to create secure session.
You can generate some random hash easily using python:
python -c 'import os; import binascii; print(binascii.hexlify(os.urandom(32)))'
Remember to restart the server after changes in configuration file.
# install frontend
npm install
# build for production with minification
npm run build
# install backend
pip install .
# serve at localhost:22000
multivisor -c multivisor.confStart a browser pointing to localhost:22000
You can run the backend using the webpack dev server to facilitate your development cycle:
First, start multivisor (which listens on 22000 by default):
python -m multivisor.server.web -c multivisor.confNow, in another console, run the webpack dev server (it will transfer the requests between the browser and multivisor):
npm run devThat's it. If you modify App.vue for example, you should see the changes
directly on your browser.