Puppet Class: heat::wsgi::apache_api

Defined in:
manifests/wsgi/apache_api.pp

Overview

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.

Resource to serve Heat API with apache mod_wsgi in place of heat-api service.

Serving Heat 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 heat-api service.

Parameters

port

(Optional) The port for the specific API. Defaults to 8004

servername

(Optional) The servername for the virtualhost. Defaults to $facts[‘fqdn’]

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 $facts

priority

(Optional) The priority for the vhost. Defaults to 10

threads

(Optional) The number of threads for the vhost. Defaults to 1

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 {}

wsgi_process_display_name

(Optional) Name of the WSGI process display-name. Defaults to undef

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) Additional vhost configuration, if applicable. Defaults to undef

Dependencies

requires Class['apache'] & Class['heat']

Examples

include apache

class { 'heat::wsgi::apache': }

Parameters:

  • port (Any) (defaults to: 8004)
  • servername (Any) (defaults to: $facts['networking']['fqdn'])
  • bind_host (Any) (defaults to: undef)
  • path (Any) (defaults to: '/')
  • ssl (Any) (defaults to: false)
  • workers (Any) (defaults to: $facts['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)
  • 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: {})
  • wsgi_process_display_name (Any) (defaults to: undef)
  • headers (Any) (defaults to: undef)
  • request_headers (Any) (defaults to: undef)
  • vhost_custom_fragment (Any) (defaults to: undef) 


129
130
131
132
133
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
 
# File 'manifests/wsgi/apache_api.pp', line 129

class heat::wsgi::apache_api (
  $port                        = 8004,
  $servername                  = $facts['networking']['fqdn'],
  $bind_host                   = undef,
  $path                        = '/',
  $ssl                         = false,
  $workers                     = $facts['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,
  $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 = {},
  $wsgi_process_display_name   = undef,
  $headers                     = undef,
  $request_headers             = undef,
  $vhost_custom_fragment       = undef,
) {

  heat::wsgi::apache { 'api':
    port                        => $port,
    servername                  => $servername,
    bind_host                   => $bind_host,
    path                        => $path,
    ssl                         => $ssl,
    workers                     => $workers,
    ssl_cert                    => $ssl_cert,
    ssl_key                     => $ssl_key,
    ssl_chain                   => $ssl_chain,
    ssl_ca                      => $ssl_ca,
    ssl_crl_path                => $ssl_crl_path,
    ssl_crl                     => $ssl_crl,
    ssl_certs_dir               => $ssl_certs_dir,
    threads                     => $threads,
    priority                    => $priority,
    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,
    custom_wsgi_process_options => $custom_wsgi_process_options,
    wsgi_process_display_name   => $wsgi_process_display_name,
    headers                     => $headers,
    request_headers             => $request_headers,
    vhost_custom_fragment       => $vhost_custom_fragment,
  }
}