openstack/bifrost
Code Issues Proposed changes

Documentation reformatting

Browse Source 
Changed the lines to be no more than 79 characters.

Change-Id: I62e15d1b3dc47cc081c2645e25b2b9ceb1feb02d
This commit is contained in:
Summer Barringer 2015-07-26 21:09:26 -04:00
parent 3b5f5a6e0b
commit 5d2bd1b579
1 changed files with 47 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
playbooks/roles/bifrost-deploy-nodes-dynamic/README.md
View File

@ -1,37 +1,68 @@
bifrost-deploy-nodes-dynamic bifrost-deploy-nodes-dynamic
============================ ============================
Provisions nodes based on inventory utilizing the os_ironic_node module installed by Bifrost. Provisions nodes based on inventory utilizing the os_ironic_node module
installed by Bifrost.
Requirements Requirements
------------ ------------
This role is expected to be executed on a node that the "ironic-install" node has been executed upon. This role is expected to be executed on a node that the "ironic-install" node
has been executed upon.
This role expects to be executed in a sequence with bifrost-configdrives-dynamic, however that is un-necessary IF the host has a dictionary named instance_info defined as that will be used as overriding values. This role expects to be executed in a sequence with
bifrost-configdrives-dynamic, however that is un-necessary IF the host has a
dictionary named instance_info defined as that will be used as overriding
values.
Role Variables Role Variables
-------------- --------------
ironic_url: This is the URL to the ironic server. By default, this is set to "http://localhost:6385/" ironic_url: This is the URL to the ironic server. By default, this is set to
"http://localhost:6385/"
network_interface: This is the network interface that the nodes receive DHCP/PXE/iPXE. This is utilized to generate the url that Ironic is configured with for image retrieval. This variable does not have a default in this role and expects to receive this information from the calling playbook. network_interface: This is the network interface that the nodes receive
DHCP/PXE/iPXE. This is utilized to generate the url that
Ironic is configured with for image retrieval. This
variable does not have a default in this role and expects to
receive this information from the calling playbook.
deploy_image_filename: This is the filename of the image to deploy, which is combined with the network_interface variable to generate a URL used to set the Ironic instance image_source. This variable does not have a default in this role and expects to receive this information from the calling playbook. deploy_image_filename: This is the filename of the image to deploy, which is
combined with the network_interface variable to generate
a URL used to set the Ironic instance image_source. This
variable does not have a default in this role and
expects to receive this information from the calling
playbook.
deploy_image: This is the full path to the image to be deployed to the system. This is as Ironic requires the MD5 hash of the file to be deployed for validation during the deployment process. As a result of this requirement, the hash is automatically collected and submitted to Ironic with the node deployment request. This variable does not have a default in this role and expects to receive this information from the calling playbook. deploy_image: This is the full path to the image to be deployed to the system.
This is as Ironic requires the MD5 hash of the file to be
deployed for validation during the deployment process. As a
result of this requirement, the hash is automatically collected
and submitted to Ironic with the node deployment request. This
variable does not have a default in this role and expects to
receive this information from the calling playbook.
instance_info: A dictionary containing the information to define an instance. By default, this is NOT expected to be defined, however if defined it is passed in whole to the deployment step. This value will override deploy_image_filename, deploy_image, and network_interface variables. Key-value pairs that are generally expected are image_source, image_checksum, root_gb, however any supported key/value can be submitted to the API. instance_info: A dictionary containing the information to define an instance.
By default, this is NOT expected to be defined, however if
defined it is passed in whole to the deployment step. This
value will override deploy_image_filename, deploy_image, and
network_interface variables. Key-value pairs that are generally
expected are image_source, image_checksum, root_gb, however,
any supported key/value can be submitted to the API.
Dependencies Dependencies
------------ ------------
This role is intended to be executed upon a node that the ironic-install role has been executed upon. The configuration that is leveraged by this role utilizes a configuration drive to place network configuration and an SSH key on the newly deployed host. As such, the bifrost-configdrives role is required. This role is intended to be executed upon a node that the ironic-install role
has been executed upon. The configuration that is leveraged by this role
utilizes a configuration drive to place network configuration and an SSH key on
the newly deployed host. As such, the bifrost-configdrives role is required.
Example Playbook Example Playbook
---------------- ----------------
NOTE: The example below assumes bifrost's default and that an instance_info variable is not defined. NOTE: The example below assumes bifrost's default and that an instance_info
variable is not defined.
- hosts: baremetal - hosts: baremetal
connection: local connection: local