Skip to content

Commit d7740ad

Browse files
committed
Improved documentation
1 parent 892dc0a commit d7740ad

3 files changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@ Set up the latest or a specific version of supervisor in Debian-like systems.
1010
* `python` (will be installed)
1111
* `pip` (will not be installed)
1212

13+
when using `supervisor_install_method: pip`
14+
1315
#### Variables
1416

15-
* `supervisor_python_version_major` [default: `2`]: Python version to install `supervisor` for.
16-
* `supervisor_python_version` [default: `supervisor_python_version`]: Deprecated
17+
* `supervisor_install_method`: [default: `native`]: The way to install supervisor (e.g. `native` (from Ubuntu repo) or `pip`)
18+
19+
* `supervisor_pip_python_version_major` [default: `3`]: Python version to install `supervisor` for. Only relevant when using `supervisor_install_method: pip`
20+
* `supervisor_pip_package_version` [default: `latest`]: Supervisor version to install (e.g. `latest`, `3.3.1`). Only relevant when using `supervisor_install_method: pip`
1721

18-
* `supervisor_version` [default: `latest`]: Supervisor version to install (e.g. `latest`, `3.3.1`)
1922
* `supervisor_unix_http_server_file` [default: `/var/run/supervisor.sock`]: A path to a UNIX domain socket (e.g. `/tmp/supervisord.sock`) on which supervisor will listen for HTTP/XML-RPC requests. `supervisorctl` uses XML-RPC to communicate with supervisord over this port
2023
* `supervisor_unix_http_server_chmod` [default: `'0700'`]: Change the UNIX permission mode bits of the UNIX domain socket to this value at startup
2124
* `supervisor_unix_http_server_chown` [optional]: The user and group of `supervisor_unix_http_server_file` file. Use the following format: `user:group`

defaults/main.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
# defaults file
22
---
33
supervisor_install_method: native
4-
supervisor_native_dependencies:
5-
- "{{ supervisor_package_name }}"
64

7-
supervisor_pip_python_version_major: 2
8-
supervisor_pip_dependencies:
9-
- "python{{ supervisor_pip_python_version_major is version('3', '>=') | ternary('3', '') }}"
5+
supervisor_pip_python_version_major: 3
106
supervisor_pip_package_version: latest
117

128
supervisor_unix_http_server_file: /var/run/supervisor.sock

vars/main.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
---
33
supervisor_package_name: supervisor
44

5+
supervisor_native_dependencies:
6+
- "{{ supervisor_package_name }}"
7+
8+
supervisor_pip_dependencies:
9+
- "python{{ supervisor_pip_python_version_major is version('3', '>=') | ternary('3', '') }}"
10+
511
supervisor_install_prefix: "/usr/{{ (supervisor_install_method == 'native') | ternary('', 'local/') }}bin"
612

713
supervisor_default_file: "/etc/default/{{ supervisor_package_name }}"

0 commit comments

Comments
 (0)