Puppet Class: octavia::wsgi::apache

Inherits:
octavia::params
Defined in:
manifests/wsgi/apache.pp

Overview

Copyright © 2018 Binero

Author: Tobias Urdin <tobias.urdin@binero.se>

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: octavia::wsgi::apache

Install Octavia API under apache with mod_wsgi.

Parameters:

servername

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

port

(Optional) The port. Defaults to 9876

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

access_log_format

(Optional) The log format for the virtualhost. Defaults to false

error_log_file

(Optional) The error log file name for the virtualhost. 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_script_dir

(Optional) The directory to install the WSGI script for apache to read. Defaults to $::octavia::params::octavia_wsgi_script_dir

wsgi_script_source

(Optional) The location of the octavia WSGI script. Defaults to $::octavia::params::octavia_wsgi_script_source

vhost_custom_fragment

(Optional) Passes a string of custom configuration. directives to be placed at the end of the vhost configuration. Defaults to undef.

Example:

include apache
class { 'octavia::wsgi::apache': }

Parameters:

  • servername (Any) (defaults to: $::fqdn)
  • port (Any) (defaults to: 9876)
  • 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: false)
  • access_log_format (Any) (defaults to: false)
  • error_log_file (Any) (defaults to: undef)
  • custom_wsgi_process_options (Any) (defaults to: {})
  • wsgi_script_dir (Any) (defaults to: $::octavia::params::octavia_wsgi_script_path)
  • wsgi_script_source (Any) (defaults to: $::octavia::params::octavia_wsgi_script_source)
  • 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
 
# File 'manifests/wsgi/apache.pp', line 108

class octavia::wsgi::apache (
  $servername                  = $::fqdn,
  $port                        = 9876,
  $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             = false,
  $access_log_format           = false,
  $error_log_file              = undef,
  $custom_wsgi_process_options = {},
  $wsgi_script_dir             = $::octavia::params::octavia_wsgi_script_path,
  $wsgi_script_source          = $::octavia::params::octavia_wsgi_script_source,
  $vhost_custom_fragment       = undef,
) inherits octavia::params {

  include octavia::deps

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

  ::openstacklib::wsgi::apache { 'octavia_wsgi':
    bind_host                   => $bind_host,
    bind_port                   => $port,
    group                       => $::octavia::params::group,
    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                        => $::octavia::params::user,
    vhost_custom_fragment       => $vhost_custom_fragment,
    workers                     => $workers,
    wsgi_daemon_process         => 'octavia',
    wsgi_process_display_name   => $wsgi_process_display_name,
    wsgi_process_group          => 'octavia',
    wsgi_script_dir             => $wsgi_script_dir,
    wsgi_script_file            => 'app',
    wsgi_script_source          => $wsgi_script_source,
    access_log_file             => $access_log_file,
    access_log_format           => $access_log_format,
    error_log_file              => $error_log_file,
    custom_wsgi_process_options => $custom_wsgi_process_options,
  }
}