Documentation reformatting

Changed the lines to be no more than 79 characters in length.

Change-Id: Icca8f77ef5725e685e6c29cb4df4405ef2ba6889
This commit is contained in:
Summer Barringer 2015-07-27 17:01:58 -04:00
parent 36f4b5d339
commit 56c2a6f7aa

View File

@ -1,22 +1,32 @@
ironic-enroll-dynamic
=====================
Enrolls nodes into Ironic utilizing the os_ironic Ansible module that is installed by Bifrost.
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/).
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/"
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.
deploy_kernel: The kernel url, image id, or file representing the kernel to
utilize for deploying to 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.
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": {
@ -51,7 +61,8 @@ This role expects a data structure similar to the one below, however it should b
Dependencies
------------
This role is presently dependent upon the ironic-install role which installs the necessary requirements.
This role is presently dependent upon the ironic-install role which installs
the necessary requirements.
Example Playbook
----------------