Модуль community.general.gunicorn — запуск gunicorn с различными настройками

Примечание

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

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

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

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

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

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

Запускает gunicorn с указанными параметрами. Поддерживаются распространённые настройки конфигурации gunicorn. Для дополнительной настройки используйте файл конфигурации. Список дополнительных параметров см. на странице https://gunicorn-docs.readthedocs.io/en/latest/settings.html. Рекомендуется всегда использовать параметр chdir, чтобы избежать проблем с расположением приложения.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

gunicorn

Параметры

Параметр	Комментарии
app псевдонимы: name строка / обязательный	Модуль приложения. Имя указывает на вызываемый объект WSGI, который должен находиться в указанном модуле.
chdir путь	Перед загрузкой приложений перейти в указанный каталог.
config псевдонимы: conf путь	Путь к файлу конфигурации gunicorn.
pid путь	Имя файла для файла PID. Если параметр не задан и файл не указан в конфигурации, создаётся временный файл PID для проверки успешного запуска gunicorn.
user строка	Переключить рабочие процессы на запуск от имени этого пользователя.
venv псевдонимы: virtualenv путь	Путь к каталогу virtualenv.
worker строка	Тип используемых рабочих процессов. Класс по умолчанию (sync) подходит для большинства «обычных» типов нагрузки. Варианты: `"sync"` `"eventlet"` `"gevent"` `"tornado "` `"gthread"` `"gaiohttp"`

Атрибуты

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

Примечания

Примечание

Если файл конфигурации не указан, во временном каталоге /tmp создаётся временный журнал ошибок. Убедитесь, что у вас есть права на запись в каталог /tmp. Это не обязательно, но поможет выявить проблемы с конфигурацией.

Примеры

- name: Simple gunicorn run example
  community.general.gunicorn:
    app: 'wsgi'
    chdir: '/workspace/example'

- name: Run gunicorn on a virtualenv
  community.general.gunicorn:
    app: 'wsgi'
    chdir: '/workspace/example'
    venv: '/workspace/example/venv'

- name: Run gunicorn with a config file
  community.general.gunicorn:
    app: 'wsgi'
    chdir: '/workspace/example'
    conf: '/workspace/example/gunicorn.cfg'

- name: Run gunicorn as ansible user with specified pid and config file
  community.general.gunicorn:
    app: 'wsgi'
    chdir: '/workspace/example'
    conf: '/workspace/example/gunicorn.cfg'
    venv: '/workspace/example/venv'
    pid: '/workspace/example/gunicorn.pid'
    user: 'ansible'

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
gunicorn строка	Идентификатор процесса gunicorn. Возвращается: changed Пример: `"1234"`

Авторы

Alejandro Gomez (@agmezr)

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

© 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/gunicorn_module.html