diskimage-builder

Go to file

Ian Wienand 274be6de55 Making element overriding explicit This is a re-factor of element_dependencies to achieve two things -- centralising override policy and storing path names. Firstly we want to make the override policy for elements completely explicit. Currently, elements that wish to copy parts of other elements walk ELEMENTS_PATH themselves and look for elements in IMAGE_ELEMENT. How they handle duplicate elements can differ, leading to inconsistent behaviour. We introduce logic in element-info to find elements in each of the directories in ELEMENT_PATHS in reverse order -- that is to say, earlier entries in the paths will overwrite later ones. For example ELEMENT_PATHS=foo:bar:baz will mean that "foo/element" will override "baz/element", since "foo" is first. This should be sane to anyone familiar with $PATH. Documentation is clarified around this point and a test-case is added. The second thing is that we want to keep the complete path of the elements we have chosen. We want the aforementioned elements that walk the element list to use these canonical paths to pickup files; this way they don't need to make local decisions about element overrides, but can simply iterate a list and copy/merge files if they exist. A follow-on change (I7092e1845942f249175933d67ab121188f3511fd) will expose this data in a separate variable that can be parsed by elements (a further follow-on I0a64b45e9f2cfa28e84b2859d76b065a6c4590f0 modifies the elements to use this information). Thus this does not change the status-quo -- elements that are walking ELEMENTS_PATH themselves and can/will continue doing that. Change-Id: I2a29861c67de2d25c595cb35d850e92807d26ac6		2016-09-08 10:58:19 +10:00
bin	Generalize logic for skipping final image generation	2016-07-28 13:14:36 -05:00
diskimage_builder	Making element overriding explicit	2016-09-08 10:58:19 +10:00
doc/source	Making element overriding explicit	2016-09-08 10:58:19 +10:00
elements	Merge "fix systemd resource deadlock"	2016-09-06 23:33:03 +00:00
lib	Correct order of parameters in call to qemu-img convert	2016-07-21 10:57:40 +02:00
releasenotes	Making element overriding explicit	2016-09-08 10:58:19 +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	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	2016-06-29 04:21:33 +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	2016-06-24 03:10:45 +00:00
tox.ini	Add releasenotes	2016-04-21 13:19:53 +10: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.