openstack
/
horizon
Code Issues Proposed changes

docs: Update help text for encryption provider 

The volume encryption provider no longer uses class names.
Instead, 'luks' and 'plain' are used. This patch updates
the help text for the volume encryption provider to use
the new encryption provider format constants.

Change-Id: I582b239d9de86aa1f1f5e55d4576cc65d33e74a7
This commit is contained in:
Brianna Poulos 2018-02-16 16:25:56 -05:00
parent 5c5159bc09
commit 21ffefaf6b
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/source/admin/figures/create_volume_type_encryption.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 157 KiB

18
doc/source/admin/manage-volumes.rst
View File

@ -45,7 +45,7 @@ Create an encrypted volume type
available options (see table):
Provider
Specifies the class responsible for configuring the encryption.
Specifies the encryption provider format.
Control Location
Specifies whether the encryption is from the front end (nova) or the
back end (cinder).
@ -67,16 +67,16 @@ volumes.
| Encryption | Parameter | Comments |
| parameters | options | |
+====================+=======================+============================+
| Provider |nova.volume.encryptors.|Allows easier import and |
| |luks.LuksEncryptor |migration of imported |
| |(Recommended) |encrypted volumes, and |
| Provider | luks |Allows easier import and |
| | (Recommended) |migration of imported |
| | |encrypted volumes, and |
| | |allows access key to be |
| | |changed without |
| | |re-encrypting the volume |
+ +-----------------------+----------------------------+
| |nova.volume.encryptors.|Less disk overhead than |
| |cryptsetup. |LUKS |
| |CryptsetupEncryptor | |
| | plain |Less disk overhead than |
| | |LUKS |
| | | |
+--------------------+-----------------------+----------------------------+
| Control Location | front-end |The encryption occurs within|
| | (Recommended) |nova so that the data |
@ -117,8 +117,8 @@ volumes.
To see further information and CLI instructions, see
`Create an encrypted volume type
<https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-encryption.html>`__
in the OpenStack Configuration Reference.
<https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-encryption.html#create-an-encrypted-volume-type>`__
in the OpenStack Block Storage Configuration Guide.
Delete volume types
~~~~~~~~~~~~~~~~~~~

2
openstack_dashboard/dashboards/admin/volume_types/templates/volume_types/_create_volume_type_encryption.html
View File

@ -7,7 +7,7 @@
{% trans "Creating encryption for a volume type causes all volumes with that volume type to be encrypted. Encryption information cannot be added to a volume type if volumes are currently in use with that volume type." %}
</p>
<p>
{% blocktrans %}The <strong>Provider</strong> is the class providing encryption support (e.g. LuksEncryptor).{% endblocktrans %}
{% blocktrans %}The <strong>Provider</strong> is the encryption provider format (e.g. 'luks' or 'plain').{% endblocktrans %}
</p>
<p>
{% blocktrans %}The <strong>Control Location</strong> is the notional service where encryption is performed (e.g., front-end=Nova). The default value is 'front-end.'{% endblocktrans %}

2
openstack_dashboard/dashboards/admin/volume_types/templates/volume_types/_update_volume_type_encryption.html
View File

@ -7,7 +7,7 @@
{% trans "Encryption information cannot be updated for a volume type if volumes are currently in use with the volume type." %}
</p>
<p>
{% blocktrans %}The <strong>Provider</strong> is the class providing encryption support (e.g., LuksEncryptor).{% endblocktrans %}
{% blocktrans %}The <strong>Provider</strong> is the encryption provider format (e.g., 'luks' or 'plain').{% endblocktrans %}
</p>
<p>
{% blocktrans %}The <strong>Control Location</strong> is the notional service where encryption is performed (e.g., front-end=Nova). The default value is 'front-end.'{% endblocktrans %}