Add support for ironic_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 Ironic API. Therefore, this patch adds a new ironic_api_uwsgi_config provider as well as a new ironic::wsgi::uwsgi class. Change-Id: Ib9a98bd26e1f970bb00efadb59b4d9b5b731bdaa
This commit is contained in:
parent
f71cf51d3c
commit
73b91cf53b
@ -0,0 +1,10 @@
|
||||
Puppet::Type.type(:ironic_api_uwsgi_config).provide(
|
||||
:openstackconfig,
|
||||
:parent => Puppet::Type.type(:openstack_config).provider(:ruby)
|
||||
) do
|
||||
|
||||
def self.file_path
|
||||
'/etc/ironic/ironic-api-uwsgi.ini'
|
||||
end
|
||||
|
||||
end
|
29
lib/puppet/type/ironic_api_uwsgi_config.rb
Normal file
29
lib/puppet/type/ironic_api_uwsgi_config.rb
Normal file
@ -0,0 +1,29 @@
|
||||
Puppet::Type.newtype(:ironic_api_uwsgi_config) do
|
||||
|
||||
ensurable
|
||||
|
||||
newparam(:name, :namevar => true) do
|
||||
desc 'Section/setting name to manage from /etc/ironic/ironic-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
|
||||
['ironic::install::end']
|
||||
end
|
||||
|
||||
end
|
@ -49,6 +49,11 @@ class ironic::deps {
|
||||
Anchor['ironic::db::end']
|
||||
-> Anchor['ironic-inspector::dbsync::begin']
|
||||
|
||||
# On any uwsgi config change, we must restart Ironic API.
|
||||
Anchor['ironic::config::begin']
|
||||
-> Ironic_api_uwsgi_config<||>
|
||||
~> Anchor['ironic::config::end']
|
||||
|
||||
# Support packages need to be installed in the install phase, but we don't
|
||||
# put them in the chain above because we don't want any false dependencies
|
||||
# between packages with the ironic-package tag and the ironic-support-package
|
||||
|
41
manifests/wsgi/uwsgi.pp
Normal file
41
manifests/wsgi/uwsgi.pp
Normal file
@ -0,0 +1,41 @@
|
||||
#
|
||||
# Copyright 2023 Thomas Goirand <zigo@debian.org>
|
||||
#
|
||||
# Author: Thomas Goirand <zigo@debian.org>
|
||||
#
|
||||
# == Class: ironic::wsgi::uwsgi
|
||||
#
|
||||
# Configure the UWSGI service for Ironic 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 ironic::wsgi::uwsgi (
|
||||
$processes = $facts['os_workers'],
|
||||
$threads = 32,
|
||||
$listen_queue_size = 100,
|
||||
){
|
||||
|
||||
include ironic::deps
|
||||
|
||||
if $facts['os']['name'] != 'Debian'{
|
||||
warning('This class is only valid for Debian, as other operating systems are not using uwsgi by default.')
|
||||
}
|
||||
|
||||
ironic_api_uwsgi_config {
|
||||
'uwsgi/processes': value => $processes;
|
||||
'uwsgi/threads': value => $threads;
|
||||
'uwsgi/listen': value => $listen_queue_size;
|
||||
}
|
||||
}
|
7
releasenotes/notes/uwsgi-9c7229851778c551.yaml
Normal file
7
releasenotes/notes/uwsgi-9c7229851778c551.yaml
Normal file
@ -0,0 +1,7 @@
|
||||
---
|
||||
features:
|
||||
- |
|
||||
A new calss ``ironic::wsgi::wsgi`` was added 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 ``ironic_api_uwsgi_config`` provider was added.
|
31
spec/classes/ironic_wsgi_uwsgi_spec.rb
Normal file
31
spec/classes/ironic_wsgi_uwsgi_spec.rb
Normal file
@ -0,0 +1,31 @@
|
||||
require 'spec_helper'
|
||||
|
||||
describe 'ironic::wsgi::uwsgi' do
|
||||
|
||||
shared_examples 'ironic::wsgi::uwsgi' do
|
||||
context 'with default parameters' do
|
||||
it {
|
||||
should contain_class('ironic::deps')
|
||||
}
|
||||
|
||||
it {
|
||||
is_expected.to contain_ironic_api_uwsgi_config('uwsgi/processes').with_value(facts[:os_workers])
|
||||
is_expected.to contain_ironic_api_uwsgi_config('uwsgi/threads').with_value('32')
|
||||
is_expected.to contain_ironic_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 'ironic::wsgi::uwsgi'
|
||||
end
|
||||
end
|
||||
end
|
@ -0,0 +1,41 @@
|
||||
require 'spec_helper'
|
||||
provider_class = Puppet::Type.type(:ironic_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::Ironic_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::Ironic_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::Ironic_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::Ironic_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
|
64
spec/unit/type/ironic_api_uwsgi_config_spec.rb
Normal file
64
spec/unit/type/ironic_api_uwsgi_config_spec.rb
Normal file
@ -0,0 +1,64 @@
|
||||
require 'puppet'
|
||||
require 'puppet/type/ironic_api_uwsgi_config'
|
||||
|
||||
describe 'Puppet::Type.type(:ironic_api_uwsgi_config)' do
|
||||
before :each do
|
||||
@ironic_api_uwsgi_config = Puppet::Type.type(:ironic_api_uwsgi_config).new(:name => 'DEFAULT/foo', :value => 'bar')
|
||||
end
|
||||
|
||||
it 'should require a name' do
|
||||
expect {
|
||||
Puppet::Type.type(:ironic_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(:ironic_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(:ironic_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(:ironic_api_uwsgi_config).new(:name => 'DEFAULT/foo', :ensure => :absent)
|
||||
end
|
||||
|
||||
it 'should accept a valid value' do
|
||||
@ironic_api_uwsgi_config[:value] = 'bar'
|
||||
expect(@ironic_api_uwsgi_config[:value]).to eq('bar')
|
||||
end
|
||||
|
||||
it 'should not accept a value with whitespace' do
|
||||
@ironic_api_uwsgi_config[:value] = 'b ar'
|
||||
expect(@ironic_api_uwsgi_config[:value]).to eq('b ar')
|
||||
end
|
||||
|
||||
it 'should accept valid ensure values' do
|
||||
@ironic_api_uwsgi_config[:ensure] = :present
|
||||
expect(@ironic_api_uwsgi_config[:ensure]).to eq(:present)
|
||||
@ironic_api_uwsgi_config[:ensure] = :absent
|
||||
expect(@ironic_api_uwsgi_config[:ensure]).to eq(:absent)
|
||||
end
|
||||
|
||||
it 'should not accept invalid ensure values' do
|
||||
expect {
|
||||
@ironic_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 => 'ironic::install::end')
|
||||
catalog.add_resource anchor, @ironic_api_uwsgi_config
|
||||
dependency = @ironic_api_uwsgi_config.autorequire
|
||||
expect(dependency.size).to eq(1)
|
||||
expect(dependency[0].target).to eq(@ironic_api_uwsgi_config)
|
||||
expect(dependency[0].source).to eq(anchor)
|
||||
end
|
||||
|
||||
end
|
Loading…
Reference in New Issue
Block a user