openstack/puppet-mistral
Code Issues Proposed changes

Implement WSGI support for mistral-api

Browse Source 
* Allow to deploy mistral-api in WSGI with apache.
* Switch beaker tests to deploy WSGI by default.
* Check if 8041 port is listening on apache

Change-Id: I031198958fdd4147121fbd64b6510bdd564e03c3
This commit is contained in:
Emilien Macchi 2016-02-05 11:14:11 +01:00
parent 695770554b
commit d765057673
7 changed files with 367 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
manifests/api.pp
View File

@ -29,6 +29,15 @@
# relationship with workflows. (boolean value).
# Defaults to $::os_service_default.
#
# [*service_name*]
# (optional) Name of the service that will be providing the
# server functionality of mistral-api.
# If the value is 'httpd', this means mistral-api will be a web
# service, and you must use another class to configure that
# web service. For example, use class { 'mistral::wsgi::apache'...}
# to make mistral-api be a web app using apache mod_wsgi.
# Defaults to '$::mistral::params::api_service_name'
#
class mistral::api (
$package_ensure = present,
$manage_service = true,
@ -36,13 +45,17 @@ class mistral::api (
$bind_host = $::os_service_default,
$bind_port = $::os_service_default,
$allow_action_execution_deletion = $::os_service_default,
) {
$service_name = $::mistral::params::api_service_name,
) inherits mistral::params {
include ::mistral::params
include ::mistral::policy
Mistral_config<||> ~> Service[$service_name]
Class['mistral::policy'] ~> Service[$service_name]
Package['mistral-api'] -> Class['mistral::policy']
Class['mistral::policy'] ~> Service['mistral-api']
Package['mistral-api'] -> Service[$service_name]
Package['mistral-api'] -> Service['mistral-api']
package { 'mistral-api':
ensure => $package_ensure,
@ -58,6 +71,7 @@ class mistral::api (
}
}
if $service_name == $::mistral::params::api_service_name {
service { 'mistral-api':
ensure => $service_ensure,
name => $::mistral::params::api_service_name,
@ -66,6 +80,22 @@ class mistral::api (
hasrestart => true,
tag => 'mistral-service',
}
} elsif $service_name == 'httpd' {
include ::apache::params
service { 'mistral-api':
ensure => 'stopped',
name => $::mistral::params::api_service_name,
enable => false,
tag => 'mistral-service',
}
Class['mistral::db'] -> Service[$service_name]
Service <<| title == 'httpd' |>> { tag +> 'mistral-service' }
# we need to make sure mistral-api s stopped before trying to start apache
Service['mistral-api'] -> Service[$service_name]
} else {
fail('Invalid service_name. Either mistral/openstack-mistral-api for running as a standalone service, or httpd for being run by a httpd server')
}
mistral_config {
'api/host' : value => $bind_host;

4
manifests/params.pp
View File

@ -17,6 +17,8 @@ class mistral::params {
$engine_service_name = 'openstack-mistral-engine'
$executor_package_name = 'openstack-mistral-executor'
$executor_service_name = 'openstack-mistral-executor'
$mistral_wsgi_script_path = '/var/www/cgi-bin/mistral'
$mistral_wsgi_script_source = '/usr/lib/python2.7/site-packages/mistral/api/wsgi.py'
$pymysql_package_name = undef
}
'Debian': {
@ -27,6 +29,8 @@ class mistral::params {
$engine_service_name = 'mistral-engine'
$executor_package_name = 'mistral-executor'
$executor_service_name = 'mistral-executor'
$mistral_wsgi_script_path = '/usr/lib/cgi-bin/mistral'
$mistral_wsgi_script_source = '/usr/share/mistral-common/wsgi.py'
$pymysql_package_name = 'python-pymysql'
}
default: {

128
manifests/wsgi/apache.pp Normal file
View File

@ -0,0 +1,128 @@
#
# Copyright (C) 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 mistral API with apache mod_wsgi in place of mistral-api service.
#
# Serving mistral 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 mistral-api service.
#
# == Parameters
#
# [*servername*]
# The servername for the virtualhost.
# Optional. Defaults to $::fqdn
#
# [*port*]
# The port.
# Optional. Defaults to 8989
#
# [*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 1
#
# [*priority*]
# (optional) The priority for the vhost.
# Defaults to '10'
#
# [*threads*]
# (optional) The number of threads for the vhost.
# Defaults to $::processorcount
#
# [*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.
#
# == Dependencies
#
# requires Class['apache'] & Class['mistral']
#
# == Examples
#
# include apache
#
# class { 'mistral::wsgi::apache': }
#
class mistral::wsgi::apache (
$servername = $::fqdn,
$port = 8989,
$bind_host = undef,
$path = '/',
$ssl = true,
$workers = 1,
$ssl_cert = undef,
$ssl_key = undef,
$ssl_chain = undef,
$ssl_ca = undef,
$ssl_crl_path = undef,
$ssl_crl = undef,
$ssl_certs_dir = undef,
$threads = $::processorcount,
$priority = '10',
) {
include ::mistral::params
include ::apache
include ::apache::mod::wsgi
if $ssl {
include ::apache::mod::ssl
}
::openstacklib::wsgi::apache { 'mistral_wsgi':
bind_host => $bind_host,
bind_port => $port,
group => 'mistral',
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 => 'mistral',
workers => $workers,
wsgi_daemon_process => 'mistral',
wsgi_process_group => 'mistral',
wsgi_script_dir => $::mistral::params::mistral_wsgi_script_path,
wsgi_script_file => 'app',
wsgi_script_source => $::mistral::params::mistral_wsgi_script_source,
}
}

1
metadata.json
View File

@ -27,6 +27,7 @@
}
],
"dependencies": [
{ "name": "puppetlabs/apache", "version_requirement": ">=1.0.0 <2.0.0" },
{ "name": "puppetlabs/inifile", "version_requirement": ">=1.0.0 <2.0.0" },
{ "name": "puppetlabs/stdlib", "version_requirement": ">= 4.0.0 <5.0.0" },
{ "name": "openstack/openstacklib", "version_requirement": ">=7.0.0 <8.0.0" }

10
spec/acceptance/basic_mistral_spec.rb
View File

@ -48,7 +48,13 @@ describe 'basic mistral' do
class { '::mistral::db::mysql':
password => 'a_big_secret',
}
class { '::mistral::api': }
class { '::mistral::api':
service_name => 'httpd',
}
include ::apache
class { '::mistral::wsgi::apache':
ssl => false,
}
class { '::mistral::client': }
class { '::mistral::engine': }
class { '::mistral::executor': }
@ -65,7 +71,7 @@ describe 'basic mistral' do
if os[:family].casecmp('RedHat') == 0
describe port(8989) do
it { is_expected.to be_listening.with('tcp') }
it { is_expected.to be_listening }
end
end

49
spec/classes/mistral_api_spec.rb
View File

@ -65,11 +65,49 @@ describe 'mistral::api' do
end
end
context 'when running mistral-api in wsgi' do
before do
params.merge!({ :service_name => 'httpd' })
end
let :pre_condition do
"include ::apache
include ::mistral::db
class { '::mistral':
keystone_password => 'foo',
rabbit_password => 'bar',
}"
end
it 'configures mistral-api service with Apache' do
is_expected.to contain_service('mistral-api').with(
:ensure => 'stopped',
:name => platform_params[:api_service_name],
:enable => false,
:tag => ['mistral-service'],
)
end
end
context 'when service_name is not valid' do
before do
params.merge!({ :service_name => 'foobar' })
end
it_raises 'a Puppet::Error', /Invalid service_name/
end
end
context 'on Debian platforms' do
let :facts do
{ :osfamily => 'Debian' }
@default_facts.merge({
:osfamily => 'Debian',
:operatingsystem => 'Debian',
:operatingsystemrelease => '8.0',
:concat_basedir => '/var/lib/puppet/concat',
:fqdn => 'some.host.tld',
:processorcount => 2,
})
end
let :platform_params do
@ -81,7 +119,14 @@ describe 'mistral::api' do
context 'on RedHat platforms' do
let :facts do
{ :osfamily => 'RedHat' }
@default_facts.merge({
:osfamily => 'RedHat',
:operatingsystem => 'RedHat',
:operatingsystemrelease => '7.1',
:fqdn => 'some.host.tld',
:concat_basedir => '/var/lib/puppet/concat',
:processorcount => 2,
})
end
let :platform_params do

124
spec/classes/mistral_wsgi_apache_spec.rb Normal file
View File

@ -0,0 +1,124 @@
require 'spec_helper'
describe 'mistral::wsgi::apache' do
let :global_facts do
@default_facts.merge({
:processorcount => 42,
:concat_basedir => '/var/lib/puppet/concat',
:fqdn => 'some.host.tld',
})
end
shared_examples_for 'apache serving mistral with mod_wsgi' do
it { is_expected.to contain_service('httpd').with_name(platform_parameters[:httpd_service_name]) }
it { is_expected.to contain_class('mistral::params') }
it { is_expected.to contain_class('apache') }
it { is_expected.to contain_class('apache::mod::wsgi') }
describe 'with default parameters' do
it { is_expected.to contain_file("#{platform_parameters[:wsgi_script_path]}").with(
'ensure' => 'directory',
'owner' => 'mistral',
'group' => 'mistral',
'require' => 'Package[httpd]'
)}
it { is_expected.to contain_file('mistral_wsgi').with(
'ensure' => 'file',
'path' => "#{platform_parameters[:wsgi_script_path]}/app",
'source' => platform_parameters[:wsgi_script_source],
'owner' => 'mistral',
'group' => 'mistral',
'mode' => '0644'
)}
it { is_expected.to contain_file('mistral_wsgi').that_requires("File[#{platform_parameters[:wsgi_script_path]}]") }
it { is_expected.to contain_apache__vhost('mistral_wsgi').with(
'servername' => 'some.host.tld',
'ip' => nil,
'port' => '8989',
'docroot' => "#{platform_parameters[:wsgi_script_path]}",
'docroot_owner' => 'mistral',
'docroot_group' => 'mistral',
'ssl' => 'true',
'wsgi_daemon_process' => 'mistral',
'wsgi_process_group' => 'mistral',
'wsgi_script_aliases' => { '/' => "#{platform_parameters[:wsgi_script_path]}/app" },
'require' => 'File[mistral_wsgi]'
)}
it { is_expected.to contain_file("#{platform_parameters[:httpd_ports_file]}") }
end
describe 'when overriding parameters using different ports' do
let :params do
{
:servername => 'dummy.host',
:bind_host => '10.42.51.1',
:port => 12345,
:ssl => false,
:workers => 37,
}
end
it { is_expected.to contain_apache__vhost('mistral_wsgi').with(
'servername' => 'dummy.host',
'ip' => '10.42.51.1',
'port' => '12345',
'docroot' => "#{platform_parameters[:wsgi_script_path]}",
'docroot_owner' => 'mistral',
'docroot_group' => 'mistral',
'ssl' => 'false',
'wsgi_daemon_process' => 'mistral',
'wsgi_process_group' => 'mistral',
'wsgi_script_aliases' => { '/' => "#{platform_parameters[:wsgi_script_path]}/app" },
'require' => 'File[mistral_wsgi]'
)}
it { is_expected.to contain_file("#{platform_parameters[:httpd_ports_file]}") }
end
end
context 'on RedHat platforms' do
let :facts do
global_facts.merge({
:osfamily => 'RedHat',
:operatingsystemrelease => '7.0'
})
end
let :platform_parameters do
{
:httpd_service_name => 'httpd',
:httpd_ports_file => '/etc/httpd/conf/ports.conf',
:wsgi_script_path => '/var/www/cgi-bin/mistral',
:wsgi_script_source => '/usr/lib/python2.7/site-packages/mistral/api/wsgi.py'
}
end
it_configures 'apache serving mistral with mod_wsgi'
end
context 'on Debian platforms' do
let :facts do
global_facts.merge({
:osfamily => 'Debian',
:operatingsystem => 'Debian',
:operatingsystemrelease => '7.0'
})
end
let :platform_parameters do
{
:httpd_service_name => 'apache2',
:httpd_ports_file => '/etc/apache2/ports.conf',
:wsgi_script_path => '/usr/lib/cgi-bin/mistral',
:wsgi_script_source => '/usr/share/mistral-common/wsgi.py'
}
end
it_configures 'apache serving mistral with mod_wsgi'
end
end