Merge "Deprecate [DEFAULT]/share_usage_size_audit_period"

doc/source/configuration/tables/manila-share.inc

@@ -64,8 +64,6 @@
      - (String) Template string to be used to generate share snapshot names.
    * - ``share_topic`` = ``manila-share``
      - (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``
      - (Boolean) Whether to suppress post hook errors (allow driver's results to pass through) or not.
    * - ``suppress_pre_hooks_errors`` = ``False``

manila/common/config.py

@@ -104,8 +104,10 @@ global_opts = [
                 help='Memcached servers or None for in process cache.'),
     cfg.StrOpt('share_usage_audit_period',
                default='month',
+               deprecated_for_removal=True,
                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',
                help='Path to the rootwrap configuration file to use for '
                     'running commands as root.'),

releasenotes/notes/bug-1813054-remove-share-usage-size-audit-period-conf-opt-7331013d1cdb7b43.yaml

@@ -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.
+
+