Inštalácia a konfigurácia správcu na Ubuntu 16.04

Supervízor je systém klient/server, ktorý sa používa na riadenie množstva procesov UNIX, presnejšie procesov súvisiacich s projektom alebo zákazníkom. Môžete napríklad použiť supervízor na vytvorenie a monitorovanie ľubovoľného počtu pracovných frontov vašej webovej aplikácie.

Komponenty tohto systému sú:

• supervízor: Serverová časť systému.
• Supervisorctl: Rozhranie príkazového riadka používané na interakciu so serverom.
• Webový server: Jednoduchý webový server a webové používateľské rozhranie so základnou funkcionalitou v porovnaní s Supervisorctl .
• Rozhranie XML-RPC: Rovnaký HTTP server, ktorý používa webový klient, obsluhuje rozhranie XML-RPC, ktoré možno použiť na ovládanie kontrolných programov.

V tomto návode nainštalujeme najaktuálnejšiu verziu supervízora, ukážeme si, ako vytvárať a spravovať programy prostredníctvom supervisorctl, a nakonfigurujeme webové rozhranie na správu našich programov.

Inštalácia a základná konfigurácia

Inštaláciu supervízora nainštalujeme cez easy_install, čo je funkcia setuptools pythonu.

Najprv aktualizujte zoznam miestnych balíkov a potom nainštalujte python setuptools.

sudo apt-get update && sudo apt-get install python-setuptools

Teraz môžeme nainštalovať supervízor.

sudo easy_install supervisor

Po dokončení inštalácie musíme vygenerovať náš konfiguračný súbor. Vytvorte priečinok s názvom supervisorvo vnútri /etc.

sudo mkdir /etc/supervisor

A potom vykonajte nasledujúce.

echo_supervisord_conf >  /etc/supervisor/supervisord.conf

Ak nie ste prihlásení s rootpoužívateľom, môže sa vám zobraziť Permission deniedchyba (aj s sudo). Je to spôsobené presmerovaním. Aby ste tomu zabránili, prihláste sa ako root.

sudo su

Potom môžete príkaz spustiť znova.

echo_supervisord_conf > /etc/supervisor/supervisord.conf

Teraz môžete nechať rootpoužívateľa s exitpríkazom. echo_supervisord_confPríkaz bol poskytnutý naším inštalácie supervízora.

Základná konfigurácia

Otvorte /etc/supervisor/supervisord.confsúbor a skontrolujte jeho obsah. Všimnite si, že tento konfiguračný súbor sa riadi INIsyntaxou a je rozdelený na sekcie (reprezentované zátvorkami ako v [section-name]).

Ak chcete pridať programy, ktoré bude spravovať supervízor, stačí vytvoriť príslušné [program]sekcie. Aby sme sa však vyhli problémom s hlavným konfiguračným súborom zakaždým, keď potrebujeme pridať (alebo zmeniť) program, použijeme túto [include]sekciu. Nájdite túto sekciu, zrušte jej komentár a potom ju upravte tak, aby vyzerala takto.

[include]
files=conf.d/*.conf

Teraz pre každý program, ktorý chceme pridať, vytvoríme .inisúbor v /etc/supervisor/conf.d/adresári. Poďme vytvoriť tento priečinok.

sudo mkdir /etc/supervisor/conf.d

Spustenie servera dohľadu

Ako už bolo uvedené, supervízor pozostáva zo servera a klientov, ktorí sa k nemu pripájajú. Aby sme mohli spravovať a ovládať programy, musíme spustiť server. Za týmto účelom zaregistrujeme server dohľadu v systemd, aby sa server mohol spustiť pri štarte systému.

Ak to chcete urobiť, vytvorte súbor s názvom supervisord.servicev /etc/systemd/systemadresári.

sudo touch /etc/systemd/system/supervisord.service

Pridajte do súboru nasledujúci obsah.

[Unit]
Description=Supervisor daemon
Documentation=http://supervisord.org
After=network.target

[Service]
ExecStart=/usr/local/bin/supervisord -n -c /etc/supervisor/supervisord.conf
ExecStop=/usr/local/bin/supervisorctl $OPTIONS shutdown
ExecReload=/usr/local/bin/supervisorctl $OPTIONS reload
KillMode=process
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target
Alias=supervisord.service

Aktivujte službu dohľadu.

sudo systemctl start supervisord.service

Pokiaľ je servisný súbor umiestnený v /etc/systemd/systemadresári, automaticky sa spustí pri štarte systému.

Môžete skontrolovať stav služby.

systemctl status supervisord.service

Môžete si tiež pozrieť denníky.

sudo journalctl -u supervisord.service

Pridávanie programov

Programy riadené supervízorom sú dané rôznymi [program]sekciami v konfigurácii. Pre každý program, ktorý chceme spravovať, vytvoríme samostatný konfiguračný súbor informujúci o ceste k spustiteľnému príkazu, prípadných premenných prostredia, ako postupovať v prípade vypnutia.

Najprv vytvorte jednoduchý skript, ktorý zaznamená časovú pečiatku. Vytvorte súbor s názvom hello_supervisor.sh(kdekoľvek budete chcieť, budeme odkazovať na úplnú cestu tohto skriptu).

touch hello_supervisor.sh

Teraz do nej vložte nasledujúci obsah

#!/bin/bash
while true
do 
    # Echo current timestamp to stdout
    echo Hello Supervisor: `date`
    # Echo 'error!' to stderr
    echo An error ocurred at `date`! >&2
    sleep 1
done

Teraz ho urobte spustiteľným

chmod +x hello_supervisor.sh

Z praktického hľadiska je tento skript takmer zbytočný. Môžeme ho však použiť na demonštráciu sily supervízora. Vytvorte zodpovedajúci konfiguračný súbor spustením nasledujúceho.

sudo touch /etc/supervisor/conf.d/hello_supervisor.conf

Teraz do tohto súboru vložte nasledujúci obsah.

[program:hello_supervisor]
command=/home/USER/hello_supervisor.sh
autostart=true
autorestart=true
stderr_logfile=/var/log/hello_supervisor.err.log
stdout_logfile=/var/log/hello_supervisor.out.log

Poznámka: Nezabudnite nahradiť USERsvojím používateľským menom.

We will review this configuration step by step.

[program:hello_supervisor]
command=/home/USER/hello_supervisor.sh

First, the configuration begins by defining a program of name hello_supervisor. It also informs the full path of the executable to be run.

autostart=true

This line states that this program should be automaticaly started when supervisor is started.

autorestart=true

If the program quits, for any reason, this line informs supervisor to automatically restart the process.

stderr_logfile=/var/log/hello_supervisor.err.log
stdout_logfile=/var/log/hello_supervisor.out.log

These lines define the logfile location for stderr and stdout, respectively.

Managing programs

Now that we have installed and configured supervisor, we are able to manage our processes.

After adding a new program, we should run the following two commands, to inform the server to reread the configuration files and to apply any changes.

sudo supervisorctl reread
sudo supervisorctl update

Now execute the supervisorctl client.

sudo supervisorctl

Uvíta vás zoznam zaregistrovaných procesov. Uvidíte volaný proces hello_supervisorso RUNNINGstavom.

hello_supervisor                 RUNNING   pid 6853, uptime 0:22:30
supervisor>

Zadajte helppre zoznam dostupných príkazov.

supervisor> help

default commands (type help <topic>):
=====================================
add    exit      open  reload  restart   start   tail   
avail  fg        pid   remove  shutdown  status  update 
clear  maintail  quit  reread  signal    stop    version

Stručne povedané, môžeme start, stopa restartprogramy odovzdaním názov programu ako argument príslušného príkazu.

supervisor> stop hello_supervisor 
hello_supervisor: stopped
supervisor> start hello_supervisor 
hello_supervisor: started
supervisor> restart hello_supervisor 
hello_supervisor: stopped
hello_supervisor: started
supervisor> 

tailPríkazom sa môžeme pozrieť aj na výstup programu .

supervisor> tail hello_supervisor 
Hello Supervisor: Mon Sep 25 19:27:29 UTC 2017
Hello Supervisor: Mon Sep 25 19:27:30 UTC 2017
Hello Supervisor: Mon Sep 25 19:27:31 UTC 2017

Pre stderrvýstup môžete použiť tailaj.

supervisor> tail hello_supervisor stderr
An error ocurred at Mon Sep 25 19:31:12 UTC 2017!
An error ocurred at Mon Sep 25 19:31:13 UTC 2017!
An error ocurred at Mon Sep 25 19:31:14 UTC 2017!

Vyvolaním statuspríkazu môžete zobraziť stav všetkých zaregistrovaných programov.

Po dokončení môžete skončiť.

supervisor> quit

Klient webového servera

Ak chcete povoliť prístup k dozorovanému webovému serveru, otvorte konfiguračný súbor dohľadu a nájdite príslušnú [inet_http_server]sekciu.

nano /etc/supervisor/supervisord.conf

Teraz aktualizujte konfiguráciu tejto časti nasledujúcim.

[inet_http_server]
port=*:9001
username=your_username
password=your_password

Nahraďte your_usernamea your_passwordpožadovanými povereniami uložte svoje úpravy a službu dohľadu nad reštartom.

sudo systemctl restart supervisord.service

Nezabudnite povoliť TCPprístup k portu 9001na vašej bráne firewall a potom prístup http://{server-ip}:9001z prehliadača. Na požiadanie uveďte svoje usernamea password. Teraz môžete ovládať svoje procesy z webu.

Záver

Nainštalovali sme najaktuálnejšiu verziu supervízora, naučili sme sa, ako ho nakonfigurovať na automatické spustenie systému pomocou systemd a tiež sme skontrolovali základné používanie supervisorctl. Pre pokročilejšiu konfiguráciu a prípady použitia si môžete pozrieť oficiálnu dokumentáciu pod dohľadom .