openstack/cinder
Code Issues Proposed changes

Merge "api-ref: clarify retype docs around default policy permissions"

Browse Source
This commit is contained in:
Jenkins 2017-06-16 15:36:30 +00:00 committed by Gerrit Code Review
commit 464e8fc8ea
4 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-ref/source/v2/parameters.yaml
View File

@ -973,8 +973,13 @@ metadata_items:
type: integer type: integer
migration_policy: migration_policy:
description: | description: |
Specify if make migration when retyping volume, the value is 'on-demand' Specify if the volume should be migrated when it is re-typed.
or 'never'. Possible values are ``on-demand`` or ``never``. If not specified, the
default is ``never``.
.. note:: If the volume is attached to a server instance and will be
migrated, then by default policy only users with the administrative role
should attempt the retype operation.
in: body in: body
required: false required: false
type: string type: string

4
api-ref/source/v2/volumes-v2-volumes-actions.inc
View File

@ -315,6 +315,10 @@ Change type of existing volume. Specify the ``os-retype`` action in the request
Change the volume type of existing volume, Cinder may migrate the volume to Change the volume type of existing volume, Cinder may migrate the volume to
proper volume host according to the new volume type. proper volume host according to the new volume type.
Policy defaults enable only users with the administrative role or the owner of
the volume to perform this operation. Cloud providers can change these
permissions through the policy.json file.
Normal response codes: 202 Normal response codes: 202

9
api-ref/source/v3/parameters.yaml
View File

@ -1187,8 +1187,13 @@ metadata_items:
type: integer type: integer
migration_policy: migration_policy:
description: | description: |
Specify if make migration when retyping volume, the value is 'on-demand' Specify if the volume should be migrated when it is re-typed.
or 'never'. Possible values are ``on-demand`` or ``never``. If not specified, the
default is ``never``.
.. note:: If the volume is attached to a server instance and will be
migrated, then by default policy only users with the administrative role
should attempt the retype operation.
in: body in: body
required: false required: false
type: string type: string

4
api-ref/source/v3/volumes-v3-volumes-actions.inc
View File

@ -312,6 +312,10 @@ Change type of existing volume. Specify the ``os-retype`` action in the request
Change the volume type of existing volume, Cinder may migrate the volume to Change the volume type of existing volume, Cinder may migrate the volume to
proper volume host according to the new volume type. proper volume host according to the new volume type.
Policy defaults enable only users with the administrative role or the owner of
the volume to perform this operation. Cloud providers can change these
permissions through the policy.json file.
Normal response codes: 202 Normal response codes: 202