From: Tomas Sedovic <[email protected]>
---
deltacloud.org/content/_submenu-documentation.haml | 6 ++-
deltacloud.org/content/image-builder.haml | 11 +++++
docs/documentation.mdown | 5 +-
docs/image-builder.mdown | 45 ++++++++++++++++++++
4 files changed, 63 insertions(+), 4 deletions(-)
create mode 100644 deltacloud.org/content/image-builder.haml
create mode 100644 docs/image-builder.mdown
diff --git a/deltacloud.org/content/_submenu-documentation.haml
b/deltacloud.org/content/_submenu-documentation.haml
index 7f3eae0..2be4828 100644
--- a/deltacloud.org/content/_submenu-documentation.haml
+++ b/deltacloud.org/content/_submenu-documentation.haml
@@ -3,9 +3,11 @@ filter: haml
---
- menu = [ { :href => 'documentation.html', :text => 'Overview' }, |
{ :href => "api.html" , :text => 'REST API' }, |
- { :href => "client-ruby.html" , :text => 'Ruby Client' }, |
{ :href => "drivers.html" , :text => 'Drivers' }, |
- { :href => "framework.html" , :text => 'Framework' } ] |
+ { :href => "image-builder.html" , :text => 'Image Builder' }, |
+ { :href => "framework.html" , :text => 'Framework' }, |
+ { :href => "client-ruby.html" , :text => 'Ruby Client' }, |
+ ] |
#subnavigation
#submenu.container
diff --git a/deltacloud.org/content/image-builder.haml
b/deltacloud.org/content/image-builder.haml
new file mode 100644
index 0000000..6e59163
--- /dev/null
+++ b/deltacloud.org/content/image-builder.haml
@@ -0,0 +1,11 @@
+---
+title: Deltacloud - Documentation
+area: documentation
+extension: html
+filter:
+ - haml
+ - outline
+---
+<toc class="toc" numbering="off" toc_style="ul" toc_range="h2-h3" />
+
+= render(:partial => "external", :locals => {:path =>
'../docs/image-builder.mdown'} )
diff --git a/docs/documentation.mdown b/docs/documentation.mdown
index 554530c..8d169e9 100644
--- a/docs/documentation.mdown
+++ b/docs/documentation.mdown
@@ -1,9 +1,10 @@
# Documentation
-The Deltacloud documentation is broken into 4 parts
+The Deltacloud documentation is divided into the following parts:
- [REST API definition](api.html)
-- [Ruby client](client-ruby.html)
- [Currently-supported drivers](drivers.html)
+- [Image Builder](image-builder.html)
- [Framework for writing additional drivers](framework.html)
+- [Ruby client](client-ruby.html)
diff --git a/docs/image-builder.mdown b/docs/image-builder.mdown
new file mode 100644
index 0000000..710ada8
--- /dev/null
+++ b/docs/image-builder.mdown
@@ -0,0 +1,45 @@
+# Image Builder #
+
+## Summary ##
+
+The image builder is an external service that allows the aggregator to
+build images for multiple cloud providers from a single image
+descriptor. The builder exposes its services as a QMF agent and uses
+XML for the descriptor format.
+
+The resulting images are transferred to an image repository component
+that pushes the resulting images out to the appropriate cloud
+provider.
+
+
+## Status ##
+
+The image builder is being actively developed. This is a very early
+version, and it should in no way be considered either stable or
+production-ready. At present it supports only Fedora and RHEL based
+distributions via the BoxGrinder imaging tool. It is not yet
+integrated with the image repository.
+
+As a result, images are stored locally on the host running the image
+builder QMF agent. Delivery to specific cloud back ends must be done
+manually. As development progresses, there will be much more
+integration of these pieces
+
+Please check back on this space often as we update documentation and
+status of the Image Builder. For additional information on how to use
+what we currently have, take a look at the README in our repo, which
+you can get here:
+
+ git clone git://git.fedorahosted.org/git/deltacloud/image_builder.git/
+
+
+## XML Descriptor ##
+
+This format is still in flux, but describes things such as:
+
+* Image Name
+* Image Description
+* Base Operating System and Version
+* Sources where software should be retrieved
+* List of packages to install
+* Services required by this image
--
1.6.6.1
_______________________________________________
deltacloud-devel mailing list
[email protected]
https://fedorahosted.org/mailman/listinfo/deltacloud-devel
