Bug 1165904

Summary: object-expirer.conf could file should contain some meaningful explanation for each key in it
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: SATHEESARAN <sasundar>
Component: gluster-swiftAssignee: Prashanth Pai <ppai>
Status: CLOSED ERRATA QA Contact: SATHEESARAN <sasundar>
Severity: high Docs Contact:
Priority: high    
Version: rhgs-3.0CC: asrivast, divya, nlevinki, ppai, rhs-bugs, surs
Target Milestone: ---Keywords: ZStream
Target Release: RHGS 3.0.3   
Hardware: x86_64   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
The Object Expiration feature is now supported in Object Storage. This feature allows you to schedule deletion of objects that are stored in the Red Hat Storage volume. You can use the Object expiration feature to specify a lifetime for objects in the volume. When the lifetime of an object expires, it automatically stops serving that object and shortly thereafter removes the object from the Red Hat Storage volume.
Story Points: ---
Clone Of: Environment:
Last Closed: 2015-01-15 13:47:55 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1162694    

Description SATHEESARAN 2014-11-20 02:03:58 UTC
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:

Comment 1 SATHEESARAN 2014-11-20 02:05:43 UTC
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

Comment 2 Prashanth Pai 2014-11-20 06:39:12 UTC
Upstream patch here for reference: https://review.openstack.org/135861

Comment 3 SATHEESARAN 2014-12-09 11:03:32 UTC
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

Comment 4 Divya 2015-01-08 11:18:00 UTC
Prashanth,

Please review the edited doc text and sign-off.

Comment 5 Prashanth Pai 2015-01-08 11:34:40 UTC
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.

Comment 7 errata-xmlrpc 2015-01-15 13:47:55 UTC
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