254 Commits

Author SHA1 Message Date
Zuul
9480b305d2 Merge "Api-ref:Add target volume preconditions for backup restore." 2018-03-10 01:44:59 +00:00
Zuul
a900054f26 Merge "Add 'list_volume' in Group show&list API Doc" 2018-03-08 06:39:01 +00:00
Zuul
bb71d676db Merge "Correct attachment create success response code" 2018-03-07 22:10:18 +00:00
TommyLike
1a2a0d4996 Add 'list_volume' in Group show&list API Doc
Add API document for 'list_volume' in Group
show&list APIs.

Code patch: https://review.openstack.org/#/c/409694

Change-Id: Ib328b62c61ec8b8afed3de07020c7ae2bfb163be
2018-03-07 14:50:44 +08:00
liuyamin
bd9bd9612f [api-ref] Fix 'volume_id' for in the v3/volumes-v3-volumes-actions.inc
The 'volume_id' in "Revert volume to snapshot" shoud be in the path.
So fix the paremeter.

Change-Id: Ia3e791f82f11740533e4320d546cb0cd67942712
2018-03-05 17:46:36 +08:00
shaoxj
690357e224 Api-ref:Add target volume preconditions for backup restore.
the status of volume must be available.
the size of the volume must be equal to or greater than
the backup size.

Change-Id: I89bb72741aec5e73789a5a5cec1bc363f79c766c
2018-02-26 01:32:13 +00:00
Zuul
ce6f6b50a7 Merge "Fix json data format" 2018-02-25 11:51:08 +00:00
Sean McGinnis
fa353b2804 Correct attachment create success response code
The attachment create call was returning HTTP ACCEPTED, which
implies an asynchronous operation. This call is not async, so
corrected this to return SUCCESS instead.

Change-Id: Ieae4e883a77ede0ba0c8a5fca4423f45e0212b2b
Closes-bug: #1747481
2018-02-15 11:33:53 -06:00
Matt Riedemann
d9a32fd7bf api-ref: note that force detach is admin-only by default
I had to dig into the code to figure out that the force
detach volume action was for admins by default. We should
make that clear in the API reference.

Change-Id: I3493e23dba8267fb7e403d30dd0d1e90c8f7726b
2018-02-15 09:21:04 -05:00
Zuul
b8a5ff5d7e Merge "Remove unused parameters in v2/v3 parameters.yaml" 2018-02-08 12:44:33 +00:00
zhangbailin
864eab12d6 Fix json data format
Remove extra comma from sample json file.

Change-Id: Id49838597b9e4f59742c1371d5be7159deabb002
2018-02-07 16:57:15 +08:00
lihaijing
ba9eaf27af Api-ref: add 'all_tenants' API query option
Cinder REST API allows one to use a special query parameter
named "all_tenants" to list resources from all projects (tenants)
through the REST API:

`/v3/{project_id}/volumes/detail?all_tenants=1`

However, this option is hardly documented anywhere besides
`/v3/{project_id}/volumes/summary`. So add them.

Change-Id: Ia9cc9e20c3b333a054c90f07e952b61dfad8529e
Closes-Bug: #1743800
2018-02-07 01:11:49 +00:00
Zuul
c5e2eda9e6 Merge "Update the description of quota's project id" 2018-02-03 18:50:21 +00:00
TommyLike
934675eca7 Update document for worker cleanup API
Update API document for API 'workers/cleanup',
also remove 'until' from allowed clean keys as
its value is always assigned in code.

Change-Id: Iea940d7c7e52718b8e5e8dcf706aa5d1126860ef
2018-02-02 13:32:34 +00:00
liuyamin
e3a873dbd8 Remove unused parameters in v2/v3 parameters.yaml
Change-Id: I835dda262b22af8fe7a0af1a1333bf9842d65013
2018-02-01 23:12:18 +08:00
Zuul
59bfe72bd5 Merge "api-ref: add multiattach considerations to retype docs" 2018-01-27 01:36:56 +00:00
Matt Riedemann
2e1d31a44a api-ref: add multiattach considerations to retype docs
This adds some notes about two things to consider with a volume
retype operation on an in-use multiattach volume:

1. The volume API will reject a retype operation on an in-use volume
   where the volume's multiattach value would change.

2. Retyping an in-use volume that has more than one active read/write
   attachment is not recommended because on the nova side the swap
   volume operation performs a blockRebase which could potentially
   lead to data corruption.

In the future, we (nova or cinder or both) will likely need to make
some changes as to what the default attach_mode is for secondary
attachments to a multiattach volume, since today we default to read/write
if it's not specified by the caller when making the attachment.

Change-Id: Ib5a2830ea3cd37236947677225252ef42edaa347
2018-01-25 13:48:05 -05:00
Matt Riedemann
aff9ca2b37 api-ref: update migration_policy retype note about encrypted volumes
Nova has historically not supported swap volume operations (via
cinder volume retype / volume migration) for an in-use encrypted
volume.

That was recently addressed via nova bug 1739593.

However, as of change Ibfa64f18bbd2fb70db7791330ed1a64fe61c1355
in nova, depending on the version of libvirt/qemu on the compute host,
a luks-encrypted volume will use native qemu luks decryption. That
does not yet support blockRebase operations which are used during
swap volume due to https://bugzilla.redhat.com/show_bug.cgi?id=760547.

So it's safe to say that for now, a retype which involves a volume
migration is not supported for an in-use encrypted volume.

Change-Id: I7ce992f51d50d00950d3fc4ebb44b69a31a94787
Related-Bug: #1739593
2018-01-25 13:15:48 -05:00
TommyLike
7fdf33b4be Update the description of quota's project id
Instead of QoS id, project id should be used for
quota's id attribute.

Change-Id: I201350caa984b66baf38ce9d74d09c7eda913034
2018-01-25 11:38:19 +08:00
zhangbailin
23b56315b1 Remove extra spaces of the volume creation request body
Change-Id: I7fc3ccd24cd9e95cb4fa1d70658fe064cae3a38a
2018-01-22 18:06:39 +08:00
Zuul
8c01fd74cc Merge "Fix api-ref for v3 volume group types" 2018-01-18 18:40:33 +00:00
Zuul
988818388f Merge "api-ref: fix the response parameter for multiattach" 2018-01-18 17:39:42 +00:00
jeremy.zhang
6892dd6047 Fix api-ref for v3 volume group types
This patch is mainly to fix api-ref for v3 volume group types,
including:

1. add description and example for the API: show defaut group type
2. fix parameters: 'is_public' and 'description'
3. remove unused sample file: group-type-show-request.json

Change-Id: I29f160d8ed24473debb345b4ea91ee0545d711b1
2018-01-18 08:56:17 +00:00
Zuul
b39076f2d7 Merge "Fix api-ref for v3 volume types" 2018-01-18 06:45:46 +00:00
Zuul
0fbd95941d Merge "Fix api-ref for v3 Services" 2018-01-18 03:47:21 +00:00
jeremy.zhang
0d371e98bb Fix api-ref for v3 volume types
This patch dome some fixs on api-ref for v3 volume types, including:

1. add api-ref and sample file for show default volume type API
2. remove unused sample file: volume-type-show-request.json
3. fix parameters: 'name', 'extra_specs', 'is_public', 'description',
and 'os-volume-type-access:is_public'

Change-Id: I6fdcb66d3a56643a5e71bcd68f4bcdc08fc4866b
2018-01-17 17:27:26 +08:00
liuyamin
71ed703814 Fix api-ref for v3 Services
This patch is mainly to fix the request parameters for
the Disabled Cinder Service APIs.

Change-Id: I112793716c1f00cc953bd960fa13be67612ed6ac
2018-01-15 16:45:04 +08:00
liuyamin
88a21ab20e Fix 'volume_type' for in the api-ref
1 The 'volume_type' shoud be required in the rest_method of request.
  So fix the request paremeter about volume_type
2 Fix  the parameters of 'volume_type' in the volumes-v3-volumes.inc

Change-Id: I585db62579ac134885a49dc020508a9f0fba3c78
2018-01-15 14:19:26 +08:00
Matt Riedemann
fe670324f5 api-ref: fix the response parameter for multiattach
The multiattach parameter is optional when creating
a volume but is required to be in the response when
showing a volume.

This fixes the parameter usage, renames the parameters
so they are more clear (multiattach_1 was for the response
but was never used), and also adds a note to the multiattach
request parameter about how support is dependent on the volume
type being used to create the volume.

Change-Id: Ifaa29140a8e8a9b8090f33fb83e4bb5c98ee847f
2018-01-10 21:48:30 -05:00
Xiaojun Liao
6c67df70b4 Fix v3 api-ref for showing API details url error
Client were receiving the 302/Found when using the url "/v3".
For showing API v3 details, it should have a '/' behind.

Closes-Bug:#1734053

Change-Id: I7e6cb991151fba19dcaecaf95b332fddc1c02deb
Signed-off-by: Xiaojun Liao <xiaojunliao85@gmail.com>
2018-01-06 02:24:06 +00:00
Zuul
14690c425e Merge "Fix api-ref for v3 volume types" 2018-01-05 21:13:22 +00:00
Zuul
f216c5ea6f Merge "Add microversion and volume status limit to revert api ref doc" 2018-01-05 01:29:44 +00:00
Ildiko Vancsa
3d25dfb132 [api-ref] Add missing fields to the API Reference
Adding the 'service_uuid' and 'shared_targets' to the API Reference
documentation with a short description.

Closes-Bug: #1739640
Change-Id: I6866a8da47c6910ce8d2a6802839e9a06eb596a5
2018-01-04 15:40:13 +01:00
Zuul
5419ca908c Merge "Discrepancy in api-ref and code for create group type API" 2018-01-03 06:36:01 +00:00
jeremy.zhang
4783d6a4d6 Fix api-ref for v3 volume types
This patch is mainly to remove some redundant description and modify
wrongly used HTTP method in api-ref for v3 volume types.

Change-Id: I6f8911d9bc80f1c9d9889ebdf8e1bc2480df06d4
2018-01-03 10:53:01 +08:00
Zuul
70fd1603d2 Merge "Add instructions for the Error response codes" 2017-12-29 11:05:04 +00:00
Zuul
82ef221114 Merge "Fix incorrect description in api ref" 2017-12-29 00:44:20 +00:00
Zuul
cd989853c8 Merge "Update 'force' parameter for volume delete API" 2017-12-29 00:21:56 +00:00
zhangbailin
a5bbe90eb7 Add instructions for the Error response codes
Improve the http return code information, for easy
reading and calling

Change-Id: I0fa54e084070a6407d732e69ca30f6079b923f33
2017-12-26 15:43:00 +08:00
junboli
03d4539247 Fix incorrect description in api ref
most places use description of backup, such as groups,
consistency groups, snapshots .etc, this is incorrect
this patch is to correct them.

Change-Id: I079f0351c93b5f19e87a42b4b0b84ff086b83820
2017-12-26 15:06:18 +08:00
TommyLike
c1adb77461 Update 'force' parameter for volume delete API
Parameter 'force' is used in the path rather than
body, update the document.

Change-Id: I2c79d7d64b5f3c48a147410d93ae687ac0eb3cdc
2017-12-26 00:37:01 +00:00
Zuul
b3d659b29d Merge "Deprecate CG APIs" 2017-12-25 23:54:01 +00:00
Zuul
4a7b11f2d8 Merge "API ref: add host format to description" 2017-12-25 22:22:19 +00:00
Xing Yang
556ae86d38 Deprecate CG APIs
This patch prints a deprecation message when CG APIs are used and
prompts users to swich to Generic Volume Group APIs instead. CG APIs
are also marked as deprecated in API reference docs. CG APIs will be
removed in a future release when it is appropriate and will be
decided by the Cinder team. This was communicated in Pike.

Change-Id: Ib6751fae6b5fb78de98a2ea62f507f9102f71b76
2017-12-22 06:33:27 -08:00
Rui Yuan Dou
320096f0ca Add microversion and volume status limit to revert api ref doc
Change-Id: I55ca72cd26e4ae1ec9428c5785af49c5b6471b4b
2017-12-22 14:59:09 +08:00
Zuul
d45e507887 Merge "[api-ref] Fix http method for updating encryption type" 2017-12-19 00:40:39 +00:00
Zuul
f7a62652f4 Merge "Remove skip_validation_flag to False by default" 2017-12-18 21:54:25 +00:00
jeremy.zhang
f02aa85d75 [api-ref] Fix http method for updating encryption type
This patch aims to fix http method in api-ref for updating encryption
type, changing from 'POST' to 'PUT'.

Change-Id: Ief48c73eb09afe2b5ff8c391f06013ab7eebd670
2017-12-18 14:26:54 +00:00
Zuul
280e59c5b6 Merge "Fix json formatting eror" 2017-12-18 06:13:46 +00:00
Zuul
150b3b61ba Merge "Fix discrepancy in api-ref for volume_types APIs" 2017-12-14 00:59:32 +00:00