openstack/manila
Code Issues Proposed changes

Merge "[doc] Driver updatable metadata" into stable/2024.2

Browse Source
This commit is contained in:
Zuul 2024-10-02 21:47:52 +00:00 committed by Gerrit Code Review
commit 8262b28fff
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/admin/shared-file-systems-crud-share.rst
View File

@ -507,6 +507,10 @@ You also can unset the metadata using
only metadata configuration option listed in the only metadata configuration option listed in the
:ref:`additional configuration options page <manila-common>`. :ref:`additional configuration options page <manila-common>`.
In case you want to pass certain metadata key-values to be consumed by share
drivers, you can provide a list of such keys through the driver updatable
metadata configuration option listed in the
:ref:`additional configuration options page <manila-common>`.
Reset share state Reset share state
----------------- -----------------

6
doc/source/configuration/tables/manila-common.inc
View File

@ -110,6 +110,10 @@
- (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. - (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
* - ``wsgi_keep_alive`` = ``True`` * - ``wsgi_keep_alive`` = ``True``
- (Boolean) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False. - (Boolean) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False.
* - ``admin_only_metadata`` = ``__affinity_same_host,__affinity_different_host``
- (List) The affinity keys are default to ensure backwards compatibility. Update the list with metadata items that should only be manipulated by people allowed by the "update_admin_only_metadata" policy.
* - ``driver_updatable_metadata`` = ``None``
- (List) Metadata keys that will decide which share metadata can be passed to share drivers as part of metadata create/update operations.
* - **[coordination]** * - **[coordination]**
- -
* - ``backend_url`` = ``file://$state_path`` * - ``backend_url`` = ``file://$state_path``
@ -126,5 +130,3 @@
- (List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin. - (List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin.
* - ``path`` = ``/healthcheck`` * - ``path`` = ``/healthcheck``
- (String) DEPRECATED: The path to respond to healtcheck requests on. - (String) DEPRECATED: The path to respond to healtcheck requests on.
* - ``admin_only_metadata`` = ``__affinity_same_host,__affinity_different_host``
- (List) The affinity keys are default to ensure backwards compatibility. Update the list with metadata items that should only be manipulated by people allowed by the "update_admin_only_metadata" policy.