From 832712f2dc379868ad16916b05a12ac0f9986c5a Mon Sep 17 00:00:00 2001 From: zengyingzhe Date: Mon, 12 Sep 2016 15:31:20 +0800 Subject: [PATCH] Fix dedup/compression description in doc In the capabilities section of capabilities_and_extra_specs.rst, the description of dedupe and compression all say that drivers cannot report to the scheduler both support and non-support, like [True, False]. But since Mitaka, this kind of specifying is allowed. So change the doc contents to fit the actual logic. Change-Id: Ie871abc49bd1bc58566111f85d89228046865b5c Closes-Bug: #1621707 --- .../devref/capabilities_and_extra_specs.rst | 30 +++++++++++-------- 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/doc/source/devref/capabilities_and_extra_specs.rst b/doc/source/devref/capabilities_and_extra_specs.rst index b9da0c0915..32bb38068f 100644 --- a/doc/source/devref/capabilities_and_extra_specs.rst +++ b/doc/source/devref/capabilities_and_extra_specs.rst @@ -93,21 +93,27 @@ be created. * `dedupe` - indicates that a backend/pool can provide shares using some deduplication technology. The default value of the dedupe capability (if a - driver doesn't report it) is False. Drivers cannot report to the scheduler - that they support both dedupe and non-deduped share. For each pool it's - either always on or always off. Administrators can make a share type use - deduplication by setting this extra-spec to ' True'. Administrators can - prevent a share type from using deduplication by setting this extra-spec to - ' False'. Added in Liberty. + driver doesn't report it) is False. In Liberty, drivers cannot report to the + scheduler that they support both dedupe and non-deduped share. For each pool + it's either always on or always off, even if the drivers can technically + support both dedupe and non-deduped in a pool. Since Mitaka, the logic is + changed to allow a driver to report dedupe=[True, False] if it can support + both dedupe and non-deduped in a pool. Administrators can make a share type + use deduplication by setting this extra-spec to ' True'. Administrators + can prevent a share type from using deduplication by setting this extra-spec + to ' False'. Added in Liberty. * `compression` - indicates that a backend/pool can provide shares using some compression technology. The default value of the compression capability (if a - driver doesn't report it) is False. Drivers cannot report to the scheduler - that they support both compression and non-compression. For each pool it's - either always on or always off. Administrators can make a share type use - compression by setting this extra-spec to ' True'. Administrators can - prevent a share type from using compression by setting this extra-spec to - ' False'. Added in Liberty. + driver doesn't report it) is False. In Liberty, drivers cannot report to the + scheduler that they support both compression and non-compression. For each + pool it's either always on or always off, even if the drivers can technically + support both compression and non-compression in a pool. Since Mitaka, the + logic is changed to allow a driver to report compression=[True, False] if it + can support both compression and non-compression in a pool. Administrators + can make a share type use compression by setting this extra-spec to + ' True'. Administrators can prevent a share type from using compression + by setting this extra-spec to ' False'. Added in Liberty. * `thin_provisioning` - shares will not be space guaranteed and overprovisioning will be enabled. This capability defaults to False.