sig_cloud/diskimage-builder
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,753 Commits 1 Branch 0 Tags 5.4 MiB
Shell 54.1%
Python 45.7%
Jinja 0.2%
fdd2c4b236
Go to file
Andreas Florath fdd2c4b236 Semi-automatic doc generation of element dependency 
Currently there is no description of dependencies in the generated
documentation of the elements: therefore a user of an element does not
know which other elements are automatically included and e.g. which
configuration options are available. In addition there are some
copy&pastes of parts of the README.rst scattered thought different
Ubuntu and Debian specific elements.

This patch adds a semi-automatic generation of dependency information
of all elements.  Nevertheless these are not automatically included.
The author of the element's README.rst can decide if and where the
dependency information should appear and can use the descriptor

.. element_deps::

for this.

This patch adds the dependency information for some Debian and
Ubuntu patches - and creates the base for later removing the
duplicated parts.

A call is added to element_dependencies._find_all_elements() to
populate reverse dependencies for Element objects.

(This is a reworking of I31d2b6050b6c46fefe37378698e9a330025db430 for
the feature/v2 branch)

Change-Id: Iebb83916fed71565071246baa550849eef40560b
2017-02-09 09:50:30 +11:00
bin Release 1.27.0 2017-02-03 11:49:45 +11:00
diskimage_builder Semi-automatic doc generation of element dependency 2017-02-09 09:50:30 +11:00
doc Semi-automatic doc generation of element dependency 2017-02-09 09:50:30 +11:00
elements/pip-and-virtualenv/test-elements Release 1.27.0 2017-02-03 11:49:45 +11:00
releasenotes Semi-automatic doc generation of element dependency 2017-02-09 09:50:30 +11:00
tests Release 1.27.0 2017-02-03 11:49:45 +11:00
.gitignore Git ignore coverage stuff 2017-01-31 14:21:21 +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 Merge remote-tracking branch 'origin/master' into merge-branch 2016-11-18 13:53:56 +11:00
setup.cfg Release 1.21.1 2017-02-02 20:36:23 +11:00
setup.py Updated from global requirements 2015-09-22 09:17:08 +00:00
test-requirements.txt Fix coverage report 2017-01-18 16:14:01 +11:00
tox.ini Semi-automatic doc generation of element dependency 2017-02-09 09:50:30 +11: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.