openstack/bifrost
Code Issues Proposed changes

Updates to the ironic-enroll task README

Browse Source 
Defined variables and requirements for the ironic-enroll task
README file, as well as provide an example playbook of the task's
use.
This commit is contained in:
Julia Kreger 2015-03-27 22:27:31 -04:00
parent e9d09dae32
commit cc947b67b1
1 changed files with 35 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
roles/ironic-enroll/README.md
View File

@ -6,22 +6,53 @@ Enrolls nodes into Ironic utilizing the os_ironic Ansible module that is install
Requirements
------------
TODO
This role is dependent upon the os-ironic ansible module, which is dependent upon shade (https://git.openstack.org/cgit/openstack-infra/shade), which in this case is presently dependent upon the Ironic Python Client Library (http://git.openstack.org/cgit/openstack/python-ironicclient/).
Role Variables
--------------
TODO
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.
The CSV file has the following columns:
0. MAC Address
1. Management username
2. Management password
3. Management Address
4. CPU Count
5. Memory size in MB
6. Disk Storage in GB
7. Flavor (Not Used)
8. Type (Not Used)
9. Host UUID
10. Host or Node name
11. Host IP Address to be set
12. ipmi_target_channel - Requires: ipmi_bridging set to single
13. ipmi_target_address - Requires: ipmi_bridging set to single
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.
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.
Dependencies
------------
TODO
This role is presently dependent upon the ironic-install role which installs the necessary requirements.
Example Playbook
----------------
TODO
- hosts: localhost
connection: local
gather_facts: yes
pre_tasks:
- set_fact: baremetal_csv_file="/tmp/baremetal.csv"
when: baremetal_csv_file is not defined
roles:
- role: ironic-enroll
testing: true
License
-------