Files
puppet-ironic/manifests/wsgi/apache.pp
Julia Kreger 037cd2cb5d Correct default number of threads
The default number of threads does not match the default
tested upstream[1], which can return errors for users when
requests begin backing up in the webserver due to a lack
of resources and the nature of the ironic API having some
synchronous requests.

Upstream ironic, as of the Rocky cycle, executed with uwsgi
which is configured for the same process count algorithm,
but enable threds. There does not appear to be an upper bound
to that setting, but accoriding to mod_wsgi documentation[3],
the default is 15 threads. The example shipped with ironic[4]
defaults to 10, which also seems to be a valid configuration.

[1]: https://git.openstack.org/cgit/openstack/ironic/tree/devstack/lib/ironic?h=stable/rocky#n1129
[2]: http://git.openstack.org/cgit/openstack-dev/devstack/tree/lib/apache#n267
[3]: https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIDaemonProcess.html
[4]: https://git.openstack.org/cgit/openstack/ironic/tree/etc/apache2/ironic?h=stable/rocky#n21

Story: #2003464
Task: #24724
rhbz: #1613995

Change-Id: I327219f96cfc0a69643ab6369cb8e831251f799c
2018-08-16 15:08:04 -07:00

161 lines
5.1 KiB
Puppet

# Copyright 2015 Red Hat, Inc.
# All Rights Reserved.
#
# 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.
#
# Class to serve ironic API with apache mod_wsgi in place of ironic-api service.
# Serving ironic API from apache is the recommended way to go for production
# because of limited performance for concurrent accesses when running eventlet.
# When using this class you should disable your ironic-api service.
#
# == Parameters
#
# [*servername*]
# The servername for the virtualhost.
# Optional. Defaults to $::fqdn
#
# [*port*]
# The port.
# Optional. Defaults to 6385
#
# [*bind_host*]
# The host/ip address Apache will listen on.
# Optional. Defaults to undef (listen on all ip addresses).
#
# [*path*]
# The prefix for the endpoint.
# Optional. Defaults to '/'
#
# [*ssl*]
# Use ssl ? (boolean)
# Optional. Defaults to true
#
# [*workers*]
# Number of WSGI workers to spawn.
# Optional. Defaults to $::os_workers
#
# [*priority*]
# (optional) The priority for the vhost.
# Defaults to '10'
#
# [*threads*]
# (optional) The number of threads for the vhost.
# Defaults to 15
#
# [*wsgi_process_display_name*]
# (optional) Name of the WSGI process display-name.
# Defaults to undef
#
# [*ssl_cert*]
# [*ssl_key*]
# [*ssl_chain*]
# [*ssl_ca*]
# [*ssl_crl_path*]
# [*ssl_crl*]
# [*ssl_certs_dir*]
# apache::vhost ssl parameters.
# Optional. Default to apache::vhost 'ssl_*' defaults.
#
# [*access_log_file*]
# The log file name for the virtualhost.
# Optional. Defaults to false.
#
# [*access_log_format*]
# The log format for the virtualhost.
# Optional. Defaults to false.
#
# [*error_log_file*]
# The error log file name for the virtualhost.
# Optional. Defaults to undef.
#
# [*custom_wsgi_process_options*]
# (optional) gives you the oportunity to add custom process options or to
# overwrite the default options for the WSGI main process.
# eg. to use a virtual python environment for the WSGI process
# you could set it to:
# { python-path => '/my/python/virtualenv' }
# Defaults to {}
#
# == Dependencies
#
# requires Class['apache'] & Class['ironic']
#
# == Examples
#
# include apache
#
# class { 'ironic::wsgi::apache': }
#
class ironic::wsgi::apache (
$servername = $::fqdn,
$port = 6385,
$bind_host = undef,
$path = '/',
$ssl = true,
$workers = $::os_workers,
$ssl_cert = undef,
$ssl_key = undef,
$ssl_chain = undef,
$ssl_ca = undef,
$ssl_crl_path = undef,
$ssl_crl = undef,
$ssl_certs_dir = undef,
$wsgi_process_display_name = undef,
$threads = 15,
$priority = '10',
$access_log_file = false,
$access_log_format = false,
$error_log_file = undef,
$custom_wsgi_process_options = {},
) {
include ::ironic::deps
include ::ironic::params
include ::apache
include ::apache::mod::wsgi
if $ssl {
include ::apache::mod::ssl
}
::openstacklib::wsgi::apache { 'ironic_wsgi':
bind_host => $bind_host,
bind_port => $port,
group => 'ironic',
path => $path,
priority => $priority,
servername => $servername,
ssl => $ssl,
ssl_ca => $ssl_ca,
ssl_cert => $ssl_cert,
ssl_certs_dir => $ssl_certs_dir,
ssl_chain => $ssl_chain,
ssl_crl => $ssl_crl,
ssl_crl_path => $ssl_crl_path,
ssl_key => $ssl_key,
threads => $threads,
user => 'ironic',
workers => $workers,
wsgi_daemon_process => 'ironic',
wsgi_process_display_name => $wsgi_process_display_name,
wsgi_process_group => 'ironic',
wsgi_script_dir => $::ironic::params::ironic_wsgi_script_path,
wsgi_script_file => 'app',
wsgi_script_source => $::ironic::params::ironic_wsgi_script_source,
access_log_file => $access_log_file,
access_log_format => $access_log_format,
error_log_file => $error_log_file,
custom_wsgi_process_options => $custom_wsgi_process_options,
}
}