Merge "Add Octavia API WSGI support" into stable/rocky

This commit is contained in:
Zuul 2018-08-31 20:46:16 +00:00 committed by Gerrit Code Review
commit a1bfd66d1e
5 changed files with 238 additions and 19 deletions

View File

@ -10,6 +10,15 @@
# (optional) Whether the service should be managed by Puppet.
# Defaults to true.
#
# [*service_name*]
# (Optional) Name of the service that will be providing the
# server functionality of octavia-api.
# If the value is 'httpd', this means octavia-api will be a web
# service, and you must use another class to configure that
# web service. For example, use class { 'octavia::wsgi::apache'...}
# to make octavia-api be a web app using apache mod_wsgi.
# Defaults to $::octavia::params::api_service_name
#
# [*host*]
# (optional) The octavia api bind address.
# Defaults to '0.0.0.0'
@ -47,11 +56,12 @@
# Defaults to false
#
class octavia::api (
$manage_service = true,
$enabled = true,
$package_ensure = 'present',
$manage_service = true,
$service_name = $::octavia::params::api_service_name,
$host = '0.0.0.0',
$port = '9876',
$package_ensure = 'present',
$auth_strategy = 'keystone',
$api_handler = $::os_service_default,
$api_v1_enabled = $::os_service_default,
@ -81,13 +91,25 @@ class octavia::api (
$service_ensure = 'stopped'
}
service { 'octavia-api':
ensure => $service_ensure,
name => $::octavia::params::api_service_name,
enable => $enabled,
hasstatus => true,
hasrestart => true,
tag => ['octavia-service', 'octavia-db-sync-service'],
if $service_name == $::octavia::params::api_service_name {
service { 'octavia-api':
ensure => $service_ensure,
name => $::octavia::params::api_service_name,
enable => $enabled,
hasstatus => true,
hasrestart => true,
tag => ['octavia-service', 'octavia-db-sync-service'],
}
} elsif $service_name == 'httpd' {
include ::apache::params
service { 'octavia-api':
ensure => 'stopped',
name => $::octavia::params::api_service_name,
enable => false,
tag => ['octavia-service', 'octavia-db-sync-service'],
}
Service['octavia-api'] -> Service[$service_name]
Service<| title == 'httpd' |> { tag +> ['octavia-service', 'octavia-db-sync-service'] }
}
}

View File

@ -22,6 +22,8 @@ class octavia::params {
$health_manager_package_name = 'openstack-octavia-health-manager'
$housekeeping_package_name = 'openstack-octavia-housekeeping'
$client_package_name = "python${pyvers}-octaviaclient"
$octavia_wsgi_script_path = '/var/www/cgi-bin/octavia'
$octavia_wsgi_script_source = '/usr/bin/octavia-wsgi'
}
'Debian': {
$common_package_name = 'octavia-common'
@ -30,6 +32,8 @@ class octavia::params {
$health_manager_package_name = 'octavia-health-manager'
$housekeeping_package_name = 'octavia-housekeeping'
$client_package_name = "python${pyvers}-octaviaclient"
$octavia_wsgi_script_path = '/usr/lib/cgi-bin/octavia'
$octavia_wsgi_script_source = '/usr/bin/octavia-wsgi'
}
default: {
fail("Unsupported osfamily: ${::osfamily} operatingsystem")

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

@ -0,0 +1,155 @@
#
# Copyright (C) 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 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 {}
#
# == Example:
#
# include apache
# class { 'octavia::wsgi::apache': }
#
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 = {},
) {
include ::octavia::deps
include ::octavia::params
include ::apache
include ::apache::mod::wsgi
if $ssl {
include ::apache::mod::ssl
}
::openstacklib::wsgi::apache { 'octavia_wsgi':
bind_host => $bind_host,
bind_port => $port,
group => 'octavia',
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',
workers => $workers,
wsgi_daemon_process => 'octavia',
wsgi_process_display_name => $wsgi_process_display_name,
wsgi_process_group => 'octavia',
wsgi_script_dir => $::octavia::params::octavia_wsgi_script_path,
wsgi_script_file => 'app',
wsgi_script_source => $::octavia::params::octavia_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,
require => Anchor['octavia::install::end'],
}
}

View File

@ -0,0 +1,5 @@
---
features:
- |
Added new class octavia::wsgi::apache, you can now run the API under Apache
with mod_wsgi.

View File

@ -1,16 +1,6 @@
require 'spec_helper'
describe 'octavia::api' do
let :pre_condition do
"class { 'octavia': }
include ::octavia::db
class { '::octavia::keystone::authtoken':
password => 'password';
}
"
end
let :params do
{ :enabled => true,
:manage_service => true,
@ -25,6 +15,14 @@ describe 'octavia::api' do
end
shared_examples_for 'octavia-api' do
let :pre_condition do
"class { 'octavia': }
include ::octavia::db
class { '::octavia::keystone::authtoken':
password => 'password',
}
"
end
it { is_expected.to contain_class('octavia::deps') }
it { is_expected.to contain_class('octavia::params') }
@ -109,6 +107,39 @@ describe 'octavia::api' do
end
shared_examples 'octavia-api wsgi' do
let :pre_condition do
"class { 'octavia': }
include ::octavia::db
class { '::octavia::keystone::authtoken':
password => 'password',
}
include ::apache
"
end
let :params do
{
:service_name => 'httpd',
}
end
context 'with required params' do
it { should contain_package('octavia-api').with(
:ensure => 'present',
:name => platform_params[:api_package_name],
:tag => ['openstack', 'octavia-package'],
)}
it { should contain_service('octavia-api').with(
:ensure => 'stopped',
:name => platform_params[:api_service_name],
:enable => false,
:tag => ['octavia-service', 'octavia-db-sync-service'],
)}
end
end
on_supported_os({
:supported_os => OSDefaults.get_supported_os
}).each do |os,facts|
@ -126,7 +157,9 @@ describe 'octavia::api' do
:api_service_name => 'octavia-api' }
end
end
it_behaves_like 'octavia-api'
it_behaves_like 'octavia-api wsgi'
end
end