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 and EC2 with apache mod_wsgi in place of nova-api and nova-api-ec2 services.

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

When using this class you should disable your nova-api and nova-api-ec2 service.

Parameters

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

[*api_port*]
  The port for Nova API service.
  Optional. Defaults to 8774

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

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

[*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': }

Parameters:

  • servername (Any) (defaults to: $::fqdn)
  • api_port (Any) (defaults to: 8774)
  • bind_host (Any) (defaults to: undef)
  • path (Any) (defaults to: '/')
  • ssl (Any) (defaults to: undef)
  • 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: false)
  • access_log_format (Any) (defaults to: false)
  • error_log_file (Any) (defaults to: undef)
  • custom_wsgi_process_options (Any) (defaults to: {})
  • vhost_custom_fragment (Any) (defaults to: undef) 


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
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
 
# File 'manifests/wsgi/apache_api.pp', line 108

class nova::wsgi::apache_api (
  $servername                  = $::fqdn,
  $api_port                    = 8774,
  $bind_host                   = undef,
  $path                        = '/',
  $ssl                         = undef,
  $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             = false,
  $access_log_format           = false,
  $error_log_file              = undef,
  $custom_wsgi_process_options = {},
  $vhost_custom_fragment       = undef,
) {

  if $ssl == undef {
    warning('Default of the ssl parameter will be changed in a future release')
  }
  $ssl_real = pick($ssl, true)

  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',
    path                        => $path,
    priority                    => $priority,
    servername                  => $servername,
    ssl                         => $ssl_real,
    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',
    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,
    custom_wsgi_process_options => $custom_wsgi_process_options,
    access_log_file             => $access_log_file,
    access_log_format           => $access_log_format,
    error_log_file              => $error_log_file,
  }

}