openstack/ironic
Code Issues Proposed changes

Update validating node information docs

Browse Source 
eg:
    +------------+--------+--------+
    | Interface  | Result | Reason |
    +------------+--------+--------+
    | boot       | True   |        |
    | console    | True   |        |
    | deploy     | True   |        |
    | inspect    | True   |        |
    | management | True   |        |
    | network    | True   |        |
    | power      | True   |        |
    | raid       | True   |        |
    | storage    | True   |        |
    +------------+--------+--------+

Change-Id: I7f93b866cf4b50047e8666c3c5c01a201f18ef4b
This commit is contained in:
Nguyen Van Trung 2017-10-19 09:57:15 +07:00
parent 8a8fcdc216
commit b219699e9d
4 changed files with 41 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/source/baremetal-api-v1-node-management.inc
View File

@ -66,13 +66,15 @@ the Node's driver does not support that interface.
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- power: v_power
- boot: v_boot - boot: v_boot
- deploy: v_deploy
- console: v_console - console: v_console
- management: v_management - deploy: v_deploy
- inspect: v_inspect - inspect: v_inspect
- management: v_management
- network: v_network
- power: v_power
- raid: v_raid - raid: v_raid
- storage: v_storage
**Example node validation response:** **Example node validation response:**

12
api-ref/source/parameters.yaml
View File

@ -1048,6 +1048,12 @@ v_management:
in: body in: body
required: true required: true
type: object type: object
v_network:
description: |
Status of the "network" interface
in: body
required: true
type: object
v_power: v_power:
description: | description: |
Status of the "power" interface Status of the "power" interface
@ -1060,6 +1066,12 @@ v_raid:
in: body in: body
required: true required: true
type: object type: object
v_storage:
description: |
Status of the "storage" interface
in: body
required: true
type: object
vendor_interface: vendor_interface:
description: | description: |
Interface for vendor-specific functionality on this node, e.g. "no-vendor". Interface for vendor-specific functionality on this node, e.g. "no-vendor".

22
doc/source/install/enrollment.rst
View File

@ -365,10 +365,15 @@ Validating node information
+------------+--------+--------+ +------------+--------+--------+
| Interface | Result | Reason | | Interface | Result | Reason |
+------------+--------+--------+ +------------+--------+--------+
| boot | True | |
| console | True | | | console | True | |
| deploy | True | | | deploy | True | |
| inspect | True | |
| management | True | | | management | True | |
| network | True | |
| power | True | | | power | True | |
| raid | True | |
| storage | True | |
+------------+--------+--------+ +------------+--------+--------+
If the node fails validation, each driver interface will return information If the node fails validation, each driver interface will return information
@ -380,10 +385,15 @@ Validating node information
+------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
| Interface | Result | Reason | | Interface | Result | Reason |
+------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
| boot | True | |
| console | None | not supported | | console | None | not supported |
| deploy | False | Cannot validate iSCSI deploy. Some parameters were missing in node's instance_info. Missing are: ['root_gb', 'image_source'] | | deploy | False | Cannot validate iSCSI deploy. Some parameters were missing in node's instance_info. Missing are: ['root_gb', 'image_source'] |
| inspect | True | |
| management | False | Missing the following IPMI credentials in node's driver_info: ['ipmi_address']. | | management | False | Missing the following IPMI credentials in node's driver_info: ['ipmi_address']. |
| network | True | |
| power | False | Missing the following IPMI credentials in node's driver_info: ['ipmi_address']. | | power | False | Missing the following IPMI credentials in node's driver_info: ['ipmi_address']. |
| raid | None | not supported |
| storage | True | |
+------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
When using the Compute Service with the Bare Metal service, it is safe to When using the Compute Service with the Bare Metal service, it is safe to
@ -398,12 +408,18 @@ Validating node information
+------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Interface | Result | Reason | | Interface | Result | Reason |
+------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| boot | False | Cannot validate image information for node because one or more parameters are missing from its instance_info. Missing are: ['ramdisk', 'kernel', 'image_source'] |
| console | True | | | console | True | |
| deploy | False | Cannot validate image information for node because one or more parameters are missing from its instance_info. Missing are: ['ramdisk', 'kernel', 'image_source'] | | deploy | False | Cannot validate image information for node because one or more parameters are missing from its instance_info. Missing are: ['ramdisk', 'kernel', 'image_source'] |
| inspect | True | |
| management | True | | | management | True | |
| network | True | |
| power | True | | | power | True | |
| raid | None | not supported |
| storage | True | |
+------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Making node available for deployment Making node available for deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -523,9 +539,9 @@ UUID interchangeably:
| instance_info | {} | | instance_info | {} |
+------------------------+--------------------------------------+ +------------------------+--------------------------------------+
.. _rfc952: http://tools.ietf.org/html/rfc952 .. _rfc952: https://tools.ietf.org/html/rfc952
.. _rfc1123: http://tools.ietf.org/html/rfc1123 .. _rfc1123: https://tools.ietf.org/html/rfc1123
.. _wiki_hostname: http://en.wikipedia.org/wiki/Hostname .. _wiki_hostname: https://en.wikipedia.org/wiki/Hostname
.. _hardware_interfaces_defaults: .. _hardware_interfaces_defaults:

5
doc/source/install/standalone.rst
View File

@ -136,10 +136,15 @@ Steps to start a deployment are pretty similar to those when using Compute:
+------------+--------+----------------------------------------------------------------+ +------------+--------+----------------------------------------------------------------+
| Interface | Result | Reason | | Interface | Result | Reason |
+------------+--------+----------------------------------------------------------------+ +------------+--------+----------------------------------------------------------------+
| boot | True | |
| console | False | Missing 'ipmi_terminal_port' parameter in node's driver_info. | | console | False | Missing 'ipmi_terminal_port' parameter in node's driver_info. |
| deploy | True | | | deploy | True | |
| inspect | True | |
| management | True | | | management | True | |
| network | True | |
| power | True | | | power | True | |
| raid | True | |
| storage | True | |
+------------+--------+----------------------------------------------------------------+ +------------+--------+----------------------------------------------------------------+
#. Now you can start the deployment, run:: #. Now you can start the deployment, run::