From 5d2bd1b57916eaa6a9b05d459baaf55a77cc5a94 Mon Sep 17 00:00:00 2001 From: Summer Barringer Date: Sun, 26 Jul 2015 21:09:26 -0400 Subject: [PATCH] Documentation reformatting Changed the lines to be no more than 79 characters. Change-Id: I62e15d1b3dc47cc081c2645e25b2b9ceb1feb02d --- .../bifrost-deploy-nodes-dynamic/README.md | 63 ++++++++++++++----- 1 file changed, 47 insertions(+), 16 deletions(-) diff --git a/playbooks/roles/bifrost-deploy-nodes-dynamic/README.md b/playbooks/roles/bifrost-deploy-nodes-dynamic/README.md index 6b0e2afca..3dc527797 100644 --- a/playbooks/roles/bifrost-deploy-nodes-dynamic/README.md +++ b/playbooks/roles/bifrost-deploy-nodes-dynamic/README.md @@ -1,44 +1,75 @@ 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 ------------ -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 -------------- -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 ------------ -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 ---------------- -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 - connection: local - sudo: no - roles: - - role: bifrost-configdrives - - role: bifrost-setup-nodes + - hosts: baremetal + connection: local + sudo: no + roles: + - role: bifrost-configdrives + - role: bifrost-setup-nodes License -------