Red Hat Bugzilla – Bug 1165904
object-expirer.conf could file should contain some meaningful explanation for each key in it
Last modified: 2015-05-13 13:41:42 EDT
Description of problem: ----------------------- This configuration file, /etc/swift/object-expirer.conf doesn't explains about few of its keys. There should be little explanation or hint about that key, so that user can understand and later customize it, when required Version-Release number of selected component (if applicable): ------------------------------------------------------------- RHS 3.0.3 openstack-swift-{proxy,account,container,object}-1.13.1-2.el6ost.noarch.rpm swiftonfile-1.13.1-0.el6rhs Steps to Reproduce: -------------------- 1. Contents of /etc/swift/ Actual results: --------------- Few of the keys (interval, auto_create_account_prefix,expiring_objects_account_name) in the file /etc/swift/object-expirer.conf are not explained Expected results: ----------------- keys (interval, auto_create_account_prefix,expiring_objects_account_name) in the file /etc/swift/object-expirer.conf should be hinted about what it does Additional info:
Also the "TODO" label and its contents, should be removed from the configuration file as it looks little ugly. The contents of /etc/swift/object-expirer.conf, [root@rhss-swift1 ~]# cat /etc/swift/object-expirer.conf #TODO: Add documentation to explain various options #For now, refer: https://github.com/openstack/swift/blob/master/etc/object-expirer.conf-sample [DEFAULT] [object-expirer] user = root log_facility = LOG_LOCAL2 log_level = DEBUG # The following parameters are used by object-expirer and needs to be same # across all conf files! auto_create_account_prefix = gs expiring_objects_account_name = expiring interval = 30 [pipeline:main] pipeline = catch_errors cache proxy-server [app:proxy-server] use = egg:gluster_swift#proxy [filter:cache] use = egg:swift#memcache [filter:catch_errors] use = egg:swift#catch_errors
Upstream patch here for reference: https://review.openstack.org/135861
Verified with glusterfs-3.6.0.36-1.el6rhs. The /etc/swift/object-expirer.conf has meaningful explanation for the users to customize. Thanks Prashanth for adding the required changes. Marking this bug as VERIFIED
Prashanth, Please review the edited doc text and sign-off.
This bug does NOT need a doc text. I don't want it to be mentioned anywhere in the doc either. Object expiration is a new feature for this release. The doc text and bug would only confuse the user/admin/customer. If you were looking for the RFE/FEAT bug tracker for object expiration feature, this is not that one.
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://rhn.redhat.com/errata/RHBA-2015-0038.html