Go to file
Ian Wienand 78c0766bec Produce API documentation
There's an increasing amount of pydoc based documentation.  Output the
module reference and link it into the developers main page.

One fixup to the rst needed

Change-Id: I1d43a1fe1c735eb4559e3d2b40834d1c8115c586
2017-05-25 14:26:31 +10:00
bin Allow ELEMENTS_DIR to be configurable 2017-03-14 09:57:10 -06:00
diskimage_builder Produce API documentation 2017-05-25 14:26:31 +10:00
doc Produce API documentation 2017-05-25 14:26:31 +10:00
releasenotes Refactor: block-device filesystem creation, mount and fstab 2017-05-12 13:52:02 +02:00
tests Add bzip2 to test install 2017-05-04 14:59:14 +10:00
.gitignore Use sphinx warning-is-error 2017-03-14 14:49:49 +11:00
.gitreview Update stackforge references to openstack 2013-08-17 22:58:26 -04:00
.testr.conf Fix coverage report 2017-01-18 16:14:01 +11:00
babel.cfg Make it possible for openstack-CI to run tests 2013-02-04 22:26:17 -08:00
bindep.txt Add squashfs output image format 2016-12-19 07:21:39 +00:00
LICENSE Fix copyrights for HP work. 2012-11-15 16:20:32 +13:00
README.rst Make README.rst a bit more generic 2015-09-16 13:52:43 +10:00
requirements.txt Updated from global requirements 2017-04-12 04:10:50 +00:00
setup.cfg Produce API documentation 2017-05-25 14:26:31 +10:00
setup.py Updated from global requirements 2017-03-13 19:30:19 +00:00
test-requirements.txt Updated from global requirements 2017-05-17 03:47:03 +00:00
tox.ini Semi-automatic doc generation of element dependency 2017-02-09 09:50:30 +11:00

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.