community.general.gunicorn module – Run gunicorn with various settings
Note
This module is part of the community.general collection (version 5.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.gunicorn
.
Synopsis
Starts gunicorn with the parameters specified. Common settings for gunicorn configuration are supported. For additional configuration use a config file See https://gunicorn-docs.readthedocs.io/en/latest/settings.html for more options. It’s recommended to always use the chdir option to avoid problems with the location of the app.
Requirements
The below requirements are needed on the host that executes this module.
gunicorn
Parameters
Parameter |
Comments |
---|---|
The app module. A name refers to a WSGI callable that should be found in the specified module. |
|
Chdir to specified directory before apps loading. |
|
Path to the gunicorn configuration file. |
|
A filename to use for the PID file. If not set and not found on the configuration file a tmp pid file will be created to check a successful run of gunicorn. |
|
Switch worker processes to run as this user. |
|
Path to the virtualenv directory. |
|
The type of workers to use. The default class (sync) should handle most “normal” types of workloads. Choices:
|
Notes
Note
If not specified on config file, a temporary error log will be created on /tmp dir. Please make sure you have write access in /tmp dir. Not needed but will help you to identify any problem with configuration.
Examples
- 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'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
process id of gunicorn Returned: changed Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication