f3121f0fb7
It seems that pbr's "warnerrors" isn't actually doing anything at the moment (I680b448471e687919d202e8f2abe57f8ba3b22ee) meaning we're able to commit docs with RST parser errors. Fix all these up in some minimal way (I have not audited content, just made it pass build). Link the specs in so they're referenced from the top level. Change-Id: Id67b9ea7ba8f49b43969c58ca3fb7fa1243538a4
59 lines
1.6 KiB
ReStructuredText
59 lines
1.6 KiB
ReStructuredText
Diskimage-builder Documentation
|
|
===============================
|
|
|
|
``diskimage-builder`` is a tool for automatically building customized
|
|
operating-system images for use in clouds and other environments.
|
|
|
|
It includes support for building images based on many major
|
|
distributions and can produce cloud-images in all common formats
|
|
(``qcow2``, ``vhd``, ``raw``, etc), bare metal file-system images and
|
|
ram-disk images. These images are composed from the many included
|
|
``elements``; ``diskimage-builder`` acts as a framework to easily add
|
|
your own elements for even further customization.
|
|
|
|
``diskimage-builder`` is used extensively by the `TripleO project
|
|
<https://wiki.openstack.org/wiki/TripleO>`__ and within `OpenStack
|
|
Infrastructure <http://docs.openstack.org/infra/system-config/>`__.
|
|
|
|
Code
|
|
----
|
|
|
|
Release notes for the latest and previous versions are available at:
|
|
|
|
* `http://docs.openstack.org/releasenotes/diskimage-builder/
|
|
<http://docs.openstack.org/releasenotes/diskimage-builder/>`__
|
|
|
|
|
|
The code is available at:
|
|
|
|
* `https://git.openstack.org/cgit/openstack/diskimage-builder/
|
|
<https://git.openstack.org/cgit/openstack/diskimage-builder/>`__
|
|
|
|
|
|
Issues
|
|
------
|
|
|
|
Issues are tracked on launchpad at:
|
|
|
|
* `<https://bugs.launchpad.net/diskimage-builder/+bugs>`__
|
|
|
|
|
|
Communication
|
|
-------------
|
|
|
|
Communication among the diskimage-builder developers happens on IRC in
|
|
``#openstack-dib`` on freenode and on the ``openstack-dev`` mailing list
|
|
(``openstack-dev@lists.openstack.org``).
|
|
|
|
|
|
Table of Contents
|
|
-----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
user_guide/index
|
|
developer/index
|
|
elements
|
|
specs/README
|