UPGRADING.txt 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. Upgrading from supervisor 2 to supervisor 3
  2. - In '[program:x]' sections, the keys "logfile", "logfile_backups",
  3. "logfile_maxbytes", "log_stderr" and "log_stdout" are no longer
  4. valid. Supervisor2 logged both stderr and stdout to a single log
  5. file. Supervisor 3 logs stderr and stdout to separate log files.
  6. You'll need to rename "logfile" to "stdout_logfile",
  7. "logfile_backups" to "stdout_logfile_backups", and
  8. "logfile_maxbytes" to "stdout_logfile_maxbytes" at the very least to
  9. preserve your configuration. If you created program sections where
  10. "log_stderr" was true, to preserve the behavior of sending stderr
  11. output to the stdout log, use the "redirect_stderr" boolean in a
  12. program section.
  13. - The supervisor configuration file *must* include the following
  14. section verbatim for the XML-RPC interface (and thus the web
  15. interface and supervisorctl) to work properly::
  16. [rpcinterface:supervisor]
  17. supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
  18. - The semantics of the 'autorestart' parameter within '[program:x]'
  19. sections has changed. This parameter used to accept only 'true' or
  20. 'false'. It now accepts an additional value 'unexpected', which
  21. indicates that the process should restart from the EXITED state only
  22. if its exit code does not match any of those represented by the
  23. 'exitcode' parameter in the process' configuration (IOW, a process
  24. crash)a. In addition, the *default* for autorestart is now
  25. 'unexpected' (it used to be 'true', which meant restart
  26. unconditionally).
  27. - We now allow supervisor to listen on both a UNIX domain socket and
  28. an inet socket instead of making them mutually exclusive. As a
  29. result, the options "http_port", "http_username", "http_password",
  30. "sockchmod" and "sockchown" are no longer part of the
  31. '[supervisord]' section configuration. These have been supplanted by
  32. two other sections: '[unix_http_server]' and '[inet_http_server'].
  33. You'll need to insert one or the other (depending on whether you
  34. want to listen on a UNIX domain socket or a TCP socket respectively)
  35. or both into your supervisord.conf file. These sections have their
  36. own options (where applicable) for port, username, password, chmod,
  37. and chown. See README.txt for more information about these sections.
  38. - All supervisord command-line options related to "http_port",
  39. "http_username", "http_password", "sockchmod" and "sockchown" have
  40. been removed (see above point for rationale).
  41. - The option that *used* to be 'sockchown' within the '[supervisord]'
  42. section (and is now named 'chown' within the '[unix_http_server]'
  43. section) used to accept a dot-separated user.group value. The
  44. separator now must be a colon ":", e.g. "user:group". Unices allow
  45. for dots in usernames, so this change is a bugfix.