openstack/ironic
Code Issues Proposed changes

Merge "De-duplicate two WSGIService's"

Browse Source
This commit is contained in:
Zuul 2025-05-13 14:04:18 +00:00 committed by Gerrit Code Review
commit 7e13edd363
3 changed files with 45 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ironic/common/json_rpc/server.py
View File

@ -31,7 +31,7 @@ import webob
from ironic.common import auth_basic
from ironic.common import exception
from ironic.common.i18n import _
from ironic.common.json_rpc import wsgi
from ironic.common import wsgi_service
from ironic.conf import json_rpc
@ -93,7 +93,7 @@ class EmptyContext:
return self.__dict__.copy()
class WSGIService(wsgi.WSGIService):
class WSGIService(wsgi_service.BaseWSGIService):
"""Provides ability to launch JSON RPC as a WSGI application."""
def __init__(self, manager, serializer, context_class=EmptyContext):

77
ironic/common/json_rpc/wsgi.py
View File

@ -1,77 +0,0 @@
# 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.
import socket
from oslo_config import cfg
from oslo_service import service
from oslo_service import wsgi
from ironic.common import utils
CONF = cfg.CONF
class WSGIService(service.ServiceBase):
def __init__(self, name, app, conf):
"""Initialize, but do not start the WSGI server.
:param name: The name of the WSGI server given to the loader.
:param app: WSGI application to run.
:param conf: Object to load configuration from.
:returns: None
"""
self.name = name
self._conf = conf
if conf.unix_socket:
utils.unlink_without_raise(conf.unix_socket)
self.server = wsgi.Server(CONF, name, app,
socket_family=socket.AF_UNIX,
socket_file=conf.unix_socket,
socket_mode=conf.unix_socket_mode,
use_ssl=conf.use_ssl)
else:
self.server = wsgi.Server(CONF, name, app,
host=conf.host_ip,
port=conf.port,
use_ssl=conf.use_ssl)
def start(self):
"""Start serving this service using loaded configuration.
:returns: None
"""
self.server.start()
def stop(self):
"""Stop serving this API.
:returns: None
"""
self.server.stop()
if self._conf.unix_socket:
utils.unlink_without_raise(self._conf.unix_socket)
def wait(self):
"""Wait for the service to stop serving this API.
:returns: None
"""
self.server.wait()
def reset(self):
"""Reset server greenpool size to default.
:returns: None
"""
self.server.reset()

69
ironic/common/wsgi_service.py
View File

@ -26,40 +26,32 @@ from ironic.conf import CONF
_MAX_DEFAULT_WORKERS = 4
class WSGIService(service.ServiceBase):
"""Provides ability to launch ironic API from wsgi app."""
class BaseWSGIService(service.ServiceBase):
def __init__(self, name, use_ssl=False):
def __init__(self, name, app, conf, use_ssl=None):
"""Initialize, but do not start the WSGI server.
:param name: The name of the WSGI server given to the loader.
:param use_ssl: Wraps the socket in an SSL context if True.
:param app: WSGI application to run.
:param conf: Object to load configuration from.
:param use_ssl: Whether to use TLS on the socker.
:returns: None
"""
self.name = name
self.app = app.VersionSelectorApplication()
self.workers = (
CONF.api.api_workers
# NOTE(dtantsur): each worker takes a substantial amount of memory,
# so we don't want to end up with dozens of them.
or min(processutils.get_worker_count(), _MAX_DEFAULT_WORKERS)
)
if self.workers and self.workers < 1:
raise exception.ConfigInvalid(
_("api_workers value of %d is invalid, "
"must be greater than 0.") % self.workers)
if CONF.api.unix_socket:
utils.unlink_without_raise(CONF.api.unix_socket)
self.server = wsgi.Server(CONF, name, self.app,
self._conf = conf
if use_ssl is None:
use_ssl = conf.use_ssl
if conf.unix_socket:
utils.unlink_without_raise(conf.unix_socket)
self.server = wsgi.Server(CONF, name, app,
socket_family=socket.AF_UNIX,
socket_file=CONF.api.unix_socket,
socket_mode=CONF.api.unix_socket_mode,
socket_file=conf.unix_socket,
socket_mode=conf.unix_socket_mode,
use_ssl=use_ssl)
else:
self.server = wsgi.Server(CONF, name, self.app,
host=CONF.api.host_ip,
port=CONF.api.port,
self.server = wsgi.Server(CONF, name, app,
host=conf.host_ip,
port=conf.port,
use_ssl=use_ssl)
def start(self):
@ -75,8 +67,8 @@ class WSGIService(service.ServiceBase):
:returns: None
"""
self.server.stop()
if CONF.api.unix_socket:
utils.unlink_without_raise(CONF.api.unix_socket)
if self._conf.unix_socket:
utils.unlink_without_raise(self._conf.unix_socket)
def wait(self):
"""Wait for the service to stop serving this API.
@ -91,3 +83,28 @@ class WSGIService(service.ServiceBase):
:returns: None
"""
self.server.reset()
class WSGIService(BaseWSGIService):
"""Provides ability to launch ironic API from wsgi app."""
def __init__(self, name, use_ssl=False):
"""Initialize, but do not start the WSGI server.
:param name: The name of the WSGI server given to the loader.
:param use_ssl: Wraps the socket in an SSL context if True.
:returns: None
"""
self.app = app.VersionSelectorApplication()
self.workers = (
CONF.api.api_workers
# NOTE(dtantsur): each worker takes a substantial amount of memory,
# so we don't want to end up with dozens of them.
or min(processutils.get_worker_count(), _MAX_DEFAULT_WORKERS)
)
if self.workers and self.workers < 1:
raise exception.ConfigInvalid(
_("api_workers value of %d is invalid, "
"must be greater than 0.") % self.workers)
super().__init__(name, self.app, CONF.api, use_ssl=use_ssl)