From 5bae00db0cbd19fc953b199978e3d45db81b40c2 Mon Sep 17 00:00:00 2001 From: Ian Wienand Date: Fri, 28 Aug 2015 11:48:58 +1000 Subject: [PATCH] Make README.rst a bit more generic I think diskimage-builder has grown somewhat since this was written, and this makes it sound like it is only useful as a TripleO component. Give a more generic overview, add a simple example to illustrate the point and generally make it clear this is a flexible solution for building disk images. Add a mention of the local documentation source. Change-Id: I74f13ccc1e3fe50ac907efcc7f479e59fe44455c --- README.rst | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index 379ca203..49a8ce49 100644 --- a/README.rst +++ b/README.rst @@ -1,21 +1,32 @@ Image building tools for OpenStack ================================== -These tools are the components of TripleO -(https://wiki.openstack.org/wiki/TripleO) that are responsible for -building disk images. +``diskimage-builder`` is a flexible suite of components for building a +wide-range of disk images, filesystem images and ramdisk images for +use with OpenStack. -This repository has the core functionality for building disk images, file -system images and ramdisk images for use with OpenStack (both virtual and bare -metal). The core functionality includes the various operating system specific -modules for disk/filesystem images, and deployment and hardware inventory -ramdisks. +This repository has the core functionality for building such images, +both virtual and bare metal. Images are composed using `elements`; +while fundamental elements are provided here, individual projects have +the flexibility to customise the image build with their own elements. -The TripleO project also develops elements that can be used to deploy -OpenStack itself. These live in the TripleO elements repository -(https://git.openstack.org/cgit/openstack/tripleo-image-elements). +For example:: -Online documentation: + $ DIB_RELEASE=trusty disk-image-create -o ubuntu-trusty.qcow2 vm ubuntu + +will create a bootable Ubuntu Trusty based ``qcow2`` image. + +``diskimage-builder`` is useful to anyone looking to produce +customised images for deployment into clouds. These tools are the +components of `TripleO `__ +that are responsible for building disk images. They are also used +extensively to build images for testing OpenStack itself, particularly +with `nodepool +`__. +Platforms supported include Ubuntu, CentOS, RHEL and Fedora. + +Full documentation, the source of which is in ``doc/source/``, is +published at: * http://docs.openstack.org/developer/diskimage-builder/