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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.supervisorctl.

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

Краткое описание

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

Требования

Следующие требования необходимы на хосте, на котором выполняется этот модуль.

supervisorctl

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/supervisorctl_module.html