From d3e6c4efe029ae0ee89247131b030b2c119aaf76 Mon Sep 17 00:00:00 2001 From: Wei Zhou Date: Wed, 27 Jun 2018 15:28:39 -0400 Subject: [PATCH] Update REST API doc for Ceph External Backend Story: 2002820 Task: 22737 Change-Id: I367070c3ed8970396fe9f3a79a18249098517e63 Signed-off-by: Don Penney Signed-off-by: Jack Ding --- .../api-ref/src/docbkx/ch_sysinv-api-v1.xml | 20 +++ .../storage_ceph_external_add-request.json | 7 + .../storage_ceph_external_add-response.json | 25 +++ .../storage_ceph_external_list-response.json | 27 +++ .../storage_ceph_external_modify-request.json | 12 ++ ...storage_ceph_external_modify-response.json | 27 +++ .../storage_ceph_external_show-response.json | 26 +++ .../src/wadls/sysinv-api/v1/common.ent | 14 +- .../wadls/sysinv-api/v1/sysinv-api-v1.wadl | 168 ++++++++++++++++++ 9 files changed, 325 insertions(+), 1 deletion(-) create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_add-request.json create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_add-response.json create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_list-response.json create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_modify-request.json create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_modify-response.json create mode 100644 restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_show-response.json diff --git a/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml b/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml index 338a8a638..0d0aa76b7 100644 --- a/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml +++ b/restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml @@ -1144,6 +1144,26 @@ configuration entity for the system. href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_id"> + + + + + + + + + + + + + + + diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_add-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_add-request.json new file mode 100644 index 000000000..9f02d24fb --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_add-request.json @@ -0,0 +1,7 @@ +{ + "services": "cinder", + "confirmed": true, + "name": "ceph-ext-bk", + "ceph_conf": "ext-ceph.conf", + "capabilities": {"cinder_pool": "cinder-volumes"} +} diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_add-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_add-response.json new file mode 100644 index 000000000..ecae948b6 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_add-response.json @@ -0,0 +1,25 @@ +{ + "confirmed": false, + "task": null, + "name": "ceph-ext-bk", + "links": [ + { + "href": "http://192.168.204.2:6385/v1/storage_ceph_external/ced40c30-5499-48a7-8197-3e1a90b3f402", + "rel": "self" + }, + { + "href": "http://192.168.204.2:6385/storage_ceph_external/ced40c30-5499-48a7-8197-3e1a90b3f402", + "rel": "bookmark" + } + ], + "created_at": "2018-06-27T13:30:38.557700+00:00", + "updated_at": null, + "uuid": "ced40c30-5499-48a7-8197-3e1a90b3f402", + "capabilities": { + "cinder_pool": "cinder-volumes" + }, + "ceph_conf": null, + "state": "configuring", + "services": "cinder", + "backend": "ceph-external" +} diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_list-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_list-response.json new file mode 100644 index 000000000..d47a83851 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_list-response.json @@ -0,0 +1,27 @@ +{ + "storage_ceph_external": [ + { + "task": null, + "uuid": "ced40c30-5499-48a7-8197-3e1a90b3f402", + "links": [ + { + "href": "http://192.168.204.2:6385/v1/storage_backends/ced40c30-5499-48a7-8197-3e1a90b3f402", + "rel": "self" + }, + { + "href": "http://192.168.204.2:6385/storage_backends/ced40c30-5499-48a7-8197-3e1a90b3f402", + "rel": "bookmark" + } + ], + "created_at": "2018-06-27T13:30:38.557700+00:00", + "updated_at": "2018-06-27T13:35:13.213177+00:00", + "capabilities": { + "cinder_pool": "cinder-volumes" + }, + "services": "cinder", + "state": "configured", + "backend": "ceph-external", + "name": "ceph-ext-bk" + } + ] +} diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_modify-request.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_modify-request.json new file mode 100644 index 000000000..8f33182f5 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_modify-request.json @@ -0,0 +1,12 @@ +[ + { + "path": "/services", + "value": "cinder,glance", + "op": "replace" + } + { + "path": "/capabilities", + "value": "{\\"glance_pool\\": \\"images\\"}", + "op": "replace" + } +] diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_modify-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_modify-response.json new file mode 100644 index 000000000..63bc5e514 --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_modify-response.json @@ -0,0 +1,27 @@ +{ + "confirmed": false, + "task": null, + "uuid": "ced40c30-5499-48a7-8197-3e1a90b3f402", + "links": [ + { + "href": "http://192.168.204.2:6385/v1/storage_ceph_external/ced40c30-5499-48a7-8197-3e1a90b3f402", + "rel": "self" + }, + { + "href": "http://192.168.204.2:6385/storage_ceph_external/ced40c30-5499-48a7-8197-3e1a90b3f402", + "rel": "bookmark" + } + ], + "created_at": "2018-06-27T13:30:38.557700+00:00", + "updated_at": "2018-06-27T13:35:13.213177+00:00", + "capabilities": { + "glance_pool": "images", + "cinder_pool": "cinder-volumes" + }, + "name": "ceph-ext-bk", + "services": "cinder,glance", + "state": "configured", + "ceph_conf": "ext-ceph.conf", + "backend": "ceph-external" +} + diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_show-response.json b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_show-response.json new file mode 100644 index 000000000..6b419a3ac --- /dev/null +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/storage_ceph_external_show-response.json @@ -0,0 +1,26 @@ +{ + "confirmed": false, + "task": null, + "uuid": "ced40c30-5499-48a7-8197-3e1a90b3f402", + "links": [ + { + "href": "http://192.168.204.2:6385/v1/storage_ceph_external/ced40c30-5499-48a7-8197-3e1a90b3f402", + "rel": "self" + }, + { + "href": "http://192.168.204.2:6385/storage_ceph_external/ced40c30-5499-48a7-8197-3e1a90b3f402", + "rel": "bookmark" + } + ], + "created_at": "2018-06-27T13:30:38.557700+00:00", + "updated_at": "2018-06-27T13:35:13.213177+00:00", + "capabilities": { + "cinder_pool": "cinder-volumes" + }, + "name": "ceph-ext-bk", + "services": "cinder", + "state": "configured", + "ceph_conf": "ext-ceph.conf", + "backend": "ceph-external" +} + diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent index b4f531830..334e56b65 100644 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent @@ -2200,7 +2200,7 @@ Additional capabilities info about the storage function. - @@ -3765,6 +3765,18 @@ '> + + + + + The Ceph External configuration file. + + + '> + + + + + + + + + + + The unique identifier of the storage backend. + + + + + + + + @@ -6314,6 +6332,156 @@ OAM Controller-1 IP Address. + + + + + + + List Ceph External storage backends. + + + + + + &storageBackendListParameters; + &storageCephExternalParameters; + &commonListShowParameters; + + + + + + + + &commonFaults; &getFaults; + + + + + Shows attributes of the Ceph External storage backend. + + + + + + &storageBackendListParameters; + &storageCephExternalParameters; + &commonListShowParameters; + + + + + + + + &commonFaults; &getFaults; + + + + + Add a Ceph External storage backend. + + + + + + + + + This parameter specifies the type of the backend. + Valid values are (is): ceph-external + + + + + + This parameter specifies the name of the backend. + + + + &storageBackendModifyParameters; + &storageCephExternalParameters; + + + + + + + + + + + + &storageBackendListParameters; + &storageCephExternalParameters; + &commonListShowParameters; + + + + + + + + &postPutFaults; + + + + + Modifies the Ceph External storage backend. + + + + + + &storageBackendModifyParameters; + &storageCephExternalParameters; + + + + + + + + + + + + &storageBackendListParameters; + &storageCephExternalParameters; + &commonListShowParameters; + + + + + + + + &postPutFaults; + + + + + Deletes a ceph External storage backend. + + + + + + + + + +