openstack/puppet-neutron
Code Issues Proposed changes

Deprecate verbose option in logging

Browse Source 
Option "verbose" from group "DEFAULT" is deprecated for removal.
The parameter has no effect.
-Deprecated verbose for logging and init
-Remove verbose in README
-Remove verbose from tests.

If this option is not set explicitly, there is no such warning

Change-Id: Ie9ee71cafb029cc7c6183f3de4762218030a1032
This commit is contained in:
Iury Gregory Melo Ferreira 2016-05-18 00:29:38 -03:00
parent 25cf3271dd
commit 475788101f
10 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -48,7 +48,6 @@ class { '::neutron':
rabbit_host => '127.0.0.1',
rabbit_user => 'neutron',
rabbit_password => 'rabbit_secret',
verbose => false,
debug => false,
}
@ -101,12 +100,12 @@ neutron is a combination of Puppet manifest and ruby code to deliver configurati
The `neutron_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/neutron/neutron.conf` file.
```puppet
neutron_config { 'DEFAULT/verbose' :
value => true,
neutron_config { 'DEFAULT/core_plugin' :
value => openvswitch,
}
```
This will write `verbose=true` in the `[DEFAULT]` section.
This will write `core_plugin=openvswitch` in the `[DEFAULT]` section.
##### name

1
examples/cisco_ml2.pp
View File

@ -4,7 +4,6 @@ class { '::neutron':
rabbit_host => '127.0.0.1',
rabbit_user => 'neutron',
rabbit_password => 'rabbit_secret',
verbose => true,
debug => true,
}

1
examples/neutron.pp
View File

@ -3,7 +3,6 @@
# General Neutron stuff
# Configures everything in neutron.conf
class { '::neutron':
verbose => true,
allow_overlapping_ips => true,
rabbit_password => 'password',
rabbit_user => 'guest',

1
examples/neutron_with_pacemaker.pp
View File

@ -23,7 +23,6 @@
# sudo pcs constraint colocation add neutron_server_service with neutron_vip
class { '::neutron':
verbose => true,
allow_overlapping_ips => true,
service_plugins => [ 'dhcp', 'l3' ]
}

4
manifests/init.pp
View File

@ -448,6 +448,10 @@ class neutron (
include ::neutron::logging
}
if $verbose {
warning('verbose is deprecated, has no effect and will be removed after Newton cycle.')
}
if ! is_service_default($use_ssl) and ($use_ssl) {
if is_service_default($cert_file) {
fail('The cert_file parameter is required when use_ssl is set to true')

11
manifests/logging.pp
View File

@ -105,10 +105,9 @@
#
# [*verbose*]
# (optional) Deprecated. Verbose logging
# Defaults to $::os_service_default
# Defaults to undef
#
class neutron::logging (
$verbose = $::os_service_default,
$debug = $::os_service_default,
$use_syslog = $::os_service_default,
$use_stderr = $::os_service_default,
@ -129,9 +128,10 @@ class neutron::logging (
$instance_format = $::os_service_default,
$instance_uuid_format = $::os_service_default,
$fatal_deprecations = $::os_service_default,
# Deprecated
$verbose = undef,
) {
$verbose_real = pick($::neutron::verbose,$verbose)
$debug_real = pick($::neutron::debug,$debug)
$use_syslog_real = pick($::neutron::use_syslog,$use_syslog)
$use_stderr_real = pick($::neutron::use_stderr,$use_stderr)
@ -139,12 +139,11 @@ class neutron::logging (
$log_file_real = pick($::neutron::log_file,$log_file)
$log_dir_real = pick($::neutron::log_dir,$log_dir)
if ! is_service_default($verbose_real) {
warning('verbose parameter is deprecated and will be removed.')
if $verbose {
warning('verbose is deprecated, has no effect and will be removed after Newton cycle.')
}
oslo::log { 'neutron_config':
verbose => $verbose_real,
debug => $debug_real,
use_stderr => $use_stderr_real,
use_syslog => $use_syslog_real,

4
releasenotes/notes/verbose-deprecation-c3933b9e4aa8f7ad.yaml Normal file
View File

@ -0,0 +1,4 @@
---
deprecations:
- verbose option is now deprecated for removal, the
parameter has no effect.

1
spec/acceptance/basic_neutron_spec.rb
View File

@ -35,7 +35,6 @@ describe 'basic neutron' do
allow_overlapping_ips => true,
core_plugin => 'ml2',
debug => true,
verbose => true,
service_plugins => [
'neutron.services.l3_router.l3_router_plugin.L3RouterPlugin',
'neutron_lbaas.services.loadbalancer.plugin.LoadBalancerPlugin',

1
spec/classes/neutron_init_spec.rb
View File

@ -129,7 +129,6 @@ describe 'neutron' do
end
it 'configures neutron.conf' do
is_expected.to contain_neutron_config('DEFAULT/verbose').with_value( '<SERVICE DEFAULT>' )
is_expected.to contain_neutron_config('DEFAULT/bind_host').with_value('<SERVICE DEFAULT>')
is_expected.to contain_neutron_config('DEFAULT/bind_port').with_value('<SERVICE DEFAULT>')
is_expected.to contain_neutron_config('DEFAULT/auth_strategy').with_value('keystone')

3
spec/classes/neutron_logging_spec.rb
View File

@ -30,7 +30,6 @@ describe 'neutron::logging' do
:log_dir => '/var/log',
:log_file => 'neutron.log',
:watch_log_file => true,
:verbose => true,
:debug => true,
}
end
@ -61,7 +60,6 @@ describe 'neutron::logging' do
is_expected.to contain_neutron_config('DEFAULT/log_dir').with(:value => '/var/log/neutron')
is_expected.to contain_neutron_config('DEFAULT/log_file').with(:value => '<SERVICE DEFAULT>')
is_expected.to contain_neutron_config('DEFAULT/watch_log_file').with(:value => '<SERVICE DEFAULT>')
is_expected.to contain_neutron_config('DEFAULT/verbose').with(:value => '<SERVICE DEFAULT>')
is_expected.to contain_neutron_config('DEFAULT/debug').with(:value => '<SERVICE DEFAULT>')
end
end
@ -74,7 +72,6 @@ describe 'neutron::logging' do
is_expected.to contain_neutron_config('DEFAULT/log_dir').with(:value => '/var/log')
is_expected.to contain_neutron_config('DEFAULT/log_file').with(:value => 'neutron.log')
is_expected.to contain_neutron_config('DEFAULT/watch_log_file').with(:value => 'true')
is_expected.to contain_neutron_config('DEFAULT/verbose').with(:value => 'true')
is_expected.to contain_neutron_config('DEFAULT/debug').with(:value => 'true')
end
end