Skip to content

Commit

Permalink
(SIMP-6244) Update file_create_mode for local rule (#93)
Browse files Browse the repository at this point in the history 
* (SIMP-6244) Update file_create_mode for local rule
- Set rsyslog::rule::local::file_create_mode to 0640 by default
- Allow the following to be set directly via Hiera using simplib::dlookup:
  - rsyslog::rule::local::file_create_mode
  - rsyslog::rule::local::dir_create_mode
  - rsyslog::rule::local::queue_max_file_size
- Change dir_create_mode to 750 by default
SIMP-6244 #close
  • Loading branch information
@trevor-vaughan @sharkbruhaha
trevor-vaughan authored and sharkbruhaha committed Apr 18, 2019
1 parent 38d16ad commit 09eb7cc
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 59 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
* Mon Apr 15 2019 Trevor Vaughan <[email protected]> - 7.4.0-0
- Set rsyslog::rule::local::file_create_mode to 0640 by default
- Allow the following to be set directly via Hiera using simplib::dlookup:
- rsyslog::rule::local::file_create_mode
- rsyslog::rule::local::dir_create_mode
- rsyslog::rule::local::queue_max_file_size

* Tue Mar 26 2019 Joseph Sharkey <[email protected]> - 7.4.0-0
- Updated dependencies to use camptocamp/systemd

Expand Down
120 changes: 67 additions & 53 deletions manifests/rule/local.pp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@
# * Other/Miscellaneous Rules
# * Local Rules
#
# NOTE: Since many of the parameters here may need to be modified on a
# case-by-base basis, this defined type uses capabilities presented by the
# ``simplib::dlookup`` function to allow for either global overrides or
# instance-specific overrides.
#
# Global overrides work the same way as classes
# (``rsyslog::rule::local::file_create_mode: '0644'``) but will affect **all**
# instances of the defined type that are not specifically overridden as shown
# below.
#
# Instance specific overrides preclude the need for a resource collector in
# that you can place the follwing in Hiera to affect a single instance named
# ``my_rule``: ``Rsyslog::Rule::Local[my_rule]::file_create_mode: '0600'``
#
# @example Capture OpenLDAP Logs Then Stop Processing
# rsyslog::rule::local { 'collect_openldap':
# rule => "prifilt('local4.*')",
Expand Down Expand Up @@ -113,59 +127,59 @@
# @see http://www.rsyslog.com/doc/rainerscript.html RainerScript Documentation
#
define rsyslog::rule::local (
Optional[String] $rule = undef,
Optional[Stdlib::Absolutepath] $target_log_file = undef,
Boolean $stop_processing = false,
Optional[String] $dyna_file = undef,
Optional[String] $template = undef,
Integer[0] $dyna_file_cache_size = 10,
Integer[0,9] $zip_level = 0,
Boolean $very_robust_zip = true,
Integer[0] $flush_interval = 0,
Boolean $async_writing = false,
Boolean $flush_on_tx_end = true,
Optional[Integer[0]] $io_buffer_size = undef,
Optional[String] $dir_owner = undef,
Optional[Integer[0]] $dir_owner_num = undef,
Optional[String] $dir_group = undef,
Optional[Integer[0]] $dir_group_num = undef,
Optional[String] $file_owner = undef,
Optional[Integer[0]] $file_owner_num = undef,
Optional[String] $file_group = undef,
Optional[Integer[0]] $file_group_num = undef,
String $file_create_mode = '0644',
String $dir_create_mode = '0700',
Boolean $fail_on_chown_failure = true,
Boolean $create_dirs = true,
Boolean $sync = false,
Optional[String] $sig_provider = undef,
Optional[String] $cry_provider = undef,
Optional[Stdlib::Absolutepath] $queue_filename = undef,
Optional[Stdlib::Absolutepath] $queue_spool_directory = undef,
Optional[Integer[0]] $queue_size = undef,
Integer[0] $queue_dequeue_batch_size = 16,
Optional[Integer[0]] $queue_max_disk_space = undef,
Optional[Integer[0]] $queue_high_watermark = undef,
Integer[0] $queue_low_watermark = 2000,
Optional[Integer[0]] $queue_full_delay_mark = undef,
Optional[Integer[0]] $queue_light_delay_mark = undef,
Integer[0] $queue_discard_mark = 9750,
Integer[0] $queue_discard_severity = 8,
Optional[Integer[0]] $queue_checkpoint_interval = undef,
Boolean $queue_sync_queue_files = false,
Enum['FixedArray','LinkedList','Direct','Disk'] $queue_type = 'Direct',
Integer[0] $queue_worker_threads = 1,
Integer[0] $queue_timeout_shutdown = 0,
Integer[0] $queue_timeout_action_completion = 1000,
Integer[0] $queue_timeout_enqueue = 2000,
Integer[0] $queue_timeout_worker_thread_shutdown = 60000,
Integer[0] $queue_worker_thread_minimum_messages = 100,
String $queue_max_file_size = '1m',
Boolean $queue_save_on_shutdown = false,
Integer[0] $queue_dequeue_slowdown = 0,
Optional[Integer[0]] $queue_dequeue_time_begin = undef,
Optional[Integer[0]] $queue_dequeue_time_end = undef,
Optional[String] $content = undef
Optional[String[1]] $rule = undef,
Optional[Stdlib::Absolutepath] $target_log_file = undef,
Boolean $stop_processing = false,
Optional[String[1]] $dyna_file = undef,
Optional[String[1]] $template = undef,
Integer[0] $dyna_file_cache_size = 10,
Integer[0,9] $zip_level = 0,
Boolean $very_robust_zip = true,
Integer[0] $flush_interval = 0,
Boolean $async_writing = false,
Boolean $flush_on_tx_end = true,
Optional[Integer[0]] $io_buffer_size = undef,
Optional[String[1]] $dir_owner = undef,
Optional[Integer[0]] $dir_owner_num = undef,
Optional[String[1]] $dir_group = undef,
Optional[Integer[0]] $dir_group_num = undef,
Optional[String[1]] $file_owner = undef,
Optional[Integer[0]] $file_owner_num = undef,
Optional[String[1]] $file_group = undef,
Optional[Integer[0]] $file_group_num = undef,
Stdlib::Filemode $file_create_mode = simplib::dlookup('rsyslog::rule::local', 'file_create_mode', $name, { 'default_value' => '0640' }),
Stdlib::Filemode $dir_create_mode = simplib::dlookup('rsyslog::rule::local', 'dir_create_mode', $name, { 'default_value' => '0750' }),
Boolean $fail_on_chown_failure = true,
Boolean $create_dirs = true,
Boolean $sync = false,
Optional[String[1]] $sig_provider = undef,
Optional[String[1]] $cry_provider = undef,
Optional[Stdlib::Absolutepath] $queue_filename = undef,
Optional[Stdlib::Absolutepath] $queue_spool_directory = undef,
Optional[Integer[0]] $queue_size = undef,
Integer[0] $queue_dequeue_batch_size = 16,
Optional[Integer[0]] $queue_max_disk_space = undef,
Optional[Integer[0]] $queue_high_watermark = undef,
Integer[0] $queue_low_watermark = 2000,
Optional[Integer[0]] $queue_full_delay_mark = undef,
Optional[Integer[0]] $queue_light_delay_mark = undef,
Integer[0] $queue_discard_mark = 9750,
Integer[0] $queue_discard_severity = 8,
Optional[Integer[0]] $queue_checkpoint_interval = undef,
Boolean $queue_sync_queue_files = false,
Rsyslog::QueueType $queue_type = 'Direct',
Integer[0] $queue_worker_threads = 1,
Integer[0] $queue_timeout_shutdown = 0,
Integer[0] $queue_timeout_action_completion = 1000,
Integer[0] $queue_timeout_enqueue = 2000,
Integer[0] $queue_timeout_worker_thread_shutdown = 60000,
Integer[0] $queue_worker_thread_minimum_messages = 100,
String[1] $queue_max_file_size = simplib::dlookup('rsyslog::rule::local', 'queue_max_file_size', $name, { 'default_value' => '1m' }),
Boolean $queue_save_on_shutdown = false,
Integer[0] $queue_dequeue_slowdown = 0,
Optional[Integer[0]] $queue_dequeue_time_begin = undef,
Optional[Integer[0]] $queue_dequeue_time_end = undef,
Optional[String[1]] $content = undef
) {

unless ($rule or $content) {
Expand Down
2 changes: 1 addition & 1 deletion metadata.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
{
"name": "simp/simplib",
"version_requirement": ">= 3.1.0 < 4.0.0"
"version_requirement": ">= 3.12.0 < 4.0.0"
},
{
"name": "simp/pki",
Expand Down
10 changes: 5 additions & 5 deletions spec/defines/rule/local_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
let(:facts) do
os_facts
end

context 'when only rule and target_log_file specified' do
let(:params) do
{
Expand All @@ -32,8 +32,8 @@
veryRobustZip="on"
flushInterval="0"
flushOnTXEnd="on"
fileCreateMode="0644"
dirCreateMode="0700"
fileCreateMode="0640"
dirCreateMode="0750"
failOnChownFailure="on"
createDirs="on"
queue.dequeuebatchsize="16"
Expand Down Expand Up @@ -79,7 +79,7 @@
:file_owner_num => 300,
:file_group => 'rsyslog_file_group',
:file_group_num => 400,
:file_create_mode => '0640',
:file_create_mode => '0644',
:dir_create_mode => '0750',
:fail_on_chown_failure => false,
:create_dirs => false,
Expand Down Expand Up @@ -135,7 +135,7 @@
fileOwnerNum="300"
fileGroup="rsyslog_file_group"
fileGroupNum="400"
fileCreateMode="0640"
fileCreateMode="0644"
dirCreateMode="0750"
sync="on"
sig.provider="sig_provider"
Expand Down
8 changes: 8 additions & 0 deletions types/queuetype.pp
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Rsyslog Queue Types
#
type Rsyslog::QueueType = Enum[
'FixedArray',
'LinkedList',
'Direct',
'Disk'
]

0 comments on commit 09eb7cc

Please sign in to comment.