diskimage-builder

Go to file

Ian Wienand 91b431ce78 Move element-info to a standard entry-point Move element-info from a wrapper script to a standard entry-point console_script. Update the documentation to explain how to run it for development. I don't think we should support the idea that you can check-out the code and run ./bin/disk-image-create -- it has dependencies (dib-utils, etc) and needs to be run from a virtualenv (this is what CI in the gate does). A follow-up can clean-up some of the path munging stuff we have for this in disk-image-create. Change-Id: Ic0c03995667f320a27ac30441279f3e6abb6bca8		2016-09-08 15:29:56 +10:00
bin	Move element-info to a standard entry-point	2016-09-08 15:29:56 +10:00
diskimage_builder	Move element-info to a standard entry-point	2016-09-08 15:29:56 +10:00
doc/source	Move element-info to a standard entry-point	2016-09-08 15:29:56 +10:00
elements	Refactor: block-device handling (local loop)	2016-09-08 04:31:01 +00:00
lib	Move element-info to a standard entry-point	2016-09-08 15:29:56 +10:00
releasenotes	Move element-info to a standard entry-point	2016-09-08 15:29:56 +10:00
tests	Add tests for building *-minimal images	2016-08-22 16:53:32 +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	Move element-info to a standard entry-point	2016-09-08 15:29:56 +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	2016-06-29 04:21:33 +00:00
setup.cfg	Move element-info to a standard entry-point	2016-09-08 15:29:56 +10:00
setup.py	Updated from global requirements	2015-09-22 09:17:08 +00:00
test-requirements.txt	Updated from global requirements	2016-06-24 03:10:45 +00:00
tox.ini	Refactor: block-device handling (local loop)	2016-09-08 04:31:01 +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.