Модуль community.general.supervisorctl – Управление состоянием программы или группы программ, выполняемых через supervisord

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.general.supervisorctl.

Описание
Требования
Параметры
Атрибуты
Примечания
Примеры

Описание

Управление состоянием программы или группы программ, выполняемых через supervisord

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

supervisorctl

Параметры

Параметр	Комментарии
config путь	Путь к конфигурационному файлу supervisord
name строка / обязательно	Имя управляемой программы или группы программ supervisord. Имя будет принято как имя группы, если оно заканчивается двоеточием `:`. Если `name=all`, будут управляться все программы и группы программ.
password строка	пароль для аутентификации
server_url строка	URL, на котором слушает сервер supervisord
signal строка	Сигнал для отправки программе/группе, в сочетании с состоянием ‘signalled’. Необходимо, когда state=signalled.
state строка / обязательно	Желаемое состояние программы/группы. Выбоёр: `"present"` `"started"` `"stopped"` `"restarted"` `"absent"` `"signalled"`
stop_before_removing логическое добавлено в community.general 7.5.0	Использовать `stop_before_removing=true` для остановки программы/группы перед удалением Выбоёр: `false` ← (по умолчанию) `true`
supervisorctl_path путь	путь к исполняемому файлу supervisorctl
username строка	имя пользователя для аутентификации

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогнозируемый изменённый статус, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	При работе в режиме diff вернёт подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`).

Примечания

Примечание

Когда state=present, модуль вызовет supervisorctl reread а затем supervisorctl add если программа/группа не существует.
Когда state=restarted, модуль вызовет supervisorctl update а затем supervisorctl restart.
Когда state=absent, модуль вызовет supervisorctl reread и supervisorctl remove для удаления целевой программы/группы. Если программа/группа всё ещё запущена, действие завершится неудачей. Если вы хотите остановить программу/группу перед удалением, используйте stop_before_removing=true.

Примеры

- name: Manage the state of program to be in started state
  community.general.supervisorctl:
    name: my_app
    state: started

- name: Manage the state of program group to be in started state
  community.general.supervisorctl:
    name: 'my_apps:'
    state: started

- name: Restart my_app, reading supervisorctl configuration from a specified file
  community.general.supervisorctl:
    name: my_app
    state: restarted
    config: /var/opt/my_project/supervisord.conf

- name: Restart my_app, connecting to supervisord with credentials and server URL
  community.general.supervisorctl:
    name: my_app
    state: restarted
    username: test
    password: testpass
    server_url: http://localhost:9001

- name: Send a signal to my_app via supervisorctl
  community.general.supervisorctl:
    name: my_app
    state: signalled
    signal: USR1

- name: Restart all programs and program groups
  community.general.supervisorctl:
    name: all
    state: restarted

Авторы

Matt Wright (@mattupstate)
Aaron Wang (@inetfuture)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/supervisorctl_module.html