Block Storage API V3 (CURRENT) in cinder - create encrypt volume type does not explain provider choices

[Matt Riedemann]

- [x] This is a doc addition request.

The create encrypted volume provider type API reference:

https://developer.openstack.org/api-ref/block-storage/v3/?expanded=create-an-encryption-type-detail#create-an-encryption-type

Does not describe the choices available for the provider parameter, it just says "The class that provides encryption support".

There are several legacy options available from os-brick:

https://github.com/openstack/os-brick/blob/cb2ee2776d552335bcd402d5a4fd95ce025f44a3/os_brick/encryptors/__init__.py#L32

But it seems the two choices are ultimately just "luks" and "plain".

-----------------------------------
Release: on 2018-11-13 20:34
SHA: 18d0576bb56c589f755892bc2e821282de7c52d7
Source: https://git.openstack.org/cgit/openstack/cinder/tree/api-ref/source/v3/index.rst
URL: https://developer.openstack.org/api-ref/block-storage/v3/

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/618147

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/618147
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=e7732680e0a57a7fba52ca91df5ae4d1cb1dc51d
Submitter: Zuul
Branch: master

commit e7732680e0a57a7fba52ca91df5ae4d1cb1dc51d
Author: Matt Riedemann <email address hidden>
Date: Thu Nov 15 07:39:31 2018 -0500

    api-ref: document encryption type provider choices

    This updates the encrypted volume type provider
    parameter descriptions for the create and update
    requests to note the two choices of 'luks' and 'plain'.
    Since we don't want those choices in the response
    parameter descriptions, the parameters have to be
    broken down a bit in the parameters.yaml file to
    be request/response and optional/required.

    There are currently other supported values for the
    encryption type provider, including the legacy
    classpath values, but we want people using the
    non-legacy values so only luks and plain are
    documented here, and luks is marked as the
    recommended choice over plain (dm-crypt).

    Change-Id: I496d30ecf6390f51cdd8e547b7345b3da30e92de
    Closes-Bug: #1803513

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/cinder 14.0.0.0rc1 release candidate.