openstack/puppet-swift
Code Issues Proposed changes
puppet-swift/manifests/objectexpirer.pp
Takashi Kajinami b0e59971b8 Set appropriate ownership/permission to config files 
... to avoid making any config files world readable.

Also swift processes do not need write access to these files, thus
write access can be blocked.

Closes-Bug: #2068898
Change-Id: I8b11fbdb0ea0ca814b962dd72b5c1cb4cd201c24
2024-06-11 12:03:47 +09:00

232 lines
8.7 KiB
Puppet
Raw Blame History

# Class swift::objectexpirer
#
# == Parameters
# [*enabled*]
# (optional) Should the service be enabled.
# Defaults to true
#
# [*manage_service*]
# (optional) Whether the service should be managed by Puppet.
# Defaults to true.
#
# [*package_ensure*]
# (optional) Value of package resource parameter 'ensure'.
# Defaults to 'present'.
#
# [*pipeline*]
# (optional) The list of elements of the object expirer pipeline.
# Defaults to ['catch_errors', 'proxy-logging', 'cache', 'proxy-server']
#
# [*concurrency*]
# (optional) Number of replication workers to spawn.
# Defaults to $facts['os_service_default'].
#
# [*expiring_objects_account_name*]
# (optional) Account name used for expiring objects.
# Defaults to $facts['os_service_default'].
#
# [*interval*]
# (optional) Minimum time for a pass to take, in seconds.
# Defaults to $facts['os_service_default'].
#
# [*process*]
# (optional) Which part of the work defined by $processes
# will this instance take.
# Defaults to $facts['os_service_default'].
#
# [*processes*]
# (optional) How many parts to divide the work into, one part per
# process. 0 means a single process will do all work.
# Defaults to $facts['os_service_default'].
#
# [*reclaim_age*]
# (optional) Time elapsed in seconds before an object can be
# reclaimed.
# Defaults to $facts['os_service_default'].
#
# [*recon_cache_path*]
# (optional) Directory where stats for a few items will be stored.
# Defaults to $facts['os_service_default'].
#
# [*report_interval*]
# (optional) Report interval, in seconds.
# Defaults to $facts['os_service_default'].
#
# [*service_provider*]
# (optional)
# To use the swiftinit service provider to manage swift services, set
# service_provider to "swiftinit". When enable is true the provider
# will populate boot files that start swift using swift-init at boot.
# See README for more details.
# Defaults to $::swift::params::service_provider.
#
# [*memcache_servers*]
# (optional)
# A list of the memcache servers to be used. Entries should be in the
# form host:port. This value is only used if 'cache' is added to the
# pipeline, e.g. ['catch_errors', 'proxy-logging', 'cache', 'proxy-server']
# Defaults to ['127.0.0.1:11211']
#
# [*cache_tls_enabled*]
# (Optional) Global toggle for TLS usage when communicating with
# the caching servers.
# Defaults to $facts['os_service_default'].
#
# [*cache_tls_cafile*]
# (Optional) Path to a file of concatenated CA certificates in PEM
# format necessary to establish the caching server's authenticity.
# If tls_enabled is False, this option is ignored.
# Defaults to $facts['os_service_default'].
#
# [*cache_tls_certfile*]
# (Optional) Path to a single file in PEM format containing the
# client's certificate as well as any number of CA certificates
# needed to establish the certificate's authenticity. This file
# is only required when client side authentication is necessary.
# If tls_enabled is False, this option is ignored.
# Defaults to $facts['os_service_default'].
#
# [*cache_tls_keyfile*]
# (Optional) Path to a single file containing the client's private
# key in. Otherwise the private key will be taken from the file
# specified in tls_certfile. If tls_enabled is False, this option
# is ignored.
# Defaults to $facts['os_service_default'].
#
# [*log_name*]
# (optional) Log name.
# Defaults to $facts['os_service_default'].
#
# [*log_level*]
# (optional) Log level.
# Defaults to 'INFO'.
#
# [*log_facility*]
# (optional) Log level
# Defaults to 'LOG_LOCAL2'.
#
# [*purge_config*]
# (optional) Whether to set only the specified config options
# in the object expirer config.
# Defaults to false.
#
class swift::objectexpirer(
Boolean $manage_service = true,
Boolean $enabled = true,
$package_ensure = 'present',
Swift::Pipeline $pipeline = ['catch_errors', 'proxy-logging', 'cache', 'proxy-server'],
$concurrency = $facts['os_service_default'],
$expiring_objects_account_name = $facts['os_service_default'],
$interval = $facts['os_service_default'],
$process = $facts['os_service_default'],
$processes = $facts['os_service_default'],
$reclaim_age = $facts['os_service_default'],
$recon_cache_path = $facts['os_service_default'],
$report_interval = $facts['os_service_default'],
$service_provider = $::swift::params::service_provider,
$memcache_servers = ['127.0.0.1:11211'],
$cache_tls_enabled = $facts['os_service_default'],
$cache_tls_cafile = $facts['os_service_default'],
$cache_tls_certfile = $facts['os_service_default'],
$cache_tls_keyfile = $facts['os_service_default'],
$log_name = $facts['os_service_default'],
$log_level = 'INFO',
$log_facility = 'LOG_LOCAL2',
Boolean $purge_config = false,
) inherits swift::params {
include swift::deps
Swift_object_expirer_config<||> ~> Service['swift-object-expirer']
# On Red Hat platforms, it may be defined already,
# because it is part of openstack-swift-proxy
if $::swift::params::object_expirer_package_name != $::swift::params::proxy_package_name {
package { 'swift-object-expirer':
ensure => $package_ensure,
name => $::swift::params::object_expirer_package_name,
tag => ['openstack', 'swift-package'],
}
}
resources { 'swift_object_expirer_config':
purge => $purge_config,
}
file { '/etc/swift/object-expirer.conf':
ensure => 'file',
owner => 'root',
group => $::swift::params::group,
mode => '0640',
require => Anchor['swift::config::begin'],
before => Anchor['swift::config::end']
}
File['/etc/swift/object-expirer.conf'] -> Swift_object_expirer_config<||>
if $pipeline[-1] != 'proxy-server' {
fail('proxy-server must be the last element in pipeline')
}
# only add memcache servers if 'cache' is included in the pipeline
if !empty(grep(any2array($pipeline), 'cache')) {
swift_object_expirer_config {
'filter:cache/memcache_servers': value => join(any2array($memcache_servers), ',');
'filter:cache/tls_enabled': value => $cache_tls_enabled;
'filter:cache/tls_cafile': value => $cache_tls_cafile;
'filter:cache/tls_certfile': value => $cache_tls_certfile;
'filter:cache/tls_keyfile': value => $cache_tls_keyfile;
}
# require the memcached class if it is on the same machine
if !empty(grep(any2array($memcache_servers), '127.0.0.1')) {
Class['memcached'] -> Class['swift::objectexpirer']
}
} else {
swift_object_expirer_config {
'filter:cache/memcache_servers': ensure => absent;
'filter:cache/tls_enabled': ensure => absent;
'filter:cache/tls_cafile': ensure => absent;
'filter:cache/tls_certfile': ensure => absent;
'filter:cache/tls_keyfile': ensure => absent;
}
}
swift_object_expirer_config {
'app:proxy-server/use': value => 'egg:swift#proxy';
'filter:proxy-logging/use': value => 'egg:swift#proxy_logging';
'filter:catch_errors/use': value => 'egg:swift#catch_errors';
'filter:cache/use': value => 'egg:swift#memcache';
}
swift_object_expirer_config {
'pipeline:main/pipeline': value => join($pipeline, ' ');
'object-expirer/concurrency': value => $concurrency;
'object-expirer/expiring_objects_account_name': value => $expiring_objects_account_name;
'object-expirer/interval': value => $interval;
'object-expirer/process': value => $process;
'object-expirer/processes': value => $processes;
'object-expirer/reclaim_age': value => $reclaim_age;
'object-expirer/recon_cache_path': value => $recon_cache_path;
'object-expirer/report_interval': value => $report_interval;
'object-expirer/log_name': value => $log_name;
'object-expirer/log_facility': value => $log_facility;
'object-expirer/log_level': value => $log_level;
}
if $manage_service {
if $enabled {
$service_ensure = 'running'
} else {
$service_ensure = 'stopped'
}
swift::service { 'swift-object-expirer':
os_family_service_name => $::swift::params::object_expirer_service_name,
service_ensure => $service_ensure,
enabled => $enabled,
config_file_name => 'object-expirer.conf',
service_provider => $service_provider,
}
}
}
View Git Blame Copy Permalink