From 7a5acbd7bffafe851eefdac5de3a9397d0d50e63 Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Tue, 12 Jan 2016 16:39:59 +0100 Subject: [PATCH] Clarify that size in root device hints and local_gb are often different We often set local_gb = size - 1, while in root device hints size is expected to be real. Change-Id: Ia1d53fa66870b13bff53324c85cef9731d59f71b --- doc/source/deploy/install-guide.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/source/deploy/install-guide.rst b/doc/source/deploy/install-guide.rst index 6d113e8397..781254abea 100644 --- a/doc/source/deploy/install-guide.rst +++ b/doc/source/deploy/install-guide.rst @@ -1816,6 +1816,14 @@ The list of support hints is: * vendor (STRING): device vendor * serial (STRING): disk serial number * size (INT): size of the device in GiB + + .. note:: + A node's 'local_gb' property is often set to a value 1 GiB less than the + actual disk size to account for partitioning (this is how DevStack, TripleO + and Ironic Inspector work, to name a few). However, in this case ``size`` + should be the actual size. For example, for a 128 GiB disk ``local_gb`` + will be 127, but size hint will be 128. + * wwn (STRING): unique storage identifier * wwn_with_extension (STRING): unique storage identifier with the vendor extension appended * wwn_vendor_extension (STRING): unique vendor storage identifier