Merge lp:~pwlars/ubuntu-ci-services-itself/image-builder-docs into lp:ubuntu-ci-services-itself

[Paul Larson]

Document API for the Image Builder component

[Andy Doan (doanac)]

44 + * base_image : {"image_type": IMAGE_TYPE, "url_list": [...],
45 + "series": SERIES}

Nice - you are the first person to bite the bullet and try to think about different types of images!

review: Approve

[Francis Ginther (fginther)]

Approve.

review: Approve

=== modified file 'docs/components/image-builder.rst'
--- docs/components/image-builder.rst	2013-12-09 16:33:26 +0000
+++ docs/components/image-builder.rst	2013-12-11 03:32:47 +0000
@@ -9,7 +9,8 @@
  * Adding the requested PPAs and packages
  * Repacking the image
 
-*Deployment*
+Deployment
+----------
 
 * Can run as a juju service.
 * Needs relationship to the Lander and the Data Store.
@@ -18,7 +19,8 @@
   Glance credentials
 * No public access needed.
 
-*Interactions:*
+Interactions
+-------------
 
 * Lander - Get the PPA to use, list of packages, and URL to the
   base image. Send back the location of the rebuilt image.
@@ -26,7 +28,31 @@
 * Data Store - Push rebuilt image. For cloud images, this will go to
   Glance rather than Swift.
 
-*Development Plan:*
+REST API
+--------
+
+status
+~~~~~~
+Return the current status of the image builder. Not needed by any other
+components, but useful for debugging.
+
+  curl --dump-header - http://localhost:8000/api/v1/imagebuilder/status
+
+build_image
+~~~~~~~~~~~
+Build an image including the requested PPAs and packages.
+
+parameters:
+  * base_image : {"image_type": IMAGE_TYPE, "url_list": [...],
+                  "series": SERIES}
+  * ppa_list : [...]
+  * package_list : [...]
+  * progress_trigger : URL
+
+   curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"base_image": {"image_type": "cloud", "url_list": ["http://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg-amd64-disk1.img"], "series": "trusty"}, "ppa_list": ["ppa:project/ppaname"], "package_list": ["libfoo", "baz-utils"]}' http://localhost:8000/api/v1/build_image/
+
+Development Plan
+----------------
 
 * Define APIs.
 * Prototype the process.