openstack/manila
Code Issues Proposed changes

Deprecate [DEFAULT]/share_usage_size_audit_period

Browse Source 
This option is unused and is likely going to confuse
deployers, especially when using the share usage size
tracking feature with a similarly named option
(share_usage_size_update_interval) [1].

We can remove this option in the Train release.

Closes-Bug: #1813054
[1] https://review.openstack.org/#/c/465055/

Change-Id: Id4585fa887e5bdfd5743dad2c490392ba0401061
This commit is contained in:
Goutham Pacha Ravi 2019-01-23 11:28:51 -08:00
parent 49afbfc0fc
commit 0f627aa6cf
3 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/configuration/tables/manila-share.inc
View File

@ -64,8 +64,6 @@
- (String) Template string to be used to generate share snapshot names. - (String) Template string to be used to generate share snapshot names.
* - ``share_topic`` = ``manila-share`` * - ``share_topic`` = ``manila-share``
- (String) The topic share nodes listen on. - (String) The topic share nodes listen on.
* - ``share_usage_audit_period`` = ``month``
- (String) Time period to generate share usages for. Time period must be hour, day, month or year.
* - ``suppress_post_hooks_errors`` = ``False`` * - ``suppress_post_hooks_errors`` = ``False``
- (Boolean) Whether to suppress post hook errors (allow driver's results to pass through) or not. - (Boolean) Whether to suppress post hook errors (allow driver's results to pass through) or not.
* - ``suppress_pre_hooks_errors`` = ``False`` * - ``suppress_pre_hooks_errors`` = ``False``

4
manila/common/config.py
View File

@ -104,8 +104,10 @@ global_opts = [
help='Memcached servers or None for in process cache.'), help='Memcached servers or None for in process cache.'),
cfg.StrOpt('share_usage_audit_period', cfg.StrOpt('share_usage_audit_period',
default='month', default='month',
deprecated_for_removal=True,
help='Time period to generate share usages for. ' help='Time period to generate share usages for. '
'Time period must be hour, day, month or year.'), 'Time period must be hour, day, month or year.',
deprecated_reason="The config option is not used."),
cfg.StrOpt('rootwrap_config', cfg.StrOpt('rootwrap_config',
help='Path to the rootwrap configuration file to use for ' help='Path to the rootwrap configuration file to use for '
'running commands as root.'), 'running commands as root.'),

12
releasenotes/notes/bug-1813054-remove-share-usage-size-audit-period-conf-opt-7331013d1cdb7b43.yaml Normal file
View File

@ -0,0 +1,12 @@
---
deprecations:
- |
The configuration option ``share_usage_audit_period`` from the
[DEFAULT] section has been deprecated. Specifying this option
never had any effect on manila and so it will be removed in an
upcoming release. This option should not be confused
with ``share_usage_size_update_interval`` from the back end
section, which can be used to gather usage size for some back ends
that support that feature.