Bug 1040985

Cloned from launchpad blueprint https://blueprints.launchpad.net/nova/+spec/api-v3-remove-disk-config.

Description:

With the implementation of cloud-init, using OS-DCF:diskConfig attribute in the API is no longer needed.  We would like to deprecate this feature to reduce complexity and user confusion.  This proposal examines removing the disk config support in v3 of the API with eventual deprecation when v2 of the API support is removed.

Currently on a boot we can specify the disk be auto resized/configured by specifying OS-DCF:diskConfig to be AUTO or MANUAL.  An example v2 curl is the following:

curl -i http://192.168.46.144:8774/v2/6e96f875b5af4894b59264484ce5d589/servers -X POST -H "X-Auth-Project-Id: admin" -H "User-Agent: python-novaclient" -H "Content-Type: application/json" -H "Accept: application/json" -H "X-Auth-Token: ..." -d '{"server": {"name": "foo", "imageRef": "ff88ace3-26fb-4899-af5d-f676277ad337", "key_name": "key1", "flavorRef": "1", "OS-DCF:diskConfig": "AUTO", "max_count": 1, "min_count": 1}}'

This returns a 202 Accepted response when succeeding.  The v2 functionality will remain in place until v2 is removed.  v2 will be modified to include a log message to indicate this attribute will no longer exist in v3.

For v3 this option will not exist.  An example command which tries to use the v2 extension with v3 is the following:
curl -i http://192.168.46.144:8774/v3/6e96f875b5af4894b59264484ce5d589/servers -X POST -H "X-Auth-Project-Id: admin" -H "User-Agent: python-novaclient" -H "Content-Type: application/json" -H "Accept: application/json" -H "X-Auth-Token: ..." -d '{"server": {"name": "foo", "imageRef": "ff88ace3-26fb-4899-af5d-f676277ad337", "key_name": "key1", "flavorRef": "1", "OS-DCF:diskConfig": "AUTO", "max_count": 1, "min_count": 1}}'

The response will be a 400 (Bad Request) or normal error when an invalid attribute is included in the v3 parse.  

This will allow existing calls with no attribute (ie. selecting default) to continue working by simply changing to v3 support.  This only affects calls where OS-DCF:diskConfig is explicitly set.

DocImpact: As part of v2 API documentation we should note this attribute and feature are going to go away eventually.  As part of v3 API documentation we should include a "deprecated" statement with the expected mapping section of v2->v3.  This will be noted in the commit for removing v3 code related to this attribute/feature.  


Specification URL (additional information):

None