From 56c2a6f7aa5f0270be6601686e8217d2495926d0 Mon Sep 17 00:00:00 2001 From: Summer Barringer Date: Mon, 27 Jul 2015 17:01:58 -0400 Subject: [PATCH] Documentation reformatting Changed the lines to be no more than 79 characters in length. Change-Id: Icca8f77ef5725e685e6c29cb4df4405ef2ba6889 --- .../roles/ironic-enroll-dynamic/README.md | 25 +++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/playbooks/roles/ironic-enroll-dynamic/README.md b/playbooks/roles/ironic-enroll-dynamic/README.md index b53270677..9417eea1b 100644 --- a/playbooks/roles/ironic-enroll-dynamic/README.md +++ b/playbooks/roles/ironic-enroll-dynamic/README.md @@ -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 ----------------