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*]
  The port for the specific API.

[*servername*]
  The servername for the virtualhost.
  Optional. Defaults to $::fqdn

[*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 1

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

[*wsgi_process_display_name*]
  (optional) Name of the WSGI process display-name.
  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: $::fqdn)
  • bind_host (Any) (defaults to: undef)
  • path (Any) (defaults to: '/')
  • ssl (Any) (defaults to: true)
  • 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)
  • threads (Any) (defaults to: 1)
  • priority (Any) (defaults to: '10')
  • access_log_file (Any) (defaults to: false)
  • access_log_format (Any) (defaults to: false)
  • error_log_file (Any) (defaults to: undef)
  • custom_wsgi_process_options (Any) (defaults to: {})
  • wsgi_process_display_name (Any) (defaults to: undef)
  • vhost_custom_fragment (Any) (defaults to: undef) 


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'manifests/wsgi/apache_api.pp', line 102

class heat::wsgi::apache_api (
  $port                        = 8004,
  $servername                  = $::fqdn,
  $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,
  $threads                     = 1,
  $priority                    = '10',
  $access_log_file             = false,
  $access_log_format           = false,
  $error_log_file              = undef,
  $custom_wsgi_process_options = {},
  $wsgi_process_display_name   = 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,
    custom_wsgi_process_options => $custom_wsgi_process_options,
    priority                    => $priority,
    access_log_file             => $access_log_file,
    access_log_format           => $access_log_format,
    error_log_file              => $error_log_file,
    wsgi_process_display_name   => $wsgi_process_display_name,
    vhost_custom_fragment       => $vhost_custom_fragment,
  }
}