From abc5a8838a13401eef929c26d7ba008530dc1fae Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Fri, 18 Oct 2024 13:41:44 +0100 Subject: [PATCH] Add new glance.wsgi module This allows deployment tooling to easily switch from passing a binary path to passing a Python module path. We'll use it shortly. Change-Id: Ia67d3b1b2e80b8b2096cb86ba85f47047e89a3d2 Signed-off-by: Stephen Finucane --- doc/source/conf.py | 2 ++ glance/wsgi/api.py | 22 +++++++++++++++++++ ...d-glance-wsgi-module-bbebcb5c23f41917.yaml | 22 +++++++++++++++++++ 3 files changed, 46 insertions(+) create mode 100644 glance/wsgi/api.py create mode 100644 releasenotes/notes/add-glance-wsgi-module-bbebcb5c23f41917.yaml diff --git a/doc/source/conf.py b/doc/source/conf.py index 58b4b813de..2cb5b7708c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -52,6 +52,8 @@ apidoc_excluded_paths = [ 'hacking', 'tests/*', 'tests', + 'glance/wsgi/*', + 'glance/wsgi', 'db/sqlalchemy/*', 'db/sqlalchemy'] apidoc_separate_modules = True diff --git a/glance/wsgi/api.py b/glance/wsgi/api.py new file mode 100644 index 0000000000..4899eb6f2d --- /dev/null +++ b/glance/wsgi/api.py @@ -0,0 +1,22 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +"""WSGI application entry-point for Glance API.""" + +import threading + +from glance.common import wsgi_app + +application = None +with threading.Lock(): + if application is None: + application = wsgi_app.init_app() diff --git a/releasenotes/notes/add-glance-wsgi-module-bbebcb5c23f41917.yaml b/releasenotes/notes/add-glance-wsgi-module-bbebcb5c23f41917.yaml new file mode 100644 index 0000000000..21191fd024 --- /dev/null +++ b/releasenotes/notes/add-glance-wsgi-module-bbebcb5c23f41917.yaml @@ -0,0 +1,22 @@ +--- +features: + - | + A new file, ``glance/wsgi/api.py``, has been added as a place to hold a + WSGI ``application`` object. This is intended to ease deployment by + providing a consistent location for these objects. For example, if using + uWSGI then instead of: + + .. code-block:: ini + + [uwsgi] + wsgi-file = /bin/glance-wsgi-api + + You can now use: + + .. code-block:: ini + + [uwsgi] + module = glance.wsgi.api:application + + This also simplifies deployment with other WSGI servers that expect module + paths such as gunicorn.