Puppet Class: neutron::wsgi::apache

Defined in:
manifests/wsgi/apache.pp

Overview

Copyright © 2017 Red Hat Inc.

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 neutron API with apache mod_wsgi in place of neutron-api service.

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

Parameters

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

[*port*]
  The port.
  Optional. Defaults to 9696

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

Dependencies

requires Class['apache'] & Class['neutron']

Examples

include apache

class { 'neutron::wsgi::apache': }

Parameters:

  • servername (Any) (defaults to: $::fqdn)
  • port (Any) (defaults to: 9696)
  • 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: {}) 


101
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'manifests/wsgi/apache.pp', line 101

class neutron::wsgi::apache (
  $servername                  = $::fqdn,
  $port                        = 9696,
  $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 = {},
) {

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

  include neutron::deps
  include neutron::params

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

  ::openstacklib::wsgi::apache { 'neutron_wsgi':
    bind_host                   => $bind_host,
    bind_port                   => $port,
    group                       => $::neutron::params::group,
    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                        => $::neutron::params::user,
    workers                     => $workers,
    wsgi_daemon_process         => 'neutron',
    wsgi_process_display_name   => $wsgi_process_display_name,
    wsgi_process_group          => 'neutron',
    wsgi_script_dir             => $::neutron::params::neutron_wsgi_script_path,
    wsgi_script_file            => 'app',
    wsgi_script_source          => $::neutron::params::neutron_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,
  }
}