diskimage-builder/doc/source/index.rst

65 lines
1.6 KiB
ReStructuredText
Raw Normal View History

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 <https://docs.openstack.org/infra/system-config/>`__.
Code
----
Release notes for the latest and previous versions are available at:
* `https://docs.openstack.org/releasenotes/diskimage-builder/
<https://docs.openstack.org/releasenotes/diskimage-builder/>`__
The code is available at:
* `https://opendev.org/openstack/diskimage-builder/
<https://opendev.org/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-discuss`` mailing list
(``openstack-discuss@lists.openstack.org``).
Table of Contents
-----------------
.. toctree::
:maxdepth: 2
user_guide/index
developer/index
elements
specs/README
.. # just link this on the dev page
.. toctree::
:hidden:
api/autoindex