API documentation for creating a bootable volume

[Everett Toews]

It's possible to create a bootable volume but there's no API documentation for this yet. There is some CLI doc for it at http://docs.openstack.org/user-guide/content/boot_from_volume.html but we need API doc too.

To create a bootable volume with the cinder CLI this is what you would do.

cinder --debug create --image-id 23b564c9-c3e6-49f9-bc68-86c7a9ab5018 --display-name my-bootable-vol 8

This causes the follow request.

send: u'POST /v1/XXXXXX/volumes HTTP/1.1 Host: dfw.blockstorage.api.rackspacecloud.com Content-Length: 312 x-auth-project-id: XXXXXX accept-encoding: gzip, deflate accept: application/json x-auth-token: XXXXXX user-agent: python-cinderclient content-type: application/json {"volume": {"status": "creating", "availability_zone": null, "display_description": null, "snapshot_id": null, "user_id": null, "size": 8, "display_name": "my-bootable-vol", "imageRef": "23b564c9-c3e6-49f9-bc68-86c7a9ab5018", "attach_status": "detached", "volume_type": null, "project_id": null, "metadata": {}}}'

The imageRef piece is what needs to be documented as an optional addition. We need API documentation to create a bootable volume in both

http://docs.openstack.org/api/openstack-block-storage/2.0/content/Create_Volume.html

and

http://api.openstack.org/api-ref.html#volumes-api

[Diane Fleming (diane-fleming)]

backport: havana

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/63534

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/63534
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=77e2d72e64f74f8334bc0ff87686fe1a7ecc9dd5
Submitter: Jenkins
Branch: master

commit 77e2d72e64f74f8334bc0ff87686fe1a7ecc9dd5
Author: Diane Fleming <email address hidden>
Date: Fri Dec 20 16:15:32 2013 -0600

    Boot volume - add imageRef and bootable attributes

    To create a bootable volume, you must include imageRef and bootable attributes

    Partial-Bug: #1215147

    Change-Id: I31a9b40d5da0281e6ea3fcdea59ee6989a454789
    author: diane fleming

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/63815

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/63815
Committed: https://git.openstack.org/cgit/openstack/volume-api/commit/?id=a2f87a50c4af8558099a9f7a2c9dd8d18a8d0452
Submitter: Jenkins
Branch: master

commit a2f87a50c4af8558099a9f7a2c9dd8d18a8d0452
Author: Diane Fleming <email address hidden>
Date: Mon Dec 23 13:58:09 2013 -0600

    Update dev guide to point to WADL

    Picks up changes to volume API WADL including creating a bootable volume

    Closes-Bug: #1215147

    Change-Id: Iec2cc83bef6916716b493632e56e281207bd4688
    author: diane fleming