openstack/placement
Code Issues Proposed changes

Revert "Revert "Fix AZ related API docs""

Browse Source 
Fix AZ related API docs

While we have a big fat comment in the development docs explaining why it's so
terrible to use default AZ values for either booting an instance or setting
an aggregate AZ metadata, we still have confusing API docs that provide the
wrong name for the AZ...

Fixing that and trying to explain the problem within the docs, too.

This reverts commit 92ca21abd61b6df7fc8bc5ffe7502f03b3eca2dd.

Co-Authored-By: Sylvain Bauza <sbauza@redhat.com>
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>

Change-Id: Ie4bfe32bbef0f8060bfc0ad4190f262d4a8bd3b2
This commit is contained in:
Sean Dague 2017-09-10 18:24:33 +00:00
parent cdb7bed0ae
commit d2c8d41878
27 changed files with 54 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api_samples/os-aggregates/aggregate-post-req.json
View File

@ -2,6 +2,6 @@
"aggregate": "aggregate":
{ {
"name": "name", "name": "name",
"availability_zone": "nova" "availability_zone": "london"
} }
} }

2
doc/api_samples/os-aggregates/aggregate-post-resp.json
View File

@ -1,6 +1,6 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2013-08-18T12:17:55.751757", "created_at": "2013-08-18T12:17:55.751757",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,

4
doc/api_samples/os-aggregates/aggregates-add-host-post-resp.json
View File

@ -1,6 +1,6 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2013-08-18T12:17:56.297823", "created_at": "2013-08-18T12:17:56.297823",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
@ -9,7 +9,7 @@
], ],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null "updated_at": null

4
doc/api_samples/os-aggregates/aggregates-get-resp.json
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2013-08-18T12:17:56.380226", "created_at": "2013-08-18T12:17:56.380226",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null "updated_at": null

4
doc/api_samples/os-aggregates/aggregates-list-get-resp.json
View File

@ -1,14 +1,14 @@
{ {
"aggregates": [ "aggregates": [
{ {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2013-08-18T12:17:56.856455", "created_at": "2013-08-18T12:17:56.856455",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": ["21549b2f665945baaa7101926a00143c"], "hosts": ["21549b2f665945baaa7101926a00143c"],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null "updated_at": null

4
doc/api_samples/os-aggregates/aggregates-metadata-post-resp.json
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2013-08-18T12:17:55.959571", "created_at": "2013-08-18T12:17:55.959571",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova", "availability_zone": "london",
"key": "value" "key": "value"
}, },
"name": "name", "name": "name",

4
doc/api_samples/os-aggregates/aggregates-remove-host-post-resp.json
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2013-08-18T12:17:56.990581", "created_at": "2013-08-18T12:17:56.990581",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null "updated_at": null

4
doc/api_samples/os-aggregates/v2.41/aggregate-post-resp.json
View File

@ -1,6 +1,6 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2016-12-27T22:51:32.877711", "created_at": "2016-12-27T22:51:32.877711",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
@ -9,4 +9,4 @@
"updated_at": null, "updated_at": null,
"uuid": "86a0da0e-9f0c-4f51-a1e0-3c25edab3783" "uuid": "86a0da0e-9f0c-4f51-a1e0-3c25edab3783"
} }
} }

6
doc/api_samples/os-aggregates/v2.41/aggregates-add-host-post-resp.json
View File

@ -1,6 +1,6 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2016-12-27T23:47:30.594805", "created_at": "2016-12-27T23:47:30.594805",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
@ -9,10 +9,10 @@
], ],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null, "updated_at": null,
"uuid": "d1842372-89c5-4fbd-ad5a-5d2e16c85456" "uuid": "d1842372-89c5-4fbd-ad5a-5d2e16c85456"
} }
} }

6
doc/api_samples/os-aggregates/v2.41/aggregates-get-resp.json
View File

@ -1,16 +1,16 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2016-12-27T23:47:30.563527", "created_at": "2016-12-27T23:47:30.563527",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null, "updated_at": null,
"uuid": "fd0a5b12-7e8d-469d-bfd5-64a6823e7407" "uuid": "fd0a5b12-7e8d-469d-bfd5-64a6823e7407"
} }
} }

6
doc/api_samples/os-aggregates/v2.41/aggregates-list-get-resp.json
View File

@ -1,7 +1,7 @@
{ {
"aggregates": [ "aggregates": [
{ {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2016-12-27T23:47:32.911515", "created_at": "2016-12-27T23:47:32.911515",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
@ -10,11 +10,11 @@
], ],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null, "updated_at": null,
"uuid": "6ba28ba7-f29b-45cc-a30b-6e3a40c2fb14" "uuid": "6ba28ba7-f29b-45cc-a30b-6e3a40c2fb14"
} }
] ]
} }

6
doc/api_samples/os-aggregates/v2.41/aggregates-metadata-post-resp.json
View File

@ -1,17 +1,17 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2016-12-27T23:59:18.623100", "created_at": "2016-12-27T23:59:18.623100",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova", "availability_zone": "london",
"key": "value" "key": "value"
}, },
"name": "name", "name": "name",
"updated_at": "2016-12-27T23:59:18.723348", "updated_at": "2016-12-27T23:59:18.723348",
"uuid": "26002bdb-62cc-41bd-813a-0ad22db32625" "uuid": "26002bdb-62cc-41bd-813a-0ad22db32625"
} }
} }

6
doc/api_samples/os-aggregates/v2.41/aggregates-remove-host-post-resp.json
View File

@ -1,16 +1,16 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "2016-12-27T23:47:30.594805", "created_at": "2016-12-27T23:47:30.594805",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null, "updated_at": null,
"uuid": "d1842372-89c5-4fbd-ad5a-5d2e16c85456" "uuid": "d1842372-89c5-4fbd-ad5a-5d2e16c85456"
} }
} }

2
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/aggregate-post-req.json.tpl
View File

@ -2,6 +2,6 @@
"aggregate": "aggregate":
{ {
"name": "name", "name": "name",
"availability_zone": "nova" "availability_zone": "london"
} }
} }

2
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/aggregate-post-resp.json.tpl
View File

@ -1,6 +1,6 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/aggregates-add-host-post-resp.json.tpl
View File

@ -1,6 +1,6 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
@ -9,7 +9,7 @@
], ],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null "updated_at": null

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/aggregates-get-resp.json.tpl
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null "updated_at": null

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/aggregates-list-get-resp.json.tpl
View File

@ -1,7 +1,7 @@
{ {
"aggregates": [ "aggregates": [
{ {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
@ -10,7 +10,7 @@
], ],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null "updated_at": null

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/aggregates-metadata-post-resp.json.tpl
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova", "availability_zone": "london",
"key": "value" "key": "value"
}, },
"name": "name", "name": "name",

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/aggregates-remove-host-post-resp.json.tpl
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null "updated_at": null

2
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/v2.41/aggregate-post-req.json.tpl
View File

@ -2,6 +2,6 @@
"aggregate": "aggregate":
{ {
"name": "name", "name": "name",
"availability_zone": "nova" "availability_zone": "london"
} }
} }

2
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/v2.41/aggregate-post-resp.json.tpl
View File

@ -1,6 +1,6 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/v2.41/aggregates-add-host-post-resp.json.tpl
View File

@ -1,6 +1,6 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
@ -9,7 +9,7 @@
], ],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null, "updated_at": null,

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/v2.41/aggregates-get-resp.json.tpl
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null, "updated_at": null,

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/v2.41/aggregates-list-get-resp.json.tpl
View File

@ -1,7 +1,7 @@
{ {
"aggregates": [ "aggregates": [
{ {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
@ -10,7 +10,7 @@
], ],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null, "updated_at": null,

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/v2.41/aggregates-metadata-post-resp.json.tpl
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova", "availability_zone": "london",
"key": "value" "key": "value"
}, },
"name": "name", "name": "name",

4
nova/tests/functional/api_sample_tests/api_samples/os-aggregates/v2.41/aggregates-remove-host-post-resp.json.tpl
View File

@ -1,13 +1,13 @@
{ {
"aggregate": { "aggregate": {
"availability_zone": "nova", "availability_zone": "london",
"created_at": "%(strtime)s", "created_at": "%(strtime)s",
"deleted": false, "deleted": false,
"deleted_at": null, "deleted_at": null,
"hosts": [], "hosts": [],
"id": 1, "id": 1,
"metadata": { "metadata": {
"availability_zone": "nova" "availability_zone": "london"
}, },
"name": "name", "name": "name",
"updated_at": null, "updated_at": null,