openstack
/
puppet-designate
Code Issues Proposed changes

Deprecated designate::pool_manager 

The pool-manager is completely removed from
Designate in Train [1] so we should deprecate
it before final release.

[1] https://docs.openstack.org/releasenotes/designate/train.html

Depends-On: https://review.opendev.org/#/c/687343/
Change-Id: Ic9ca6ee2e7cf927d926155ea73e65fb250ca083a
This commit is contained in:
Tobias Urdin 2019-10-08 17:32:11 +02:00
parent 77a225daea
commit a89d6bc336
7 changed files with 21 additions and 330 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
manifests/pool_manager.pp
View File

@ -1,5 +1,7 @@
# == Class: designate::pool_manager
#
# DEPRECATED!
#
# Configure designate pool manager service
#
# == Parameters
@ -107,45 +109,5 @@ class designate::pool_manager(
$periodic_sync_retry_interval = $::os_service_default,
) {
include ::designate::deps
include ::designate::params
if $pool_id !~ /^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{12}$/ {
fail('pool_id should be a valid UUID')
}
if $manage_package {
package { 'designate-pool-manager':
ensure => $package_ensure,
name => pick($pool_manager_package_name, $::designate::params::pool_manager_package_name),
tag => ['openstack', 'designate-package'],
}
}
service { 'designate-pool-manager':
ensure => $service_ensure,
name => $::designate::params::pool_manager_service_name,
enable => $enabled,
hasstatus => true,
hasrestart => true,
tag => ['openstack', 'designate-service'],
}
designate_config {
'service:pool_manager/pool_id': value => $pool_id;
'service:pool_manager/workers': value => $workers;
'service:pool_manager/threads': value => $threads;
'service:pool_manager/threshold_percentage': value => $threshold_percentage;
'service:pool_manager/poll_timeout': value => $poll_timeout;
'service:pool_manager/poll_retry_interval': value => $poll_retry_interval;
'service:pool_manager/poll_max_retries': value => $poll_max_retries;
'service:pool_manager/poll_delay': value => $poll_delay;
'service:pool_manager/periodic_recovery_interval': value => $periodic_recovery_interval;
'service:pool_manager/periodic_sync_interval': value => $periodic_sync_interval;
'service:pool_manager/periodic_sync_seconds': value => $periodic_sync_seconds;
'service:pool_manager/enable_recovery_timer': value => $enable_recovery_timer;
'service:pool_manager/enable_sync_timer': value => $enable_sync_timer;
'service:pool_manager/periodic_sync_max_attempts': value => $periodic_sync_max_attempts;
'service:pool_manager/periodic_sync_retry_interval': value => $periodic_sync_retry_interval;
}
warning('designate::pool_manager is deprecated, has no effect and will be removed in the next release')
}

13
manifests/pool_manager_cache/memcache.pp
View File

@ -1,5 +1,7 @@
# == Class: designate::pool_manager_cache::memcache
#
# DEPRECATED!
#
# Configure Memcache as caching service for the pool manager.
#
# == Parameters
@ -17,13 +19,6 @@ class designate::pool_manager_cache::memcache(
$expiration = $::os_service_default,
){
include ::designate::deps
validate_legacy(Array, 'validate_array', $memcached_servers)
designate_config {
'service:pool_manager/cache_driver': value => 'memcache';
'pool_manager_cache:memcache/memcached_servers': value => join($memcached_servers,',');
'pool_manager_cache:memcache/expiration': value => $expiration;
}
warning('designate::pool_manager_cache::memcache is deprecated, \
has no effect and will be removed in the next release')
}

16
manifests/pool_manager_cache/sqlalchemy.pp
View File

@ -1,5 +1,7 @@
# Class: designate::pool_manager_cache::sqlalchemy
#
# DEPRECATED!
#
# === Parameters
#
# [*connection*]
@ -41,16 +43,6 @@ class designate::pool_manager_cache::sqlalchemy(
$retry_interval = $::os_service_default,
){
include ::designate::deps
designate_config {
'service:pool_manager/cache_driver': value => 'sqlalchemy';
'pool_manager_cache:sqlalchemy/connection': value => $connection;
'pool_manager_cache:sqlalchemy/connection_debug': value => $connection_debug;
'pool_manager_cache:sqlalchemy/connection_trace': value => $connection_trace;
'pool_manager_cache:sqlalchemy/sqlite_synchronous': value => $sqlite_synchronous;
'pool_manager_cache:sqlalchemy/idle_timeout': value => $idle_timeout;
'pool_manager_cache:sqlalchemy/max_retries': value => $max_retries;
'pool_manager_cache:sqlalchemy/retry_interval': value => $retry_interval;
}
warning('designate::pool_manager_cache::sqlalchemy is deprecated, \
has no effect and will be removed in the next release')
}

10
releasenotes/notes/deprecate-designate-pool-manager-1cc74f76f0488dd5.yaml Normal file
View File

@ -0,0 +1,10 @@
---
upgrade:
- |
The pool-manager is removed in this release so all related classes are
deprecated and has no effect. You should move to using the producer instead.
deprecations:
- |
The designate::pool_manager, designate::pool_manager_cache::memcache,
designate::pool_manager_cache::sqlalchemy classes is deprecated and
has no effect. You should use the designate::producer class instead.

61
spec/classes/designate_pool_manager_cache_memcache_spec.rb
View File

@ -1,61 +0,0 @@
#
# Unit tests for designate::pool_manager
#
require 'spec_helper'
describe 'designate::pool_manager_cache::memcache' do
let :params do
{
}
end
shared_examples 'designate-pool-manager-cache-memcache' do
context 'with default parameters' do
it { is_expected.to contain_class('designate::pool_manager_cache::memcache') }
it 'configures designate-pool-manager with required parameters' do
is_expected.to contain_designate_config('service:pool_manager/cache_driver').with_value('memcache')
is_expected.to contain_designate_config('pool_manager_cache:memcache/memcached_servers').with_value(['127.0.0.1'])
is_expected.to contain_designate_config('pool_manager_cache:memcache/expiration').with_value('<SERVICE DEFAULT>')
end
end
context 'with all parameters' do
before do
params.merge!( { :memcached_servers => ['192.168.0.1'], :expiration => 123 } )
end
it { is_expected.to contain_class('designate::pool_manager_cache::memcache') }
it 'configures designate-pool-manager with required parameters' do
is_expected.to contain_designate_config('service:pool_manager/cache_driver').with_value('memcache')
is_expected.to contain_designate_config('pool_manager_cache:memcache/memcached_servers').with_value( params[:memcached_servers] )
is_expected.to contain_designate_config('pool_manager_cache:memcache/expiration').with_value( params[:expiration] )
end
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())
end
let(:platform_params) do
case facts[:osfamily]
when 'Debian'
{
:pool_manager_package_name => 'designate-pool-manager',
:pool_manager_service_name => 'designate-pool-manager'
}
when 'RedHat'
{
:pool_manager_package_name => 'openstack-designate-pool-manager',
:pool_manager_service_name => 'designate-pool-manager'
}
end
end
it_behaves_like 'designate-pool-manager-cache-memcache'
end
end
end

68
spec/classes/designate_pool_manager_cache_sqlalchemy_spec.rb
View File

@ -1,68 +0,0 @@
#
# Unit tests for designate::pool_manager_cache::sqlalchemy
#
require 'spec_helper'
describe 'designate::pool_manager_cache::sqlalchemy' do
let :params do
{
}
end
let :params_all do
{
:connection => 'connection = sqlite:///$state_path/designate_pool_manager.sqlite',
:connection_debug => 100,
:connection_trace => true,
:sqlite_synchronous => true,
:idle_timeout => 3600,
:max_retries => 10,
:retry_interval => 10,
}
end
shared_examples 'designate-pool-manager-cache-sqlalchemy' do
context 'with default parameters' do
it { is_expected.to contain_class('designate::pool_manager_cache::sqlalchemy') }
it 'configures designate-pool-manager with required parameters' do
is_expected.to contain_designate_config('service:pool_manager/cache_driver').with_value('sqlalchemy')
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/connection').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/connection_debug').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/connection_trace').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/sqlite_synchronous').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/idle_timeout').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/max_retries').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/retry_interval').with_value('<SERVICE DEFAULT>')
end
end
context 'with all parameters' do
before do
params.merge!( params_all )
end
it 'configures designate-pool-manager with required parameters' do
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/connection').with_value( params[:connection] )
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/connection_debug').with_value( params[:connection_debug] )
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/connection_trace').with_value( params[:connection_trace] )
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/sqlite_synchronous').with_value( params[:sqlite_synchronous] )
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/idle_timeout').with_value( params[:idle_timeout] )
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/max_retries').with_value( params[:max_retries] )
is_expected.to contain_designate_config('pool_manager_cache:sqlalchemy/retry_interval').with_value( params[:retry_interval] )
end
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())
end
it_behaves_like 'designate-pool-manager-cache-sqlalchemy'
end
end
end

139
spec/classes/designate_pool_manager_spec.rb
View File

@ -1,139 +0,0 @@
#
# Unit tests for designate::pool_manager
#
require 'spec_helper'
describe 'designate::pool_manager' do
let :params do
{
:pool_id => '794ccc2c-d751-44fe-b57f-8894c9f5c842',
}
end
let :params_all do
{
:manage_package => true,
:package_ensure => 'present',
:pool_manager_package_name => nil,
:enabled => true,
:service_ensure => 'running',
:workers => 10,
:threads => 900,
:threshold_percentage => 90,
:poll_timeout => 15,
:poll_retry_interval => 10,
:poll_max_retries => 5,
:poll_delay => 1,
:enable_recovery_timer => false,
:periodic_recovery_interval => 60,
:enable_sync_timer => false,
:periodic_sync_interval => 900,
:periodic_sync_seconds => 5,
:periodic_sync_max_attempts => 1,
:periodic_sync_retry_interval => 15,
}
end
shared_examples 'designate-pool-manager' do
context 'with default parameters' do
it { is_expected.to contain_class('designate::pool_manager') }
it 'installs designate-pool-manager package and service' do
is_expected.to contain_service('designate-pool-manager').with(
:name => platform_params[:pool_manager_service_name],
:ensure => 'running',
:enable => 'true',
:tag => ['openstack', 'designate-service'],
)
is_expected.to contain_package('designate-pool-manager').with(
:name => platform_params[:pool_manager_package_name],
:ensure => 'present',
:tag => ['openstack', 'designate-package'],
)
end
it 'configures designate-pool-manager with default parameters' do
is_expected.to contain_designate_config('service:pool_manager/pool_id').with_value( params[:pool_id] )
is_expected.to contain_designate_config('service:pool_manager/workers').with_value(8)
is_expected.to contain_designate_config('service:pool_manager/threads').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/threshold_percentage').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/poll_timeout').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/poll_retry_interval').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/poll_max_retries').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/poll_delay').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/enable_recovery_timer').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/periodic_recovery_interval').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/enable_sync_timer').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/periodic_sync_interval').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/periodic_sync_seconds').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/periodic_sync_max_attempts').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_designate_config('service:pool_manager/periodic_sync_retry_interval').with_value( '<SERVICE DEFAULT>' )
end
end
context 'with custom package name' do
before do
params.merge!({ :pool_manager_package_name => 'designate-pool-manager-custom-name' })
end
it 'configures using custom name' do
is_expected.to contain_package('designate-pool-manager').with(
:name => 'designate-pool-manager-custom-name',
:ensure => 'present',
:tag => ['openstack', 'designate-package'],
)
end
end
context 'with all params' do
before do
params.merge!( params_all )
end
it 'configures designate-pool-manager with all parameters' do
is_expected.to contain_designate_config('service:pool_manager/pool_id').with_value( params[:pool_id] )
is_expected.to contain_designate_config('service:pool_manager/workers').with_value( params[:workers] )
is_expected.to contain_designate_config('service:pool_manager/threads').with_value( params[:threads] )
is_expected.to contain_designate_config('service:pool_manager/threshold_percentage').with_value( params[:threshold_percentage] )
is_expected.to contain_designate_config('service:pool_manager/poll_timeout').with_value( params[:poll_timeout] )
is_expected.to contain_designate_config('service:pool_manager/poll_retry_interval').with_value( params[:poll_retry_interval] )
is_expected.to contain_designate_config('service:pool_manager/poll_max_retries').with_value( params[:poll_max_retries] )
is_expected.to contain_designate_config('service:pool_manager/poll_delay').with_value( params[:poll_delay] )
is_expected.to contain_designate_config('service:pool_manager/enable_recovery_timer').with_value( params[:enable_recovery_timer] )
is_expected.to contain_designate_config('service:pool_manager/periodic_recovery_interval').with_value( params[:periodic_recovery_interval] )
is_expected.to contain_designate_config('service:pool_manager/enable_sync_timer').with_value( params[:enable_sync_timer] )
is_expected.to contain_designate_config('service:pool_manager/periodic_sync_interval').with_value( params[:periodic_sync_interval] )
is_expected.to contain_designate_config('service:pool_manager/periodic_sync_seconds').with_value( params[:periodic_sync_seconds] )
is_expected.to contain_designate_config('service:pool_manager/periodic_sync_max_attempts').with_value( params[:periodic_sync_max_attempts] )
is_expected.to contain_designate_config('service:pool_manager/periodic_sync_retry_interval').with_value( params[:periodic_sync_retry_interval] )
end
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
let(:platform_params) do
case facts[:osfamily]
when 'Debian'
{
:pool_manager_package_name => 'designate-pool-manager',
:pool_manager_service_name => 'designate-pool-manager'
}
when 'RedHat'
{
:pool_manager_package_name => 'openstack-designate-pool-manager',
:pool_manager_service_name => 'designate-pool-manager'
}
end
end
it_behaves_like 'designate-pool-manager'
end
end
end