openstack/bifrost
Code Issues Proposed changes

Documentation reformatting

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

Change-Id: I2c7e6fdb91f1d44c5336b5af7e5f983d8c11340d
This commit is contained in:
Summer Barringer 2015-07-27 16:29:54 -04:00
parent 39546ddc3e
commit 8345f22b93
1 changed files with 36 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
playbooks/roles/bifrost-setup-nodes/README.md
View File

@ -1,33 +1,59 @@
Role Name Role Name
========= =========
Provisions nodes based on the contents of the file designated by baremetal_csv_file utilizing the os_ironic_node installed by Bifrost. Provisions nodes based on the contents of the file designated by
baremetal_csv_file utilizing the os_ironic_node 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.
As configured, this role requires the "bifrost-configdrives" role be executed prior to this role, utilizing the baremetal_csv_file variable which defines the path to the CSV file which is utilized as the source of information for this role to operate. As configured, this role requires the "bifrost-configdrives" role be executed
prior to this role, utilizing the baremetal_csv_file variable which defines the
path to the CSV file which is utilized as the source of information for this
role to operate.
Role Variables Role Variables
-------------- --------------
baremetal_csv_file: This is the variable that references the CSV file which is utilized as the source of information for nodes to execute the role upon. This variable does not have a default in this role and expects to receive this information from the calling playbook. baremetal_csv_file: This is the variable that references the CSV file which is
utilized as the source of information for nodes to execute the role upon. This
variable does not have a default in this role and expects to receive this
information from the calling playbook.
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 informa deploy_image_filename: This is the filename of the image to deploy, which is
tion from the calling playbook. 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.
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
---------------- ----------------