openstack/bifrost
Code Issues Proposed changes

Update README for bifrost-setup-nodes

Browse Source 
Updated the README file for bifrost-setup-nodes to indicate
dependencies, use, and variables.
This commit is contained in:
Julia Kreger 2015-03-30 11:48:17 -04:00
parent 2c41be30cf
commit 8faee32f61
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
roles/bifrost-setup-nodes/README.md
View File

@ -6,22 +6,38 @@ Provisions nodes based on the contents of the file designated by baremetal_csv_f
Requirements
------------
TODO
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.
Role Variables
--------------
TODO
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/"
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. iThis variable does not have a default in this role and expects to receive this informa
tion from the calling playbook.
deploy_image: This is the full path to the image to be deployed to the system. This is as Ironic requiers 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
------------
TODO
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
----------------
TODO
- hosts: localhost
connection: local
sudo: no
roles:
- role: bifrost-configdrives
- role: bifrost-setup-nodes
License
-------