Update comment to fix lint

manifests/backend/dellemc_powermax.pp:43:WARNING: No matching defined
type parameter for documentation of
cinder::backend::dellemc_powermax::volume_driver
manifests/backend/san.pp:52:WARNING: Duplicate defined type parameter
documentation for cinder::backend::san::ssh_min_pool_conn
manifests/backend/san.pp:49:WARNING: Duplicate defined type parameter
documentation for cinder::backend::san::ssh_min_pool_conn
manifests/backup/posix.pp:23:WARNING: No matching class parameter for
documentation of cinder::backup::posix::backup_enable_progress_timer
manifests/config.pp:7:WARNING: No matching class parameter for
documentation of cinder::config::xxx_config

Change-Id: I749dc975f4b8e273b5718ff893444c1c913a74db
This commit is contained in:
Takashi Kajinami 2020-10-06 00:13:51 +09:00
parent d9ed840a68
commit ae0372f790
6 changed files with 30 additions and 23 deletions

View File

@ -40,9 +40,6 @@
# is used as the default for all backends. # is used as the default for all backends.
# Defaults to $::os_service_default. # Defaults to $::os_service_default.
# #
# [*volume_driver*]
# (optional) The Dell EMC PowerMax Driver
#
# [*manage_volume_type*] # [*manage_volume_type*]
# (Optional) Whether or not manage Cinder Volume type. # (Optional) Whether or not manage Cinder Volume type.
# If set to true, a Cinder Volume type will be created # If set to true, a Cinder Volume type will be created

View File

@ -49,9 +49,6 @@
# [*ssh_min_pool_conn*] # [*ssh_min_pool_conn*]
# (optional) Minimum ssh connections in the pool. # (optional) Minimum ssh connections in the pool.
# #
# [*ssh_min_pool_conn*]
# (optional) Maximum ssh connections in the pool.
#
# [*ssh_max_pool_conn*] # [*ssh_max_pool_conn*]
# (Optional) Maximum ssh connections in the pool. # (Optional) Maximum ssh connections in the pool.
# Defaults to '5'. # Defaults to '5'.

View File

@ -56,21 +56,23 @@
# #
# #
class cinder::backup::posix ( class cinder::backup::posix (
$backup_driver = 'cinder.backup.drivers.posix.PosixBackupDriver', $backup_driver = 'cinder.backup.drivers.posix.PosixBackupDriver',
$backup_file_size = $::os_service_default, $backup_file_size = $::os_service_default,
$backup_sha_block_size_bytes = $::os_service_default, $backup_sha_block_size_bytes = $::os_service_default,
$backup_posix_path = $::os_service_default, $backup_enable_progress_timer = $::os_service_default,
$backup_container = $::os_service_default, $backup_posix_path = $::os_service_default,
$backup_container = $::os_service_default,
) { ) {
include cinder::deps include cinder::deps
cinder_config { cinder_config {
'DEFAULT/backup_driver': value => $backup_driver; 'DEFAULT/backup_driver': value => $backup_driver;
'DEFAULT/backup_file_size': value => $backup_file_size; 'DEFAULT/backup_file_size': value => $backup_file_size;
'DEFAULT/backup_sha_block_size_bytes': value => $backup_sha_block_size_bytes; 'DEFAULT/backup_sha_block_size_bytes': value => $backup_sha_block_size_bytes;
'DEFAULT/backup_posix_path': value => $backup_posix_path; 'DEFAULT/backup_enable_progress_timer': value => $backup_enable_progress_timer;
'DEFAULT/backup_container': value => $backup_container; 'DEFAULT/backup_posix_path': value => $backup_posix_path;
'DEFAULT/backup_container': value => $backup_container;
} }
} }

View File

@ -2,9 +2,7 @@
# #
# This class is used to manage arbitrary cinder configurations. # This class is used to manage arbitrary cinder configurations.
# #
# === Parameters # example xxx_config
#
# [*xxx_config*]
# (optional) Allow configuration of arbitrary cinder configurations. # (optional) Allow configuration of arbitrary cinder configurations.
# The value is a hash of xxx_config resources. Example: # The value is a hash of xxx_config resources. Example:
# { 'DEFAULT/foo' => { value => 'fooValue'}, # { 'DEFAULT/foo' => { value => 'fooValue'},
@ -18,6 +16,8 @@
# DEFAULT/bar: # DEFAULT/bar:
# value: barValue # value: barValue
# #
# === Parameters
#
# [*cinder_config*] # [*cinder_config*]
# (optional) Allow configuration of cinder.conf configurations. # (optional) Allow configuration of cinder.conf configurations.
# Defaults to empty hash'{}' # Defaults to empty hash'{}'

View File

@ -0,0 +1,6 @@
---
fixes:
- |
The ``cinder::backup::posix::backup_enable_progress_timer`` parameter has
been described in parameter but been invalid. Now the parameter is
implemented as a valid paramater.

View File

@ -44,20 +44,25 @@ describe 'cinder::backup::posix' do
is_expected.to contain_cinder_config('DEFAULT/backup_driver').with_value('cinder.backup.drivers.posix.PosixBackupDriver') is_expected.to contain_cinder_config('DEFAULT/backup_driver').with_value('cinder.backup.drivers.posix.PosixBackupDriver')
is_expected.to contain_cinder_config('DEFAULT/backup_file_size').with_value(p[:backup_file_size]) is_expected.to contain_cinder_config('DEFAULT/backup_file_size').with_value(p[:backup_file_size])
is_expected.to contain_cinder_config('DEFAULT/backup_sha_block_size_bytes').with_value(p[:backup_sha_block_size_bytes]) is_expected.to contain_cinder_config('DEFAULT/backup_sha_block_size_bytes').with_value(p[:backup_sha_block_size_bytes])
is_expected.to contain_cinder_config('DEFAULT/backup_enable_progress_timer').with_value(p[:backup_sha_block_size_bytes])
is_expected.to contain_cinder_config('DEFAULT/backup_posix_path').with_value(p[:backup_posix_path]) is_expected.to contain_cinder_config('DEFAULT/backup_posix_path').with_value(p[:backup_posix_path])
is_expected.to contain_cinder_config('DEFAULT/backup_container').with_value(p[:backup_container]) is_expected.to contain_cinder_config('DEFAULT/backup_container').with_value(p[:backup_container])
end end
context 'when overriding default parameters' do context 'when overriding default parameters' do
before :each do before :each do
params.merge!(:backup_file_size => '4') params.merge!(
params.merge!(:backup_sha_block_size_bytes => '2') { :backup_file_size => '4',
params.merge!(:backup_posix_path => '/etc/backup') :backup_sha_block_size_bytes => '2',
params.merge!(:backup_container => 'mycontainer') :backup_enable_progress_timer => true,
:backup_posix_path => '/etc/backup',
:backup_container => 'mycontainer' })
end end
it 'should replace default parameters with new values' do it 'should replace default parameters with new values' do
is_expected.to contain_cinder_config('DEFAULT/backup_file_size').with_value(p[:backup_file_size]) is_expected.to contain_cinder_config('DEFAULT/backup_file_size').with_value(p[:backup_file_size])
is_expected.to contain_cinder_config('DEFAULT/backup_sha_block_size_bytes').with_value(p[:backup_sha_block_size_bytes]) is_expected.to contain_cinder_config('DEFAULT/backup_sha_block_size_bytes').with_value(p[:backup_sha_block_size_bytes])
is_expected.to contain_cinder_config('DEFAULT/backup_enable_progress_timer').with_value(p[:backup_enable_progress_timer])
is_expected.to contain_cinder_config('DEFAULT/backup_posix_path').with_value(p[:backup_posix_path]) is_expected.to contain_cinder_config('DEFAULT/backup_posix_path').with_value(p[:backup_posix_path])
is_expected.to contain_cinder_config('DEFAULT/backup_container').with_value(p[:backup_container]) is_expected.to contain_cinder_config('DEFAULT/backup_container').with_value(p[:backup_container])
end end