New in version 2.4.
Parameter | Choices/Defaults | Comments |
---|---|---|
app
-
/ required
|
The app module. A name refers to a WSGI callable that should be found in the specified module.
aliases: name |
|
chdir
-
|
Chdir to specified directory before apps loading.
|
|
config
-
|
Path to the gunicorn configuration file.
|
|
pid
-
|
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.
|
|
user
-
|
Switch worker processes to run as this user.
|
|
venv
-
|
Path to the virtualenv directory.
aliases: virtualenv |
|
worker
-
|
|
The type of workers to use. The default class (sync) should handle most "normal" types of workloads.
|
Note
- name: simple gunicorn run example
gunicorn:
app: 'wsgi'
chdir: '/workspace/example'
- name: run gunicorn on a virtualenv
gunicorn:
app: 'wsgi'
chdir: '/workspace/example'
venv: '/workspace/example/venv'
- name: run gunicorn with a config file
gunicorn:
app: 'wsgi'
chdir: '/workspace/example'
conf: '/workspace/example/gunicorn.cfg'
- name: run gunicorn as ansible user with specified pid and config file
gunicorn:
app: 'wsgi'
chdir: '/workspace/example'
conf: '/workspace/example/gunicorn.cfg'
venv: '/workspace/example/venv'
pid: '/workspace/example/gunicorn.pid'
user: 'ansible'
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
gunicorn
string
|
changed |
process id of gunicorn
Sample:
1234
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.