diff --git a/doc/config-ref-rst/source/shared-file-systems/drivers/hpe-3par-share-driver.rst b/doc/config-ref-rst/source/shared-file-systems/drivers/hpe-3par-share-driver.rst index 6715f3d4fd..aeb79037bf 100644 --- a/doc/config-ref-rst/source/shared-file-systems/drivers/hpe-3par-share-driver.rst +++ b/doc/config-ref-rst/source/shared-file-systems/drivers/hpe-3par-share-driver.rst @@ -154,80 +154,84 @@ an administrator to control which share types are allowed to use FPGs with or without specific capabilities. The following extra-specs are used with the capabilities filter and the HPE 3PAR driver: -- hpe3par_flash_cache = ' True' or ' False' +``hpe3par_flash_cache`` + This is ``True`` for back ends that have 3PAR's + Adaptive Flash Cache enabled. -- thin_provisioning = ' True' or ' False' +``thin_provisioning`` + This is ``True`` for back ends that use thin provisioned volumes. + For FPGs that use fully provisioned volumes this is ``False``. + Back ends that use thin provisioning also support the Shared File + Systems service's over-subscription feature. -- dedupe = ' True' or ' False' +``dedupe`` + This is ``True`` for back ends that use deduplication technology. -hpe3par_flash_cache will be reported as True for back ends that have -3PAR's Adaptive Flash Cache enabled. - -thin_provisioning will be reported as True for back ends that use thin -provisioned volumes. FPGs that use fully provisioned volumes will report -False. Backends that use thin provisioning also support the Shared File -Systems service's over-subscription feature. - -dedupe will be reported as True for back ends that use deduplication -technology. +Each can either be `` True`` or `` False``. Scoped extra-specs are used to influence vendor-specific implementation details. Scoped extra-specs use a prefix followed by a colon. For HPE -3PAR these extra-specs have a prefix of hpe3par. +3PAR these extra-specs have a prefix of ``hpe3par``. The following HPE 3PAR extra-specs are used when creating CIFS (SMB) shares: -- hpe3par:smb_access_based_enum = true or false +``hpe3par:smb_access_based_enum`` + Valid values are ``true`` or ``false``. -- hpe3par:smb_continuous_avail = true or false + This handles access-based enumeration and specifies if users + can see only the files and directories to which they have been allowed + access on the shares. The default is ``false``. -- hpe3par:smb_cache = off, manual, optimized or auto +``hpe3par:smb_continuous_avail`` + Valid values are ``true`` or ``false``. -smb_access_based_enum (Access Based Enumeration) specifies if users -can see only the files and directories to which they have been allowed -access on the shares. The default is false. + This handles continuous availability and specifies if SMB3 + continuous availability features should be enabled for this share. + If not specified, the default is ``true``. -smb_continuous_avail (Continuous Availability) specifies if SMB3 -continuous availability features should be enabled for this share. If -not specified, the default is true. +``hpe3par:smb_cache`` + This specifies client-side caching for offline files. Valid values + are: -smb_cache specifies client-side caching for offline files. Valid values -are: + ``off`` + The client must not cache any files from this share. The share is + configured to disallow caching. -- \`off\`: The client must not cache any files from this share. The - share is configured to disallow caching. + ``manual`` + The client must allow only manual caching for the files open from + this share. This is the default. -- \`manual\`: The client must allow only manual caching for the files - open from this share. + ``optimized`` + The client may cache every file that it opens from this share. + Also, the client may satisfy the file requests from its local + cache. The share is configured to allow automatic caching of + programs and documents. -- \`optimized\`: The client may cache every file that it opens from - this share. Also, the client may satisfy the file requests from its - local cache. The share is configured to allow automatic caching of - programs and documents. - -- \`auto\`: The client may cache every file that it opens from this - share. The share is configured to allow automatic caching of - documents. - -- If this is not specified, the default is manual. + ``auto`` + The client may cache every file that it opens from this share. The + share is configured to allow automatic caching of documents. The following HPE 3PAR extra-specs are used when creating NFS shares: -- hpe3par:nfs_options = Comma separated list of NFS export options. +``hpe3par:nfs_options`` + This is a comma-separated list of NFS export options. -The NFS export options have the following limitations: + The NFS export options have the following limitations: -- ro and rw are not allowed (will be determined by the driver). + - ``ro`` and ``rw`` are not allowed because the value will be determined + by the driver. -- no_subtree_check and fsid are not allowed per HPE 3PAR CLI support. + - ``no_subtree_check`` and ``fsid`` are not allowed per HPE 3PAR CLI + support. -- (in)secure and (no\_)root_squash are not allowed because the HPE - 3PAR driver controls those settings. + - ``secure``, ``insecure``, ``root_squash``, and ``no_root_squash`` + are not allowed because the HPE 3PAR driver controls those + settings. -All other NFS options are forwarded to the HPE 3PAR as part of share -creation. The HPE 3PAR will do additional validation at share creation -time. Refer to HPE 3PAR CLI help for more details. + All other NFS options are forwarded to the HPE 3PAR as part of share + creation. The HPE 3PAR will do additional validation at share + creation time. Refer to the HPE 3PAR CLI help for more details. Driver options ~~~~~~~~~~~~~~