openstack/nova
Code Issues Proposed changes

Merge "devref and reno for nova-{api,metadata}-wsgi scripts"

Browse Source
This commit is contained in:
Jenkins
2017-05-03 16:12:44 +00:00
committed by Gerrit Code Review
parent 10e086697c 4b89755784
commit 03e76353a8
6 changed files with 50 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/index.rst
View File

@@ -159,6 +159,7 @@ Open Development.
quotas
threading
vmstates
wsgi
Architecture Evolution Plans
-----------------------------

1
doc/source/man/nova-api-metadata.rst
View File

@@ -41,6 +41,7 @@ SEE ALSO
========
* `OpenStack Nova <https://docs.openstack.org/developer/nova>`__
* `Using WSGI with Nova <https://docs.openstack.org/devloper/nova/wsgi.html>`__
BUGS
====

1
doc/source/man/nova-api-os-compute.rst
View File

@@ -41,6 +41,7 @@ SEE ALSO
========
* `OpenStack Nova <https://docs.openstack.org/developer/nova>`__
* `Using WSGI with Nova <https://docs.openstack.org/devloper/nova/wsgi.html>`__
BUGS
====

4
doc/source/man/nova-api.rst
View File

@@ -21,7 +21,8 @@ SYNOPSIS
DESCRIPTION
===========
nova-api is a server daemon that serves the nova EC2 and OpenStack APIs in separate greenthreads
nova-api is a server daemon that serves the metadata and compute APIs in
separate greenthreads
OPTIONS
=======
@@ -41,6 +42,7 @@ SEE ALSO
========
* `OpenStack Nova <https://docs.openstack.org/developer/nova>`__
* `Using WSGI with Nova <https://docs.openstack.org/devloper/nova/wsgi.html>`__
BUGS
====

36
doc/source/wsgi.rst Normal file
View File

@@ -0,0 +1,36 @@
Using WSGI with Nova
====================
Though the compute and metadata APIs can be run using independent scripts that
provide eventlet-based HTTP servers, it is generally considered more performant
and flexible to run them using a generic HTTP server that supports WSGI_ (such
as Apache_ or nginx_).
The nova project provides two automatically generated entry points that
support this: ``nova-api-wsgi`` and ``nova-metadata-wsgi``. These read
``nova.conf`` and ``api-paste.ini`` and generate the required module-level
``application`` that most WSGI servers require. If nova is installed using pip,
these two scripts will be installed into whatever the expected ``bin``
directory is for the environment.
The new scripts replace older experimental scripts that could be found in the
``nova/wsgi`` directory of the code repository. The new scripts are *not*
experimental.
When running the compute and metadata services with WSGI, sharing the compute
and metadata service in the same process is not supported (as it is in the
eventlet-based scripts).
In devstack as of May 2017, the compute and metadata APIs are hosted by a
Apache communicating with uwsgi_ via mod_proxy_uwsgi_. Inspecting the
configuration created there can provide some guidance on one option for
managing the WSGI scripts. It is important to remember, however, that one of
the major features of using WSGI is that there are many different ways to host
a WSGI application. Different servers make different choices about performance
and configurability.
.. _WSGI: https://www.python.org/dev/peps/pep-3333/
.. _apache: http://httpd.apache.org/
.. _nginx: http://nginx.org/en/
.. _uwsgi: https://uwsgi-docs.readthedocs.io/
.. _mod_proxy_uwsgi: http://uwsgi-docs.readthedocs.io/en/latest/Apache.html#mod-proxy-uwsgi

8
releasenotes/notes/wsgi-applications-8017c3192d2b143e.yaml Normal file
View File

@@ -0,0 +1,8 @@
---
upgrade:
- |
WSGI application scripts ``nova-api-wsgi`` and ``nova-metadata-wsgi`` are
now available. They allow running the compute and metadata APIs using a WSGI
server of choice (for example nginx and uwsgi, apache2 with mod_proxy_uwsgx
or gunicorn). The eventlet-based servers are still available, but the WSGI
options will allow greater deployment flexibility.