community.general.gunicorn 模块 – 使用各种设置运行 gunicorn

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：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 路径	虚拟环境目录的路径。
worker 字符串	要使用的工作程序类型。默认类 (sync) 应处理大多数“正常”类型的工作负载。选项 `"sync"` `"eventlet"` `"gevent"` `"tornado"` `"gthread"` `"gaiohttp"`

属性 

属性	支持	描述
check_mode	支持：无	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：无	当处于差异模式时，将返回有关已更改（或可能需要在 `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 的进程 ID 已返回：已更改示例： `"1234"`

作者

Alejandro Gomez (@agmezr)