[api-ref]API doc reference missing "volume type encryption create"

Bug #1562043 reported by Sheel Rana on 2016-03-25
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Cinder
Medium
wangxiyuan

Bug Description

API doc reference misses encryption-type-create for volume types

cinder encryption-type-create [--cipher <cipher>]
                                     [--key_size <key_size>]
                                     [--control_location <control_location>]
                                     <volume_type> <provider>

Creates encryption type for a volume type. Admin only.

Positional arguments:
  <volume_type> Name or ID of volume type.
  <provider> The class that provides encryption support. For
                        example, LuksEncryptor.

Optional arguments:
  --cipher <cipher> The encryption algorithm or mode. For example, aes-
                        xts-plain64. Default=None.
  --key_size <key_size>
                        Size of encryption key, in bits. For example, 128 or
                        256. Default=None.
  --control_location <control_location>
                        Notional service where encryption is performed. Valid
                        values are "front-end" or "back-end." For example,
                        front-end=Nova. Default is "front-end."

Changed in openstack-api-site:
assignee: nobody → Sheel Rana (ranasheel2000)
status: New → In Progress
Atsushi SAKAI (sakaia) on 2016-05-15
affects: openstack-api-site → cinder
summary: - API doc reference missing "volume type encryption create"
+ [api-ref]API doc reference missing "volume type encryption create"
tags: added: api-ref
Changed in cinder:
importance: Undecided → Medium
Changed in cinder:
assignee: Sheel Rana (ranasheel2000) → nobody
Steve Martinelli (stevemar) wrote :

Can we please get these APIs put online? I can't find the online at all. Making any thing client based is made exceedingly difficult if there is no API to follow. The only things available right now are 1) the python bindings which just ask for a "specs" parameter [1] and 2) the parameters being asked in the CLI [2], which explain nothing about what the defaults are on the server side.

If this feature is supported by the cinder team it should have a public API and not expect users to read source code to figure out how to use it. The bug has been open for 9 months, please reprioritize the importance of the open API bugs.

[1] https://github.com/openstack/python-cinderclient/blob/master/cinderclient/v2/volume_encryption_types.py#L70-L80

[2] https://github.com/openstack/python-cinderclient/blob/master/cinderclient/v2/shell.py#L1767-L1779

wangxiyuan (wangxiyuan) on 2016-12-28
Changed in cinder:
assignee: nobody → wangxiyuan (wangxiyuan)

Reviewed: https://review.openstack.org/415320
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=3f7200b6da8d79052e86f329a0732be4e1471ea2
Submitter: Jenkins
Branch: master

commit 3f7200b6da8d79052e86f329a0732be4e1471ea2
Author: wangxiyuan <email address hidden>
Date: Wed Dec 28 10:38:49 2016 +0800

    [api-ref]Add api ref for "volume type encryption"

    the api ref for "volume type encryption" is missing.

    Change-Id: I4320426ac8270da4922f4ae3d8b1ca8d732f25b1
    Closes-bug: #1562043

Changed in cinder:
status: In Progress → Fix Released

This issue was fixed in the openstack/cinder 10.0.0.0b3 development milestone.

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers