Puppet Class: placement::wsgi::apache

Defined in:
manifests/wsgi/apache.pp

Overview

Serving Placement API from apache is the recommended way to go for production because of limited performance for concurrent accesses.

Parameters

servername

(Optional) The servername for the virtualhost. Defaults to $::fqdn

port

(Optional) The port. Defaults to 8778

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

(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.

DEPRECATED PARAMETERS

api_port

(Optional) The port for Placement API service. Defaults to undef

Dependencies

requires Class['apache'] & Class['placement']

Examples

include apache

class { 'placement::wsgi::apache': }

Parameters:

  • servername (Any) (defaults to: $::fqdn)
  • port (Any) (defaults to: 8778)
  • bind_host (Any) (defaults to: undef)
  • path (Any) (defaults to: '/')
  • ssl (Any) (defaults to: false)
  • workers (Any) (defaults to: $::os_workers)
  • ssl_cert (Any) (defaults to: undef)
  • ssl_key (Any) (defaults to: undef)
  • ssl_chain (Any) (defaults to: undef)
  • ssl_ca (Any) (defaults to: undef)
  • ssl_crl_path (Any) (defaults to: undef)
  • ssl_crl (Any) (defaults to: undef)
  • ssl_certs_dir (Any) (defaults to: undef)
  • wsgi_process_display_name (Any) (defaults to: undef)
  • threads (Any) (defaults to: 1)
  • priority (Any) (defaults to: 10)
  • access_log_file (Any) (defaults to: undef)
  • access_log_pipe (Any) (defaults to: undef)
  • access_log_syslog (Any) (defaults to: undef)
  • access_log_format (Any) (defaults to: undef)
  • error_log_file (Any) (defaults to: undef)
  • error_log_pipe (Any) (defaults to: undef)
  • error_log_syslog (Any) (defaults to: undef)
  • custom_wsgi_process_options (Any) (defaults to: {})
  • headers (Any) (defaults to: undef)
  • request_headers (Any) (defaults to: undef)
  • vhost_custom_fragment (Any) (defaults to: undef)
  • api_port (Any) (defaults to: undef) 


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
207
208
209
210
211
212
213
214
215
 
# File 'manifests/wsgi/apache.pp', line 138

class placement::wsgi::apache (
  $servername                  = $::fqdn,
  $port                        = 8778,
  $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,
  # DEPRECATED PARAMETERS
  $api_port                    = undef,
) {

  include placement::deps
  include placement::params

  Anchor['placement::install::end'] -> Class['apache']

  if $api_port {
    warning('The api_port parameter is deprecated. Use the port parameter')
  }

  ::openstacklib::wsgi::apache { 'placement_wsgi':
    bind_host                   => $bind_host,
    bind_port                   => pick($api_port, $port),
    group                       => 'placement',
    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                        => 'placement',
    vhost_custom_fragment       => $vhost_custom_fragment,
    workers                     => $workers,
    wsgi_daemon_process         => 'placement-api',
    wsgi_process_display_name   => $wsgi_process_display_name,
    wsgi_process_group          => 'placement-api',
    wsgi_script_dir             => $::placement::params::wsgi_script_path,
    wsgi_script_file            => 'placement-api',
    wsgi_script_source          => $::placement::params::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,
  }
}