diff --git a/doc/source/admin/shared-file-systems-crud-share.rst b/doc/source/admin/shared-file-systems-crud-share.rst index 05d205645c..2f0039d024 100644 --- a/doc/source/admin/shared-file-systems-crud-share.rst +++ b/doc/source/admin/shared-file-systems-crud-share.rst @@ -507,6 +507,10 @@ You also can unset the metadata using only metadata configuration option listed in the :ref:`additional configuration options page `. + 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 `. Reset share state ----------------- diff --git a/doc/source/configuration/tables/manila-common.inc b/doc/source/configuration/tables/manila-common.inc index c13019caf4..41d9e32bbf 100644 --- a/doc/source/configuration/tables/manila-common.inc +++ b/doc/source/configuration/tables/manila-common.inc @@ -110,6 +110,10 @@ - (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy. * - ``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. + * - ``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]** - * - ``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. * - ``path`` = ``/healthcheck`` - (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.