ironic/releasenotes/notes/add-wsgi-entrypoints-79f8f3cf3b7a663f.yaml
Jay Faulkner 3db454f0ea Enable WSGI module entrypoint for Ironic
This adds a wsgi entrypoint module which can be used with a wsgi runner,
such as uwsgi, to launch Ironic API processes without the need of a
separate script.

The legacy WSGI script is currently being installed by PBR, and as part
of the migration to a pyproject.yaml-compatible PBR, we cannot use the
wsgi-scripts plugin anymore, and will be removing the script installed
by it in a future Ironic release.

The new WSGI script, because it has statements at the module top-level,
cannot be autodocumented; we now exclude it.

Also we don't treat all warnings as errors in pdf docs builds to allow
the use of mock autosummary, starting with including the wsgi module.

Co-Authored-By: Doug Goldstein <cardoe@cardoe.com>
Change-Id: I584ac6a25c4e6cd9744a609b50d12b434a930dc6
2024-10-25 16:57:05 +02:00

19 lines
425 B
YAML

features:
- |
A new module, ``ironic.wsgi`` has been enabled as an entrypoint for WSGI
runners. For example, if using uWSGI then now instead of:
.. code-block:: ini
[uwsgi]
wsgi-file = /bin/ironic-api-wsgi
You can now use:
.. code-block:: ini
[uwsgi]
module = ironic.wsgi:application
Legacy installed wsgi scripts will be removed in a future version of Ironic.