openstack/bifrost
Code Issues Proposed changes
fedbad1a44
bifrost/roles/ironic-enroll
History
Julia Kreger d3b633f466 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.
2015-04-01 08:27:53 -04:00
..
defaults Adding default ironic_url for enrollment 2015-04-01 08:23:41 -04:00
handlers Blind stab at breaking things into more roles 2015-03-12 17:07:46 -04:00
meta Update meta.yml files 2015-03-12 17:13:20 -04:00
tasks Correcting testing enrollment compare 2015-03-17 11:52:01 -04:00
vars Logic fixes for roles changes to node enrollment step 2015-03-13 16:36:50 -04:00
README.md Update enrollment README file 2015-04-01 08:27:53 -04:00

README.md

ironic-enroll

Enrolls nodes into Ironic utilizing the os_ironic Ansible module that is installed by Bifrost.

Requirements

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

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:

  1. MAC Address
  2. Management username
  3. Management password
  4. Management Address
  5. CPU Count
  6. Memory size in MB
  7. Disk Storage in GB
  8. Flavor (Not Used)
  9. Type (Not Used)
  10. Host UUID
  11. Host or Node name
  12. Host IP Address to be set
  13. ipmi_target_channel - Requires: ipmi_bridging set to single
  14. ipmi_target_address - Requires: ipmi_bridging set to single
  15. ipmi_transit_channel - Requires: ipmi_bridging set to dual
  16. ipmi_transit_address - Requires: ipmi_bridging set to dual

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.

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

This role is presently dependent upon the ironic-install role which installs the necessary requirements.

Example Playbook

  • 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

Copyright (c) 2015 Hewlett-Packard Development Company, L.P.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express orimplied. See the License for the specific language governing permissions and limitations under the License.

Author Information

Ironic Developers