diskimage-builder

Go to file

Ian Wienand b85de3cd9e Add state object, rename "results", add unit tests A couple of things going on, but I think it makes sense to do them atomically. The NodeBase.create() argument "results" is the global state dictionary that will be saved to "state.json", and re-loaded in later phases and passed to them as the argument "state". So for consistency, call this argument "state" (this fits with the change out to start building the state dictionary earlier in the PluginBase.__init__() calls). Since the "state" is a pretty important part of how everything works, move it into a separate object. This is treated as essentially a singleton. It bundles it nicely together for some added documentation [1]. We move instantiation of this object out of the generic BlockDevice.__init__() call and into the actual cmd_* drivers. This is because there's two distinct instantiation operations -- creating a new state (during cmd_create) and loading an existing state (other cmd_). This is also safer -- since we know the cmd_ arguments are looking for an existing state.json, we will fail if it somehow goes missing. To more fully unit test this, some testing plugins and new entry-points are added. These add known state values which we check for. These should be a good basis for further tests. [1] as noted, we could probably do some fun things in the future like make this implement a dictionary and have some saftey features like r/o keys. Change-Id: I90eb711b3e9b1ce139eb34bdf3cde641fd06828f		2017-05-30 20:39:00 +10:00
bin	Allow ELEMENTS_DIR to be configurable	2017-03-14 09:57:10 -06:00
diskimage_builder	Add state object, rename "results", add unit tests	2017-05-30 20:39:00 +10:00
doc	Add a more generic tree->graph parser	2017-05-26 10:13:14 +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
pylint.cfg	Refactor: use lazy logging	2017-05-30 14:39:58 +10:00
README.rst	Make README.rst a bit more generic	2015-09-16 13:52:43 +10:00
requirements.txt	Use networkx for digraph	2017-05-26 11:42:10 +10:00
setup.cfg	Add state object, rename "results", add unit tests	2017-05-30 20:39:00 +10:00
setup.py	Updated from global requirements	2017-03-13 19:30:19 +00:00
test-requirements.txt	Add pylint with indent check	2017-05-29 16:12:35 +10:00
tox.ini	Refactor: use lazy logging	2017-05-30 14:39:58 +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.