From d3b633f466de1f0b5a706cba17319176962204d5 Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Wed, 1 Apr 2015 08:27:53 -0400 Subject: [PATCH] Update enrollment README file Cleaned up variable list to be a bit more clear to understand what the variable actually is, as well as added the ironic_url variable, and noted that the testing variable is defaulted to false. --- roles/ironic-enroll/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/roles/ironic-enroll/README.md b/roles/ironic-enroll/README.md index 674e9f43d..7cd00d6e8 100644 --- a/roles/ironic-enroll/README.md +++ b/roles/ironic-enroll/README.md @@ -11,7 +11,7 @@ This role is dependent upon the os-ironic ansible module, which is dependent upo Role Variables -------------- -The "baremetal_csv_file" variable is the path to a CSV file which contains a list of nodes to enroll into Ironic. This file has a particular format based on columns, which will be listed below, however the base playbooks are easilly modifiable to utilize less information as some of the information is not presently required. +baremetal_csv_file: This variable is the path to a CSV file which contains a list of nodes to enroll into Ironic. This file has a particular format based on columns, which will be listed below, however the base playbooks are easilly modifiable to utilize less information as some of the information is not presently required. The CSV file has the following columns: @@ -32,9 +32,11 @@ The CSV file has the following columns: 14. ipmi_transit_channel - Requires: ipmi_bridging set to dual 15. ipmi_transit_address - Requires: ipmi_bridging set to dual -The "testing" setting, coupled with the previously mentioned baremetal_csv_file enrolls all nodes defined in the baremetal.csv file utilizing the Ironic agent_ssh driver instead of the agent_ipmitool driver which Bifrost uses by default. +testing: This setting coupled with the previously mentioned baremetal_csv_file enrolls all nodes defined in the baremetal.csv file utilizing the Ironic agent_ssh driver instead of the agent_ipmitool driver which Bifrost uses by default. The default setting for this role is false. -The "ipmi_bridging" setting is by default undefined, and is utilized when access to a host's IPMI interface is bridged, such as a cartrige or blade in a chassis that has a single management address. It has two options when defined, "single" or "dual", and is utilized to execute the appropriate task in order to feed the appropriate IPMI bridging information based on the CSV file into Ironic. +ipmi_bridging: The setting is by default undefined, and is utilized when access to a host's IPMI interface is bridged, such as a cartrige or blade in a chassis that has a single management address. It has two options when defined, "single" or "dual", and is utilized to execute the appropriate task in order to feed the appropriate IPMI bridging information based on the CSV file into Ironic. + +ironic_url: The setting defining the URL to the Ironic API. Presently defaulted to: "http://localhost:6385/" Dependencies ------------