diskimage-builder

Go to file

Ian Wienand 5bae00db0c 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		2015-09-16 13:52:43 +10:00
bin	dib-lint: validate json/yaml files	2015-09-15 12:48:23 +02:00
diskimage_builder	Bump to hacking 0.10	2015-02-11 15:28:28 -06:00
doc/source	Merge "doc: migrate from README.rst to Sphinx"	2015-09-16 01:24:07 +00:00
elements	Merge "Update redhat-common elements README from free text to table formatting"	2015-09-16 02:12:23 +00:00
lib	Merge "ramdisk: enable ppc64 support for symlink"	2015-07-16 23:07:12 +00:00
tests	Add docker output support	2015-07-19 10:20:39 +00:00
.gitignore	Ignore manifest outputs more carefully.	2014-06-26 04:29:51 +12:00
.gitreview	Update stackforge references to openstack	2013-08-17 22:58:26 -04:00
.testr.conf	Add unit test for cache-url	2014-09-30 16:39:21 -05:00
babel.cfg	Make it possible for openstack-CI to run tests	2013-02-04 22:26:17 -08:00
LICENSE	Fix copyrights for HP work.	2012-11-15 16:20:32 +13:00
MANIFEST.in	Remove old entries from MANIFEST.in	2015-09-02 15:15:13 +10:00
README.rst	Make README.rst a bit more generic	2015-09-16 13:52:43 +10:00
requirements.txt	Updated from global requirements	2015-06-22 08:20:17 +00:00
setup.cfg	Remove deprecated disk-image-get-kernel	2015-07-06 16:44:07 +00:00
setup.py	Updated from global requirements	2015-08-25 07:06:43 +00:00
test-requirements.txt	Updated from global requirements	2015-08-25 07:06:43 +00:00
tox.ini	Reorder tox environments	2015-03-30 20:57:34 +00:00

README.rst

Image building tools for OpenStack
==================================

``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 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.

For example::

  $ 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 <https://wiki.openstack.org/wiki/TripleO>`__
that are responsible for building disk images.  They are also used
extensively to build images for testing OpenStack itself, particularly
with `nodepool
<http://docs.openstack.org/infra/system-config/nodepool.html>`__.
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/

Copyright
=========

Copyright 2012 Hewlett-Packard Development Company, L.P.
Copyright (c) 2012 NTT DOCOMO, INC.

All Rights Reserved.

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.