openstack/ironic
Code Issues Proposed changes

Merge "Follow-up patch to redfish documentation"

Browse Source
This commit is contained in:
Jenkins
2017-04-27 19:32:39 +00:00
committed by Gerrit Code Review
parent 5d363e9762 fa6002b925
commit 8fa488ccfc
1 changed files with 17 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/source/drivers/redfish.rst
View File

@@ -43,36 +43,35 @@ Registering a node with the Redfish driver
Nodes configured to use the driver should have the ``driver`` property Nodes configured to use the driver should have the ``driver`` property
set to ``redfish``. set to ``redfish``.
The following properties are required and must be specified in the node's The following properties are specified in the node's ``driver_info``
``driver_info`` field: field:
- ``redfish_address``: The URL address to the Redfish controller. It should - ``redfish_address``: The URL address to the Redfish controller. It should
include scheme and authority portion of the URL. include scheme and authority portion of the URL.
For example: https://mgmt.vendor.com For example: https://mgmt.vendor.com. This is required.
- ``redfish_system_id``: The canonical path to the System resource that - ``redfish_system_id``: The canonical path to the System resource that
the driver will interact with. It should include the driver will interact with. It should include
the root service, version and the unique the root service, version and the unique
resource path to the System. For example: resource path to the System. For example:
/redfish/v1/Systems/1 /redfish/v1/Systems/1. This is required.
- ``redfish_username``: User account with admin/server-profile access - ``redfish_username``: User account with admin/server-profile access
privilege privilege. Although not required, it is highly
recommended.
- ``redfish_password``: User account password - ``redfish_password``: User account password. Although not required, it is
highly recommended.
By default, if the ``redfish_address`` is using **https** the driver - ``redfish_verify_ca``: If redfish_address has the **https** scheme, the
will use a secure (TLS_) connection when talking to the Redfish driver will use a secure (TLS_) connection when
controller and for that it will try to verify the certificates present talking to the Redfish controller. By default
on the ironic conductor node. This behavior can be changed or disabled (if this is not set or set to True), the driver
(**not recommended**) by setting the ``redfish_verify_ca`` property as: will try to verify the host certificates. This
can be set to the path of a certificate file or
- ``redfish_verify_ca``: Path to a certificate file or directory with directory with trusted certificates that the
trusted certificates driver will use for verification. To disable
verifying TLS_, set this to False. This is optional.
or
- ``redfish_verify_ca``: False (Disable verifying TLS_)
The ``openstack baremetal node create`` command can be used to enroll The ``openstack baremetal node create`` command can be used to enroll
a node with the ``redfish`` driver. For example: a node with the ``redfish`` driver. For example: