Puppet Class: nova::wsgi::apache_api
- Defined in:
- manifests/wsgi/apache_api.pp
Overview
Copyright © 2015 eNovance SAS <licensing@enovance.com>
Author: Emilien Macchi <emilien.macchi@enovance.com>
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 Nova API with apache mod_wsgi in place of nova-api and service.
Serving Nova 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 nova-api service.
Parameters
- servername
-
(Optional) The servername for the virtualhost. Defaults to $::fqdn
- api_port
-
(Optional) The port for Nova API service. Defaults to 8774
- bind_host
-
(Optional) The host/ip address Apache will listen on. Defaults to undef (listen on all ip addresses).
- path
-
(Optional) The prefix for the endpoint. Defaults to ‘/’
- ssl
-
(Optional) Use ssl ? (boolean) Defaults to false
- workers
-
(Optional) Number of WSGI workers to spawn. 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 1
- 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
- ssl_key
-
(Optional) apache::vhost ssl parameters. Default to apache::vhost ‘ssl_*’ defaults.
- access_log_file
-
(Optional) The log file name for the virtualhost. Defaults to undef.
- access_log_pipe
-
(Optional) Specifies a pipe where Apache sends access logs for the virtualhost. Defaults to undef.
- access_log_syslog
-
(Optional) Sends the virtualhost access log messages to syslog. Defaults to undef.
- access_log_format
-
(Optional) The log format for the virtualhost. Defaults to undef.
- error_log_file
-
(Optional) The error log file name for the virtualhost. Defaults to undef.
- error_log_pipe
-
(Optional) Specifies a pipe where Apache sends error logs for the virtualhost. Defaults to undef.
- error_log_syslog
-
(Optional) Sends the virtualhost error log messages to syslog. Defaults to undef.
- custom_wsgi_process_options
-
(Optional) gives you the opportunity 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 {}
- headers
-
(Optional) Headers for the vhost. Defaults to undef
- request_headers
-
(Optional) Modifies collected request headers in various ways. Defaults to undef
- vhost_custom_fragment
-
(Optional) Passes a string of custom configuration directives to be placed at the end of the vhost configuration. Defaults to undef.
Dependencies
requires Class['apache'] & Class['nova'] & Class['nova::api']
Examples
include apache
class { 'nova::wsgi::apache': }
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'manifests/wsgi/apache_api.pp', line 134
class nova::wsgi::apache_api (
$servername = $::fqdn,
$api_port = 8774,
$bind_host = undef,
$path = '/',
$ssl = false,
$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 = 1,
$priority = 10,
$access_log_file = undef,
$access_log_pipe = undef,
$access_log_syslog = undef,
$access_log_format = undef,
$error_log_file = undef,
$error_log_pipe = undef,
$error_log_syslog = undef,
$custom_wsgi_process_options = {},
$headers = undef,
$request_headers = undef,
$vhost_custom_fragment = undef,
) {
include nova::params
if ! defined(Class[nova::api]) {
fail('::nova::api class must be declared in composition layer.')
}
::openstacklib::wsgi::apache { 'nova_api_wsgi':
bind_host => $bind_host,
bind_port => $api_port,
group => $::nova::params::group,
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 => $::nova::params::user,
vhost_custom_fragment => $vhost_custom_fragment,
workers => $workers,
wsgi_daemon_process => 'nova-api',
wsgi_process_display_name => $wsgi_process_display_name,
wsgi_process_group => 'nova-api',
wsgi_script_dir => $::nova::params::nova_wsgi_script_path,
wsgi_script_file => 'nova-api',
wsgi_script_source => $::nova::params::nova_api_wsgi_script_source,
headers => $headers,
request_headers => $request_headers,
custom_wsgi_process_options => $custom_wsgi_process_options,
access_log_file => $access_log_file,
access_log_pipe => $access_log_pipe,
access_log_syslog => $access_log_syslog,
access_log_format => $access_log_format,
error_log_file => $error_log_file,
error_log_pipe => $error_log_pipe,
error_log_syslog => $error_log_syslog,
}
}
|