Summer Barringer dddf4c4624 Documentation refomatting
Changed the lines to be no more than 79 characters.

Change-Id: I679b40d64c3dc6aed6098497192ecfb507fc2beb
2015-07-27 12:40:46 -04:00

97 lines
2.6 KiB
Markdown

ironic-enroll-dynamic
=====================
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
--------------
ironic_url: The setting defining the URL to the Ironic API. Presently
defaulted to: "http://localhost:6385/"
deploy_kernel: The kernel url, image id, or file representing the kernel to
utilize for deploying to this node.
deploy_ramdisk: The ramdisk url, image id, or file representing the ramdisk
image to load to deploy this node.
This role expects a data structure similar to the one below, however it should
be understood that the individual entries under power can vary based on power
driver required.
{
"node1": {
"uuid": "00000000-0000-0000-0000-000000000000",
"driver_info": {
"power": {
"ipmi_target_channel": "0",
"ipmi_username": "ADMIN",
"ipmi_address": "192.168.122.1",
"ipmi_target_address": "0",
"ipmi_password": "undefined",
"ipmi_bridging": "single"
}
},
"nics": [
{
"mac": "00:01:02:03:04:05"
}.
],
"driver": "agent_ipmitool",
"ip_address": "192.168.122.2",
"properties": {
"cpu_arch": "x86_64",
"ram": "3072",
"disk_size": "10",
"cpus": "1"
},
"name": "node1"
}
}
Dependencies
------------
This role is presently dependent upon the ironic-install role which installs
the necessary requirements.
Example Playbook
----------------
- hosts: baremetal
connection: local
name: "Executes enrollment of nodes into Ironic"
roles:
- role: ironic-enroll-dynamic
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 or implied.
See the License for the specific language governing permissions and
limitations under the License.
Author Information
------------------
Ironic Developers