diff options
author | Mark Goddard <mark@stackhpc.com> | 2018-01-22 11:41:00 +0000 |
---|---|---|
committer | Mark Goddard <mark@stackhpc.com> | 2018-01-30 15:50:55 +0000 |
commit | 00daa18fc99516b0947d2695c030871acff6d6bd (patch) | |
tree | 6062d80fa7935c53635baab525bca5e8fedf0428 /api-ref | |
parent | cd406b977c51cb2637ead8e58f73a8d5fe7f5ea6 (diff) | |
download | ironic-00daa18fc99516b0947d2695c030871acff6d6bd.tar.gz |
Add documentation for node traits
Updates the install and admin guides with information on node traits.
Support for node traits was added in Bare Metal REST API version 1.37.
Change-Id: I86e86320df4eb81aa30e5708dde9c82f50ba4d50
Depends-On: https://review.openstack.org/#/c/532288/
Partial-Bug: #1722194
Diffstat (limited to 'api-ref')
-rw-r--r-- | api-ref/source/baremetal-api-v1-nodes-traits.inc | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/api-ref/source/baremetal-api-v1-nodes-traits.inc b/api-ref/source/baremetal-api-v1-nodes-traits.inc index 5f9811423..ae4b54c54 100644 --- a/api-ref/source/baremetal-api-v1-nodes-traits.inc +++ b/api-ref/source/baremetal-api-v1-nodes-traits.inc @@ -11,6 +11,16 @@ attributes to influence the placement of instances to bare metal compute nodes. Traits specified for a node in the Bare Metal service will be registered on the corresponding resource provider in the Compute service's placement API. +Traits can be either standard or custom. Standard traits are listed in the +`os_traits library <https://docs.openstack.org/os-traits/latest/>`_. Custom +traits must meet the following requirements: + +* prefixed with ``CUSTOM_`` +* contain only upper case characters A to Z, digits 0 to 9, or underscores +* no longer than 255 characters in length + +A bare metal node can have a maximum of 50 traits. + List Traits of a Node ===================== |