diff --git a/install-guide/source/include/root-device-hints.rst b/install-guide/source/include/root-device-hints.rst index 879371abaf..672bdfb830 100644 --- a/install-guide/source/include/root-device-hints.rst +++ b/install-guide/source/include/root-device-hints.rst @@ -47,5 +47,45 @@ That will guarantee that Bare Metal service will pick the disk device that has the ``wwn`` equal to the specified wwn value, or fail the deployment if it can not be found. +The hints can have an operator at the beginning of the value string. If +no operator is specified the default is ``==`` (for numerical values) +and ``s==`` (for string values). The supported operators are: + +* For numerical values: + + * ``=`` equal to or greater than. This is equivalent to ``>=`` and is + supported for `legacy reasons `_ + * ``==`` equal to + * ``!=`` not equal to + * ``>=`` greater than or equal to + * ``>`` greater than + * ``<=`` less than or equal to + * ``<`` less than + +* For strings (as python comparisons): + + * ``s==`` equal to + * ``s!=`` not equal to + * ``s>=`` greater than or equal to + * ``s>`` greater than + * ``s<=`` less than or equal to + * ``s<`` less than + * ```` substring + +* For collections: + + * ```` all elements contained in collection + * ```` find one of these + +Examples are: + +* Finding a disk larger or equal to 60 GiB and non-rotational (SSD):: + + ironic node-update add properties/root_device='{"size": ">= 60", "rotational": false}' + +* Finding a disk whose vendor is ``samsung`` or ``winsys``:: + + ironic node-update add properties/root_device='{"vendor": " samsung winsys"}' + .. note:: If multiple hints are specified, a device must satisfy all the hints. diff --git a/releasenotes/notes/support-root-device-hints-with-operators-96cf34fa37b5b2e8.yaml b/releasenotes/notes/support-root-device-hints-with-operators-96cf34fa37b5b2e8.yaml index 56ee861714..7500e36bfd 100644 --- a/releasenotes/notes/support-root-device-hints-with-operators-96cf34fa37b5b2e8.yaml +++ b/releasenotes/notes/support-root-device-hints-with-operators-96cf34fa37b5b2e8.yaml @@ -1,6 +1,7 @@ --- features: - Adds support for using operators with the root device hints mechanism. - The currently supported operators are, ``=``, ``==``, ``!=``, ``>=``, - ``<=``, ``>``, ``<``, ``s==``, ``s!=``, ``s>=``, ``s>``, ``s<=``, - ``s<``, ````, ```` and ````. + The supported operators are, ``=``, ``==``, ``!=``, ``>=``, + ``<=``, ``>``, ``<``, ``s==``, ``s!=``, ``s>=``, ``s>``, + ``s<=``, ``s<``, ````, ```` and ````. See + http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#specifying-the-disk-for-deployment-root-device-hints