diff --git a/lib/puppet/provider/keystone_uwsgi_config/ini_setting.rb b/lib/puppet/provider/keystone_uwsgi_config/ini_setting.rb new file mode 100644 index 000000000..1884d4ca1 --- /dev/null +++ b/lib/puppet/provider/keystone_uwsgi_config/ini_setting.rb @@ -0,0 +1,8 @@ +Puppet::Type.type(:keystone_uwsgi_config).provide( + :ini_setting, + :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting) +) do + def self.file_path + '/etc/keystone/keystone-uwsgi.ini' + end +end diff --git a/lib/puppet/type/keystone_uwsgi_config.rb b/lib/puppet/type/keystone_uwsgi_config.rb new file mode 100644 index 000000000..de2414c82 --- /dev/null +++ b/lib/puppet/type/keystone_uwsgi_config.rb @@ -0,0 +1,12 @@ +Puppet::Type.newtype(:keystone_uwsgi_config) do + require File.expand_path(File.join( + File.dirname(__FILE__), '..', '..', + 'puppet_x', 'keystone_config', 'ini_setting')) + extend PuppetX::KeystoneConfig::IniSetting + + create_parameters + + autorequire(:file) do + ['/etc/keystone/keystone-uwsgi.ini'] + end +end diff --git a/manifests/deps.pp b/manifests/deps.pp index 08a8c1bda..6f5ec0487 100644 --- a/manifests/deps.pp +++ b/manifests/deps.pp @@ -30,6 +30,11 @@ class keystone::deps { -> Keystone_puppet_config<||> ~> Anchor['keystone::config::end'] + # On any uwsgi config change, we must restart Keystone. + Anchor['keystone::config::begin'] + -> Keystone_uwsgi_config<||> + ~> Anchor['keystone::config::end'] + # all cache settings should be applied and all packages should be installed # before service startup Oslo::Cache<||> -> Anchor['keystone::service::begin'] diff --git a/manifests/wsgi/uwsgi.pp b/manifests/wsgi/uwsgi.pp new file mode 100644 index 000000000..d2b4f7f28 --- /dev/null +++ b/manifests/wsgi/uwsgi.pp @@ -0,0 +1,41 @@ +# +# Copyright 2021 Thomas Goirand +# +# Author: Thomas Goirand +# +# == Class: keystone::wsgi::uwsgi +# +# Configure the UWSGI service for Keystone. +# +# == Parameters +# +# [*processes*] +# (Optional) Number of processes. +# Defaults to $::os_workers. +# +# [*threads*] +# (Optional) Number of threads. +# Defaults to 32. +# +# [*listen_queue_size*] +# (Optional) Socket listen queue size. +# Defaults to 100 +# +class keystone::wsgi::uwsgi ( + $processes = $::os_workers, + $threads = 32, + $listen_queue_size = 100, +){ + + include keystone::deps + + if $::os_package_type != 'debian'{ + warning('This class is only valid for Debian, as other operating systems are not using uwsgi by default.') + } + + keystone_uwsgi_config { + 'uwsgi/processes': value => $processes; + 'uwsgi/threads': value => $threads; + 'uwsgi/listen': value => $listen_queue_size; + } +} diff --git a/releasenotes/notes/uwsgi-0ba5d20114a3d054.yaml b/releasenotes/notes/uwsgi-0ba5d20114a3d054.yaml new file mode 100644 index 000000000..c310d682d --- /dev/null +++ b/releasenotes/notes/uwsgi-0ba5d20114a3d054.yaml @@ -0,0 +1,7 @@ +--- +features: + - | + A new class keystone::wsgi::uwsgi exist to allow configuring uwsgi in + operating systems that support this (ie: currently Debian). This helps + configuring the number of processes, threads and listen socket. + Also, a new keystone_wsgi_config provider now exist. diff --git a/spec/classes/keystone_wsgi_uwsgi_spec.rb b/spec/classes/keystone_wsgi_uwsgi_spec.rb new file mode 100644 index 000000000..324ca51ed --- /dev/null +++ b/spec/classes/keystone_wsgi_uwsgi_spec.rb @@ -0,0 +1,31 @@ +require 'spec_helper' + +describe 'keystone::wsgi::uwsgi' do + + shared_examples 'keystone::wsgi::uwsgi' do + context 'with default parameters' do + it { + should contain_class('keystone::deps') + } + + it { + is_expected.to contain_keystone_uwsgi_config('uwsgi/processes').with_value(facts[:os_workers]) + is_expected.to contain_keystone_uwsgi_config('uwsgi/threads').with_value('32') + is_expected.to contain_keystone_uwsgi_config('uwsgi/listen').with_value('100') + } + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts({ + :os_workers => 8, + })) + end + it_behaves_like 'keystone::wsgi::uwsgi' + end + end +end diff --git a/spec/unit/provider/keystone_uwsgi_config/ini_setting_spec.rb b/spec/unit/provider/keystone_uwsgi_config/ini_setting_spec.rb new file mode 100644 index 000000000..852cfa6c1 --- /dev/null +++ b/spec/unit/provider/keystone_uwsgi_config/ini_setting_spec.rb @@ -0,0 +1,57 @@ +# +# these tests are a little concerning b/c they are hacking around the +# modulepath, so these tests will not catch issues that may eventually arise +# related to loading these plugins. +# I could not, for the life of me, figure out how to programatcally set the modulepath +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + '..', + 'fixtures', + 'modules', + 'inifile', + 'lib') +) +require 'spec_helper' +provider_class = Puppet::Type.type(:keystone_uwsgi_config).provider(:ini_setting) +describe provider_class do + + it 'should default to the default setting when no other one is specified' do + resource = Puppet::Type::Keystone_uwsgi_config.new( + {:name => 'DEFAULT/foo', :value => 'bar'} + ) + provider = provider_class.new(resource) + expect(provider.section).to eq('DEFAULT') + expect(provider.setting).to eq('foo') + end + + it 'should allow setting to be set explicitly' do + resource = Puppet::Type::Keystone_uwsgi_config.new( + {:name => 'dude/foo', :value => 'bar'} + ) + provider = provider_class.new(resource) + expect(provider.section).to eq('dude') + expect(provider.setting).to eq('foo') + end + + it 'should ensure absent when is specified as a value' do + resource = Puppet::Type::Keystone_uwsgi_config.new( + {:name => 'dude/foo', :value => ''} + ) + provider = provider_class.new(resource) + provider.exists? + expect(resource[:ensure]).to eq :absent + end + + it 'should ensure absent when value matches ensure_absent_val' do + resource = Puppet::Type::Keystone_uwsgi_config.new( + {:name => 'dude/foo', :value => 'foo', :ensure_absent_val => 'foo' } + ) + provider = provider_class.new(resource) + provider.exists? + expect(resource[:ensure]).to eq :absent + end + +end diff --git a/spec/unit/type/keystone_uwsgi_config_spec.rb b/spec/unit/type/keystone_uwsgi_config_spec.rb new file mode 100644 index 000000000..13717840e --- /dev/null +++ b/spec/unit/type/keystone_uwsgi_config_spec.rb @@ -0,0 +1,64 @@ +require 'puppet' +require 'puppet/type/keystone_uwsgi_config' + +describe 'Puppet::Type.type(:keystone_uwsgi_config)' do + before :each do + @keystone_uwsgi_config = Puppet::Type.type(:keystone_uwsgi_config).new(:name => 'DEFAULT/foo', :value => 'bar') + end + + it 'should require a name' do + expect { + Puppet::Type.type(:keystone_uwsgi_config).new({}) + }.to raise_error(Puppet::Error, 'Title or name must be provided') + end + + it 'should not expect a name with whitespace' do + expect { + Puppet::Type.type(:keystone_uwsgi_config).new(:name => 'f oo') + }.to raise_error(Puppet::Error, /Parameter name failed/) + end + + it 'should fail when there is no section' do + expect { + Puppet::Type.type(:keystone_uwsgi_config).new(:name => 'foo') + }.to raise_error(Puppet::Error, /Parameter name failed/) + end + + it 'should not require a value when ensure is absent' do + Puppet::Type.type(:keystone_uwsgi_config).new(:name => 'DEFAULT/foo', :ensure => :absent) + end + + it 'should accept a valid value' do + @keystone_uwsgi_config[:value] = 'bar' + expect(@keystone_uwsgi_config[:value]).to eq('bar') + end + + it 'should not accept a value with whitespace' do + @keystone_uwsgi_config[:value] = 'b ar' + expect(@keystone_uwsgi_config[:value]).to eq('b ar') + end + + it 'should accept valid ensure values' do + @keystone_uwsgi_config[:ensure] = :present + expect(@keystone_uwsgi_config[:ensure]).to eq(:present) + @keystone_uwsgi_config[:ensure] = :absent + expect(@keystone_uwsgi_config[:ensure]).to eq(:absent) + end + + it 'should not accept invalid ensure values' do + expect { + @keystone_uwsgi_config[:ensure] = :latest + }.to raise_error(Puppet::Error, /Invalid value/) + end + + it 'should autorequire the package that install the file' do + catalog = Puppet::Resource::Catalog.new + anchor = Puppet::Type.type(:anchor).new(:name => 'keystone::install::end') + catalog.add_resource anchor, @keystone_uwsgi_config + dependency = @keystone_uwsgi_config.autorequire + expect(dependency.size).to eq(1) + expect(dependency[0].target).to eq(@keystone_uwsgi_config) + expect(dependency[0].source).to eq(anchor) + end + +end