From 82ee947ea04a1ffb20d8fd851698ab43d0b82813 Mon Sep 17 00:00:00 2001 From: Michael McCune Date: Tue, 1 Apr 2014 17:01:58 -0400 Subject: [PATCH] Updating the vanilla image building docs Changes * moved some text around, namely the intro paragraph * adding a link to devstack docs and referencing the config file * adding a CentOS to the list of default actions that diskimage-create.sh will perform * adding a link to the official diskimage-create doc page * general cleanup Partial-Implements: blueprint update-docs-icehouse Change-Id: Iddb37db9d03c58d0573f2ae872d0f89f388ac41e --- doc/source/userdoc/diskimagebuilder.rst | 36 +++++++++++++++++-------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/doc/source/userdoc/diskimagebuilder.rst b/doc/source/userdoc/diskimagebuilder.rst index bba4387d..8e301a93 100644 --- a/doc/source/userdoc/diskimagebuilder.rst +++ b/doc/source/userdoc/diskimagebuilder.rst @@ -1,16 +1,19 @@ Building Images for Vanilla Plugin ================================== -As of now vanilla plugin works with images with pre-installed Apache Hadoop. To -simplify task of building such images we use +In this document you will find instruction on how to build Ubuntu, Fedora, and +CentOS images with Apache Hadoop versions 1.x.x and 2.x.x. + +As of now the vanilla plugin works with images with pre-installed versions of +Apache Hadoop. To simplify the task of building such images we use `Disk Image Builder `_. -`Disk Image Builder` is built of elements. An element is a particular set of -code that alters how the image is built, or runs within the chroot to prepare -the image. - -Elements for building vanilla images are stored in `Sahara extra repository `_ +`Disk Image Builder` builds disk images using elements. An element is a +particular set of code that alters how the image is built, or runs within the +chroot to prepare the image. +Elements for building vanilla images are stored in +`Sahara extra repository `_ .. note:: @@ -19,12 +22,16 @@ Elements for building vanilla images are stored in `Sahara extra repository `_ * `For Ubuntu `_ -In this document you will find instruction on how to build Ubuntu and Fedora -images with Apache Hadoop. +To create vanilla images follow these steps: 1. Clone repository "https://github.com/openstack/sahara-image-elements" locally. -2. You just can run script diskimage-create.sh in any directory (for example, in home directory). This script will create two cloud images - Fedora and Ubuntu. +2. Run the diskimage-create.sh script. + + You can run the script diskimage-create.sh in any directory (for example, in + your home directory). By default this script will attempt to create 6 cloud + images, 2 each of Ubuntu, Fedora, and CentOS with versions 1 and 2 of Apache + Hadoop. This script must be run with root privileges. .. sourcecode:: console @@ -48,4 +55,11 @@ images with Apache Hadoop. NOTE: If you don't want to use default values, you should edit this script and set your values of parameters. - Then it will create two cloud image with ``hadoop``, ``hive``, ``oozie``, ``mysql``, ``swift_hadoop`` elements that install all necessary packages and configure them. You will find these images in current directory. + Then it will create a series of cloud images with ``hadoop``, ``hive``, + ``oozie``, ``mysql``, and ``swift_hadoop`` elements that install all the + necessary packages and configure them. You will find these images in + current directory. + +For finer control of diskimage-create.sh see the `official documentation +`_ +or run ``$ diskimage-create.sh -h``.