api-ref: fix hypervisor_hostname description for Ironic

The hypervisor_hostname shown in the os-hypervisors and servers
APIs is actually the Ironic node uuid, not a name. This comes
from the Ironic virt driver _node_resource method which eventually
gets used in the resource tracker to set the ComputeNode
hypervisor_hostname field, which is used to also set the instance.node
value in the ResourceTracker later during the instance claim.

The confusion probably lies in the fact that the variable passed
around the code is also referred to as "nodename", but in the case
of Ironic it's not actually a hostname, it's a uuid.

Change-Id: Ic639abe9989b282bad71581bb861314619c0f48b
Closes-Bug: #1698000
This commit is contained in:
Matt Riedemann 2017-06-15 14:20:15 -04:00
parent df5b135053
commit b541f71d0f
1 changed files with 2 additions and 2 deletions

View File

@ -2782,7 +2782,7 @@ hypervisor_free_disk_gb:
hypervisor_hostname:
description: |
The hypervisor host name provided by the Nova virt driver. For the Ironic driver,
it is the Ironic node name.
it is the Ironic node uuid.
in: body
required: true
type: string
@ -3845,7 +3845,7 @@ OS-EXT-SRV-ATTR:host:
OS-EXT-SRV-ATTR:hypervisor_hostname:
description: |
The hypervisor host name provided by the Nova virt driver. For the Ironic driver,
it is the Ironic node name. Appears in the response for administrative users only.
it is the Ironic node uuid. Appears in the response for administrative users only.
in: body
required: true
type: string