diskimage-builder

Go to file

Abel Lopez 5e9c451d5f Document byte-to-inode ratio End user docs would benefit from a section about the byte-to-inode ratio, and why it's set the way it is. This update explains why and how to manipulate the ratio depending on the intended use. Change-Id: Iffb5ef6f4c7c74f4aa6e25912d4991d7a611c8fe Closes-bug: 1512841		2015-12-16 13:58:17 -08:00
bin	Merge "dib-lint: ignore blank lines in element ordering"	2015-11-10 00:32:04 +00:00
diskimage_builder	Bump to hacking 0.10	2015-02-11 15:28:28 -06:00
doc/source	Document byte-to-inode ratio	2015-12-16 13:58:17 -08:00
elements	Merge "Add dib-python element"	2015-12-15 23:24:25 +00:00
lib	Merge "Prevent overwriting of user modified blacklist.conf"	2015-10-05 18:57:01 +00:00
tests	Add a tox target to run functional tests locally	2015-10-23 12:05:23 +02: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	Add missing six requirement for svc-map element	2015-11-05 01:58:00 +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-09-22 09:17:08 +00:00
test-requirements.txt	Updated from global requirements	2015-12-01 05:00:47 +00:00
tox.ini	Add a tox target to run functional tests locally	2015-10-23 12:05:23 +02: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.