From e3323504c10909dd93ca6db8fc324a69701d6126 Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Sat, 20 Sep 2025 08:36:05 +0900 Subject: [PATCH] Add type definitions for log parameters Change-Id: I1348501a0d6f1c9962bb8fe3b764444364957add Signed-off-by: Takashi Kajinami --- manifests/bench.pp | 32 ++++----- manifests/containerreconciler.pp | 8 +-- manifests/objectexpirer.pp | 8 +-- manifests/proxy.pp | 8 +-- manifests/proxy/cname_lookup.pp | 29 +++++--- manifests/proxy/domain_remap.pp | 33 ++++++---- manifests/proxy/gatekeeper.pp | 14 ++-- manifests/storage/all.pp | 66 +++++++++---------- manifests/storage/drive_audit.pp | 8 +-- manifests/storage/server.pp | 8 +-- spec/classes/swift_proxy_cname_lookup_spec.rb | 4 +- spec/classes/swift_proxy_domain_remap_spec.rb | 4 +- spec/classes/swift_proxy_gatekeeper_spec.rb | 4 +- types/logfacility.pp | 10 +++ types/loglevel.pp | 9 +++ 15 files changed, 141 insertions(+), 104 deletions(-) create mode 100644 types/logfacility.pp create mode 100644 types/loglevel.pp diff --git a/manifests/bench.pp b/manifests/bench.pp index 6d8259ae..c638d8a8 100644 --- a/manifests/bench.pp +++ b/manifests/bench.pp @@ -66,22 +66,22 @@ # Defaults to 'yes' # class swift::bench ( - $auth_url = 'http://localhost:8080/auth/v1.0', - $swift_user = 'test:tester', - $swift_key = 'testing', - $auth_version = '1.0', - $log_level = 'INFO', - $test_timeout = '10', - $put_concurrency = '10', - $get_concurrency = '10', - $del_concurrency = '10', - $lower_object_size = '10', - $upper_object_size = '10', - $object_size = '1', - $num_objects = '1000', - $num_gets = '10000', - $num_containers = '20', - $delete = 'yes', + $auth_url = 'http://localhost:8080/auth/v1.0', + $swift_user = 'test:tester', + $swift_key = 'testing', + $auth_version = '1.0', + Swift::LogLevel $log_level = 'INFO', + $test_timeout = '10', + $put_concurrency = '10', + $get_concurrency = '10', + $del_concurrency = '10', + $lower_object_size = '10', + $upper_object_size = '10', + $object_size = '1', + $num_objects = '1000', + $num_gets = '10000', + $num_containers = '20', + $delete = 'yes', ) { include swift::deps diff --git a/manifests/containerreconciler.pp b/manifests/containerreconciler.pp index 6ed70491..ec6a00a5 100644 --- a/manifests/containerreconciler.pp +++ b/manifests/containerreconciler.pp @@ -129,10 +129,10 @@ class swift::containerreconciler ( $cache_tls_cafile = $facts['os_service_default'], $cache_tls_certfile = $facts['os_service_default'], $cache_tls_keyfile = $facts['os_service_default'], - $log_name = 'container-reconciler', - $log_level = 'INFO', - $log_facility = 'LOG_LOCAL2', - $log_address = '/dev/log', + String[1] $log_name = 'container-reconciler', + Swift::LogLevel $log_level = 'INFO', + Swift::LogFacility $log_facility = 'LOG_LOCAL2', + String[1] $log_address = '/dev/log', $log_max_line_length = $facts['os_service_default'], Boolean $purge_config = false, ) inherits swift::params { diff --git a/manifests/objectexpirer.pp b/manifests/objectexpirer.pp index dc8731cb..4cfdeabb 100644 --- a/manifests/objectexpirer.pp +++ b/manifests/objectexpirer.pp @@ -149,10 +149,10 @@ class swift::objectexpirer ( $cache_tls_cafile = $facts['os_service_default'], $cache_tls_certfile = $facts['os_service_default'], $cache_tls_keyfile = $facts['os_service_default'], - $log_name = 'object-expirer', - $log_level = 'INFO', - $log_facility = 'LOG_LOCAL2', - $log_address = '/dev/log', + String[1] $log_name = 'object-expirer', + Swift::LogLevel $log_level = 'INFO', + Swift::LogFacility $log_facility = 'LOG_LOCAL2', + String[1] $log_address = '/dev/log', $log_max_line_length = $facts['os_service_default'], Boolean $purge_config = false, # DEPRECATED PARAMETERS diff --git a/manifests/proxy.pp b/manifests/proxy.pp index 4291e882..a33f782a 100644 --- a/manifests/proxy.pp +++ b/manifests/proxy.pp @@ -220,11 +220,11 @@ class swift::proxy ( $log_headers = $facts['os_service_default'], $log_udp_host = $facts['os_service_default'], $log_udp_port = $facts['os_service_default'], - $log_address = '/dev/log', - $log_level = 'INFO', - $log_facility = 'LOG_LOCAL2', + String[1] $log_address = '/dev/log', + Swift::LogLevel $log_level = 'INFO', + Swift::LogFacility $log_facility = 'LOG_LOCAL2', $log_handoffs = $facts['os_service_default'], - $log_name = 'proxy-server', + String[1] $log_name = 'proxy-server', $log_max_line_length = $facts['os_service_default'], $cors_allow_origin = $facts['os_service_default'], $strict_cors_mode = $facts['os_service_default'], diff --git a/manifests/proxy/cname_lookup.pp b/manifests/proxy/cname_lookup.pp index c9447a54..ef2f8993 100644 --- a/manifests/proxy/cname_lookup.pp +++ b/manifests/proxy/cname_lookup.pp @@ -43,25 +43,34 @@ # # class swift::proxy::cname_lookup ( - $log_name = $facts['os_service_default'], - $log_facility = $facts['os_service_default'], - $log_level = $facts['os_service_default'], - $log_headers = $facts['os_service_default'], - $log_address = $facts['os_service_default'], - $storage_domain = $facts['os_service_default'], - $lookup_depth = $facts['os_service_default'], - $nameservers = $facts['os_service_default'], + $log_name = $facts['os_service_default'], + Optional[Swift::LogFacility] $log_facility = undef, + Optional[Swift::LogLevel] $log_level = undef, + $log_headers = $facts['os_service_default'], + $log_address = $facts['os_service_default'], + $storage_domain = $facts['os_service_default'], + $lookup_depth = $facts['os_service_default'], + $nameservers = $facts['os_service_default'], ) { include swift::deps include swift::params Package['python3-dnspython'] ~> Service<| tag == 'swift-proxy-service' |> + $log_facility_real = $log_facility ? { + undef => $facts['os_service_default'], + default => $log_facility, + } + $log_level_real = $log_level ? { + undef => $facts['os_service_default'], + default => $log_level, + } + swift_proxy_config { 'filter:cname_lookup/use': value => 'egg:swift#cname_lookup'; 'filter:cname_lookup/set log_name': value => $log_name; - 'filter:cname_lookup/set log_facility': value => $log_facility; - 'filter:cname_lookup/set log_level': value => $log_level; + 'filter:cname_lookup/set log_facility': value => $log_facility_real; + 'filter:cname_lookup/set log_level': value => $log_level_real; 'filter:cname_lookup/set log_headers': value => $log_headers; 'filter:cname_lookup/set log_address': value => $log_address; 'filter:cname_lookup/storage_domain' : value => $storage_domain; diff --git a/manifests/proxy/domain_remap.pp b/manifests/proxy/domain_remap.pp index a74ef9e9..ca0fe95a 100644 --- a/manifests/proxy/domain_remap.pp +++ b/manifests/proxy/domain_remap.pp @@ -68,26 +68,35 @@ # # class swift::proxy::domain_remap ( - $log_name = $facts['os_service_default'], - $log_facility = $facts['os_service_default'], - $log_level = $facts['os_service_default'], - $log_headers = $facts['os_service_default'], - $log_address = $facts['os_service_default'], - $storage_domain = $facts['os_service_default'], - $path_root = $facts['os_service_default'], - $reseller_prefixes = $facts['os_service_default'], - $default_reseller_prefix = $facts['os_service_default'], - $mangle_client_paths = $facts['os_service_default'], + $log_name = $facts['os_service_default'], + Optional[Swift::LogFacility] $log_facility = undef, + Optional[Swift::LogLevel] $log_level = undef, + $log_headers = $facts['os_service_default'], + $log_address = $facts['os_service_default'], + $storage_domain = $facts['os_service_default'], + $path_root = $facts['os_service_default'], + $reseller_prefixes = $facts['os_service_default'], + $default_reseller_prefix = $facts['os_service_default'], + $mangle_client_paths = $facts['os_service_default'], ) { include swift::deps $reseller_prefixes_real = join(any2array($reseller_prefixes), ',') + $log_facility_real = $log_facility ? { + undef => $facts['os_service_default'], + default => $log_facility, + } + $log_level_real = $log_level ? { + undef => $facts['os_service_default'], + default => $log_level, + } + swift_proxy_config { 'filter:domain_remap/use': value => 'egg:swift#domain_remap'; 'filter:domain_remap/set log_name': value => $log_name; - 'filter:domain_remap/set log_facility': value => $log_facility; - 'filter:domain_remap/set log_level': value => $log_level; + 'filter:domain_remap/set log_facility': value => $log_facility_real; + 'filter:domain_remap/set log_level': value => $log_level_real; 'filter:domain_remap/set log_headers': value => $log_headers; 'filter:domain_remap/set log_address': value => $log_address; 'filter:domain_remap/storage_domain' : value => $storage_domain; diff --git a/manifests/proxy/gatekeeper.pp b/manifests/proxy/gatekeeper.pp index ca24391b..ca91f324 100644 --- a/manifests/proxy/gatekeeper.pp +++ b/manifests/proxy/gatekeeper.pp @@ -46,13 +46,13 @@ # Copyright 2014 UnitedStack licensing@unitedstack.com # class swift::proxy::gatekeeper ( - $shunt_inbound_x_timestamp = $facts['os_service_default'], - $allow_reserved_names_header = $facts['os_service_default'], - $log_name = 'gatekeeper', - $log_facility = 'LOG_LOCAL2', - $log_level = 'INFO', - $log_headers = $facts['os_service_default'], - $log_address = '/dev/log' + $shunt_inbound_x_timestamp = $facts['os_service_default'], + $allow_reserved_names_header = $facts['os_service_default'], + $log_name = 'gatekeeper', + Swift::LogFacility $log_facility = 'LOG_LOCAL2', + Swift::LogLevel $log_level = 'INFO', + $log_headers = $facts['os_service_default'], + $log_address = '/dev/log' ) { include swift::deps diff --git a/manifests/storage/all.pp b/manifests/storage/all.pp index 6aba9cb9..07db34c0 100644 --- a/manifests/storage/all.pp +++ b/manifests/storage/all.pp @@ -142,39 +142,39 @@ # class swift::storage::all ( $storage_local_net_ip, - $devices = '/srv/node', - $object_port = 6000, - $container_port = 6001, - $account_port = 6002, - $object_pipeline = undef, - $container_pipeline = undef, - $account_pipeline = undef, - $mount_check = true, - $log_facility = 'LOG_LOCAL2', - $log_level = 'INFO', - Boolean $log_name_per_daemon = false, - $log_udp_host = undef, - $log_udp_port = undef, - $log_requests = true, - $max_connections = 25, - $hosts_allow = undef, - $hosts_deny = undef, - $incoming_chmod = 'Du=rwx,g=rx,o=rx,Fu=rw,g=r,o=r', - $outgoing_chmod = 'Du=rwx,g=rx,o=rx,Fu=rw,g=r,o=r', - $statsd_enabled = false, - $log_statsd_host = 'localhost', - $log_statsd_port = $facts['os_service_default'], - $log_statsd_default_sample_rate = $facts['os_service_default'], - $log_statsd_sample_rate_factor = $facts['os_service_default'], - $log_statsd_metric_prefix = $facts['os_service_default'], - $account_server_workers = $facts['os_workers'], - $container_server_workers = $facts['os_workers'], - $object_server_workers = $facts['os_workers'], - $object_server_mb_per_sync = $facts['os_service_default'], - $rsync_timeout = $facts['os_service_default'], - $rsync_bwlimit = $facts['os_service_default'], - $splice = false, - $rsync_use_xinetd = $swift::params::xinetd_available, + $devices = '/srv/node', + $object_port = 6000, + $container_port = 6001, + $account_port = 6002, + $object_pipeline = undef, + $container_pipeline = undef, + $account_pipeline = undef, + $mount_check = true, + Swift::LogFacility $log_facility = 'LOG_LOCAL2', + Swift::LogLevel $log_level = 'INFO', + Boolean $log_name_per_daemon = false, + $log_udp_host = undef, + $log_udp_port = undef, + $log_requests = true, + $max_connections = 25, + $hosts_allow = undef, + $hosts_deny = undef, + $incoming_chmod = 'Du=rwx,g=rx,o=rx,Fu=rw,g=r,o=r', + $outgoing_chmod = 'Du=rwx,g=rx,o=rx,Fu=rw,g=r,o=r', + $statsd_enabled = false, + $log_statsd_host = 'localhost', + $log_statsd_port = $facts['os_service_default'], + $log_statsd_default_sample_rate = $facts['os_service_default'], + $log_statsd_sample_rate_factor = $facts['os_service_default'], + $log_statsd_metric_prefix = $facts['os_service_default'], + $account_server_workers = $facts['os_workers'], + $container_server_workers = $facts['os_workers'], + $object_server_workers = $facts['os_workers'], + $object_server_mb_per_sync = $facts['os_service_default'], + $rsync_timeout = $facts['os_service_default'], + $rsync_bwlimit = $facts['os_service_default'], + $splice = false, + $rsync_use_xinetd = $swift::params::xinetd_available, ) inherits swift::params { include swift::deps diff --git a/manifests/storage/drive_audit.pp b/manifests/storage/drive_audit.pp index 66ec5ee6..43bcbd09 100644 --- a/manifests/storage/drive_audit.pp +++ b/manifests/storage/drive_audit.pp @@ -110,10 +110,10 @@ class swift::storage::drive_audit ( $weekday = '*', Integer[0] $maxdelay = 0, # drive-audit.conf options - $log_facility = 'LOG_LOCAL2', - $log_level = 'INFO', - $log_address = '/dev/log', - $log_name = 'drive-audit', + Swift::LogFacility $log_facility = 'LOG_LOCAL2', + Swift::LogLevel $log_level = 'INFO', + String[1] $log_address = '/dev/log', + String[1] $log_name = 'drive-audit', $log_udp_host = $facts['os_service_default'], $log_udp_port = $facts['os_service_default'], $log_max_line_length = $facts['os_service_default'], diff --git a/manifests/storage/server.pp b/manifests/storage/server.pp index 1dbe51e5..672efca7 100644 --- a/manifests/storage/server.pp +++ b/manifests/storage/server.pp @@ -329,10 +329,10 @@ define swift::storage::server ( $reaper_interval = $facts['os_service_default'], $reaper_conn_timeout = $facts['os_service_default'], $reaper_node_timeout = $facts['os_service_default'], - $log_facility = 'LOG_LOCAL2', - $log_level = 'INFO', - $log_address = '/dev/log', - $log_name = "${type}-server", + Swift::LogFacility $log_facility = 'LOG_LOCAL2', + Swift::LogLevel $log_level = 'INFO', + String[1] $log_address = '/dev/log', + String[1] $log_name = "${type}-server", Boolean $log_name_per_daemon = false, $log_udp_host = $facts['os_service_default'], $log_udp_port = $facts['os_service_default'], diff --git a/spec/classes/swift_proxy_cname_lookup_spec.rb b/spec/classes/swift_proxy_cname_lookup_spec.rb index 12159235..4d6ea0a5 100644 --- a/spec/classes/swift_proxy_cname_lookup_spec.rb +++ b/spec/classes/swift_proxy_cname_lookup_spec.rb @@ -23,7 +23,7 @@ describe 'swift::proxy::cname_lookup' do { :log_name => 'newcname_lookup', :log_facility => 'LOG_LOCAL3', - :log_level => 'WARN', + :log_level => 'WARNING', :log_headers => 'True', :log_address => '/var/log', :storage_domain => 'example.com', @@ -34,7 +34,7 @@ describe 'swift::proxy::cname_lookup' do it { is_expected.to contain_swift_proxy_config('filter:cname_lookup/set log_name').with_value('newcname_lookup') } it { is_expected.to contain_swift_proxy_config('filter:cname_lookup/set log_facility').with_value('LOG_LOCAL3') } - it { is_expected.to contain_swift_proxy_config('filter:cname_lookup/set log_level').with_value('WARN') } + it { is_expected.to contain_swift_proxy_config('filter:cname_lookup/set log_level').with_value('WARNING') } it { is_expected.to contain_swift_proxy_config('filter:cname_lookup/set log_headers').with_value('True') } it { is_expected.to contain_swift_proxy_config('filter:cname_lookup/set log_address').with_value('/var/log') } it { is_expected.to contain_swift_proxy_config('filter:cname_lookup/storage_domain').with_value('example.com') } diff --git a/spec/classes/swift_proxy_domain_remap_spec.rb b/spec/classes/swift_proxy_domain_remap_spec.rb index abc8b18c..7d41121b 100644 --- a/spec/classes/swift_proxy_domain_remap_spec.rb +++ b/spec/classes/swift_proxy_domain_remap_spec.rb @@ -21,7 +21,7 @@ describe 'swift::proxy::domain_remap' do { :log_name => 'newdomain_remap', :log_facility => 'LOG_LOCAL3', - :log_level => 'WARN', + :log_level => 'WARNING', :log_headers => 'True', :log_address => '/var/log', :storage_domain => 'example.com', @@ -34,7 +34,7 @@ describe 'swift::proxy::domain_remap' do it { is_expected.to contain_swift_proxy_config('filter:domain_remap/set log_name').with_value('newdomain_remap') } it { is_expected.to contain_swift_proxy_config('filter:domain_remap/set log_facility').with_value('LOG_LOCAL3') } - it { is_expected.to contain_swift_proxy_config('filter:domain_remap/set log_level').with_value('WARN') } + it { is_expected.to contain_swift_proxy_config('filter:domain_remap/set log_level').with_value('WARNING') } it { is_expected.to contain_swift_proxy_config('filter:domain_remap/set log_headers').with_value('True') } it { is_expected.to contain_swift_proxy_config('filter:domain_remap/set log_address').with_value('/var/log') } it { is_expected.to contain_swift_proxy_config('filter:domain_remap/storage_domain').with_value('example.com') } diff --git a/spec/classes/swift_proxy_gatekeeper_spec.rb b/spec/classes/swift_proxy_gatekeeper_spec.rb index ccb3ab99..166242f2 100644 --- a/spec/classes/swift_proxy_gatekeeper_spec.rb +++ b/spec/classes/swift_proxy_gatekeeper_spec.rb @@ -21,7 +21,7 @@ describe 'swift::proxy::gatekeeper' do :log_name => 'newgatekeeper', :log_headers => false, :log_facility => 'LOG_LOCAL3', - :log_level => 'WARN', + :log_level => 'WARNING', } end @@ -29,7 +29,7 @@ describe 'swift::proxy::gatekeeper' do it { is_expected.to contain_swift_proxy_config('filter:gatekeeper/allow_reserved_names_header').with_value(false) } it { is_expected.to contain_swift_proxy_config('filter:gatekeeper/set log_name').with_value('newgatekeeper') } it { is_expected.to contain_swift_proxy_config('filter:gatekeeper/set log_facility').with_value('LOG_LOCAL3') } - it { is_expected.to contain_swift_proxy_config('filter:gatekeeper/set log_level').with_value('WARN') } + it { is_expected.to contain_swift_proxy_config('filter:gatekeeper/set log_level').with_value('WARNING') } it { is_expected.to contain_swift_proxy_config('filter:gatekeeper/set log_headers').with_value(false) } end end diff --git a/types/logfacility.pp b/types/logfacility.pp new file mode 100644 index 00000000..9f2600a4 --- /dev/null +++ b/types/logfacility.pp @@ -0,0 +1,10 @@ +type Swift::Logfacility = Enum[ + 'LOG_LOCAL0', + 'LOG_LOCAL1', + 'LOG_LOCAL2', + 'LOG_LOCAL3', + 'LOG_LOCAL4', + 'LOG_LOCAL5', + 'LOG_LOCAL6', + 'LOG_LOCAL7', +] diff --git a/types/loglevel.pp b/types/loglevel.pp new file mode 100644 index 00000000..9e2f93ff --- /dev/null +++ b/types/loglevel.pp @@ -0,0 +1,9 @@ +type Swift::LogLevel = Enum[ + 'DEBUG', + 'INFO', + 'WARNING', + 'WARN', + 'ERROR', + 'CRITICAL', + 'FATAL', +]