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:
parent
5c5159bc09
commit
21ffefaf6b
Binary file not shown.
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 157 KiB |
|
@ -45,7 +45,7 @@ Create an encrypted volume type
|
||||||
available options (see table):
|
available options (see table):
|
||||||
|
|
||||||
Provider
|
Provider
|
||||||
Specifies the class responsible for configuring the encryption.
|
Specifies the encryption provider format.
|
||||||
Control Location
|
Control Location
|
||||||
Specifies whether the encryption is from the front end (nova) or the
|
Specifies whether the encryption is from the front end (nova) or the
|
||||||
back end (cinder).
|
back end (cinder).
|
||||||
|
@ -67,16 +67,16 @@ volumes.
|
||||||
| Encryption | Parameter | Comments |
|
| Encryption | Parameter | Comments |
|
||||||
| parameters | options | |
|
| parameters | options | |
|
||||||
+====================+=======================+============================+
|
+====================+=======================+============================+
|
||||||
| Provider |nova.volume.encryptors.|Allows easier import and |
|
| Provider | luks |Allows easier import and |
|
||||||
| |luks.LuksEncryptor |migration of imported |
|
| | (Recommended) |migration of imported |
|
||||||
| |(Recommended) |encrypted volumes, and |
|
| | |encrypted volumes, and |
|
||||||
| | |allows access key to be |
|
| | |allows access key to be |
|
||||||
| | |changed without |
|
| | |changed without |
|
||||||
| | |re-encrypting the volume |
|
| | |re-encrypting the volume |
|
||||||
+ +-----------------------+----------------------------+
|
+ +-----------------------+----------------------------+
|
||||||
| |nova.volume.encryptors.|Less disk overhead than |
|
| | plain |Less disk overhead than |
|
||||||
| |cryptsetup. |LUKS |
|
| | |LUKS |
|
||||||
| |CryptsetupEncryptor | |
|
| | | |
|
||||||
+--------------------+-----------------------+----------------------------+
|
+--------------------+-----------------------+----------------------------+
|
||||||
| Control Location | front-end |The encryption occurs within|
|
| Control Location | front-end |The encryption occurs within|
|
||||||
| | (Recommended) |nova so that the data |
|
| | (Recommended) |nova so that the data |
|
||||||
|
@ -117,8 +117,8 @@ volumes.
|
||||||
|
|
||||||
To see further information and CLI instructions, see
|
To see further information and CLI instructions, see
|
||||||
`Create an encrypted volume type
|
`Create an encrypted volume type
|
||||||
<https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-encryption.html>`__
|
<https://docs.openstack.org/cinder/latest/configuration/block-storage/volume-encryption.html#create-an-encrypted-volume-type>`__
|
||||||
in the OpenStack Configuration Reference.
|
in the OpenStack Block Storage Configuration Guide.
|
||||||
|
|
||||||
Delete volume types
|
Delete volume types
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
|
@ -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." %}
|
{% 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>
|
||||||
<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>
|
||||||
<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 %}
|
{% 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 %}
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
{% trans "Encryption information cannot be updated for a volume type if volumes are currently in use with the volume type." %}
|
{% trans "Encryption information cannot be updated for a volume type if volumes are currently in use with the volume type." %}
|
||||||
</p>
|
</p>
|
||||||
<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>
|
||||||
<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 %}
|
{% 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 %}
|
||||||
|
|
Loading…
Reference in New Issue