Add support for gnocchi_api_uwsgi_config in Debian

This patch is adding the configuration of the number of workers,
threads, and the size of the listen queue in Debian, which uses
uwsgi to run Gnocchi API. Therefore, this patch adds a new
gnocchi_api_uwsgi_config providers as well as a new
gnocchi::wsgi::uwsgi_api class.

Change-Id: Iea9a674be86902be46fdc124e6d0ecf0c1ec8961
This commit is contained in:
Thomas Goirand 2021-04-07 18:54:22 +02:00
parent 620df2f563
commit 8dcef88edb
8 changed files with 250 additions and 0 deletions

View File

@ -0,0 +1,10 @@
Puppet::Type.type(:gnocchi_api_uwsgi_config).provide(
:openstackconfig,
:parent => Puppet::Type.type(:openstack_config).provider(:ruby)
) do
def self.file_path
'/etc/gnocchi/gnocchi-api-uwsgi.ini'
end
end

View File

@ -0,0 +1,29 @@
Puppet::Type.newtype(:gnocchi_api_uwsgi_config) do
ensurable
newparam(:name, :namevar => true) do
desc 'Section/setting name to manage from /etc/gnocchi/gnocchi-api-uwsgi.ini'
newvalues(/\S+\/\S+/)
end
newproperty(:value) do
desc 'The value of the setting to be defined.'
munge do |value|
value = value.to_s.strip
value.capitalize! if value =~ /^(true|false)$/i
value
end
newvalues(/^[\S ]*$/)
end
newparam(:ensure_absent_val) do
desc 'A value that is specified as the value property will behave as if ensure => absent was specified'
defaultto('<SERVICE DEFAULT>')
end
autorequire(:anchor) do
['gnocchi::install::end']
end
end

View File

@ -29,6 +29,11 @@ class gnocchi::deps {
-> Openstacklib::Policy::Base<||> -> Openstacklib::Policy::Base<||>
~> Anchor['gnocchi::config::end'] ~> Anchor['gnocchi::config::end']
# On any uwsgi config change, we must restart gnocchi-api.
Anchor['gnocchi::config::begin']
-> Gnocchi_api_uwsgi_config<||>
~> Anchor['gnocchi::config::end']
# Installation or config changes will always restart services. # Installation or config changes will always restart services.
Anchor['gnocchi::install::end'] ~> Anchor['gnocchi::service::begin'] Anchor['gnocchi::install::end'] ~> Anchor['gnocchi::service::begin']
Anchor['gnocchi::config::end'] ~> Anchor['gnocchi::service::begin'] Anchor['gnocchi::config::end'] ~> Anchor['gnocchi::service::begin']

41
manifests/wsgi/uwsgi.pp Normal file
View File

@ -0,0 +1,41 @@
#
# Copyright 2021 Thomas Goirand <zigo@debian.org>
#
# Author: Thomas Goirand <zigo@debian.org>
#
# == Class: gnocchi::wsgi::uwsgi
#
# Configure the UWSGI service for Gnocchi API.
#
# == 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 gnocchi::wsgi::uwsgi (
$processes = $::os_workers,
$threads = 32,
$listen_queue_size = 100,
){
include gnocchi::deps
if $::os_package_type != 'debian'{
warning('This class is only valid for Debian, as other operating systems are not using uwsgi by default.')
}
gnocchi_api_uwsgi_config {
'uwsgi/processes': value => $processes;
'uwsgi/threads': value => $threads;
'uwsgi/listen': value => $listen_queue_size;
}
}

View File

@ -0,0 +1,7 @@
---
features:
- |
A new class gnocchi::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 gnocchi_api_wsgi_config provider now exist.

View File

@ -0,0 +1,31 @@
require 'spec_helper'
describe 'gnocchi::wsgi::uwsgi' do
shared_examples 'gnocchi::wsgi::uwsgi' do
context 'with default parameters' do
it {
should contain_class('gnocchi::deps')
}
it {
is_expected.to contain_gnocchi_api_uwsgi_config('uwsgi/processes').with_value(facts[:os_workers])
is_expected.to contain_gnocchi_api_uwsgi_config('uwsgi/threads').with_value('32')
is_expected.to contain_gnocchi_api_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 'gnocchi::wsgi::uwsgi'
end
end
end

View File

@ -0,0 +1,63 @@
$LOAD_PATH.push(
File.join(
File.dirname(__FILE__),
'..',
'..',
'..',
'fixtures',
'modules',
'inifile',
'lib')
)
$LOAD_PATH.push(
File.join(
File.dirname(__FILE__),
'..',
'..',
'..',
'fixtures',
'modules',
'openstacklib',
'lib')
)
require 'spec_helper'
provider_class = Puppet::Type.type(:gnocchi_api_uwsgi_config).provider(:openstackconfig)
describe provider_class do
it 'should default to the default setting when no other one is specified' do
resource = Puppet::Type::Gnocchi_api_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::Gnocchi_api_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 <SERVICE DEFAULT> is specified as a value' do
resource = Puppet::Type::Gnocchi_api_uwsgi_config.new(
{:name => 'dude/foo', :value => '<SERVICE DEFAULT>'}
)
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::Gnocchi_api_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

View File

@ -0,0 +1,64 @@
require 'puppet'
require 'puppet/type/gnocchi_api_uwsgi_config'
describe 'Puppet::Type.type(:gnocchi_api_uwsgi_config)' do
before :each do
@gnocchi_api_uwsgi_config = Puppet::Type.type(:gnocchi_api_uwsgi_config).new(:name => 'DEFAULT/foo', :value => 'bar')
end
it 'should require a name' do
expect {
Puppet::Type.type(:gnocchi_api_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(:gnocchi_api_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(:gnocchi_api_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(:gnocchi_api_uwsgi_config).new(:name => 'DEFAULT/foo', :ensure => :absent)
end
it 'should accept a valid value' do
@gnocchi_api_uwsgi_config[:value] = 'bar'
expect(@gnocchi_api_uwsgi_config[:value]).to eq('bar')
end
it 'should not accept a value with whitespace' do
@gnocchi_api_uwsgi_config[:value] = 'b ar'
expect(@gnocchi_api_uwsgi_config[:value]).to eq('b ar')
end
it 'should accept valid ensure values' do
@gnocchi_api_uwsgi_config[:ensure] = :present
expect(@gnocchi_api_uwsgi_config[:ensure]).to eq(:present)
@gnocchi_api_uwsgi_config[:ensure] = :absent
expect(@gnocchi_api_uwsgi_config[:ensure]).to eq(:absent)
end
it 'should not accept invalid ensure values' do
expect {
@gnocchi_api_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 => 'gnocchi::install::end')
catalog.add_resource anchor, @gnocchi_api_uwsgi_config
dependency = @gnocchi_api_uwsgi_config.autorequire
expect(dependency.size).to eq(1)
expect(dependency[0].target).to eq(@gnocchi_api_uwsgi_config)
expect(dependency[0].source).to eq(anchor)
end
end