Skip to content

Commit 4b9973b

Browse files
committed
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: I2911098505a99658e04ac4008e5f3e857db81f95
1 parent 7505831 commit 4b9973b

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

doc/source/cli/command-objects/volume-type.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ Create new volume type
6262

6363
.. option:: --encryption-provider <provider>
6464

65-
Set the class that provides encryption support for this volume type
66-
(e.g "LuksEncryptor") (admin only)
65+
Set the encryption provider format for this volume type
66+
(e.g "luks" or "plain") (admin only)
6767

6868
This option is required when setting encryption type of a volume.
6969
Consider using other encryption options such as: :option:`--encryption-cipher`,
@@ -197,8 +197,8 @@ Set volume type properties
197197

198198
.. option:: --encryption-provider <provider>
199199

200-
Set the class that provides encryption support for this volume type
201-
(e.g "LuksEncryptor") (admin only)
200+
Set the encryption provider format for this volume type
201+
(e.g "luks" or "plain") (admin only)
202202

203203
This option is required when setting encryption type of a volume for the first time.
204204
Consider using other encryption options such as: :option:`--encryption-cipher`,

openstackclient/volume/v1/volume_type.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ def get_parser(self, prog_name):
7070
parser.add_argument(
7171
'--encryption-provider',
7272
metavar='<provider>',
73-
help=_('Set the class that provides encryption support for '
74-
'this volume type (e.g "LuksEncryptor") (admin only) '
73+
help=_('Set the encryption provider format for '
74+
'this volume type (e.g "luks" or "plain") (admin only) '
7575
'(This option is required when setting encryption type '
7676
'of a volume. Consider using other encryption options '
7777
'such as: "--encryption-cipher", "--encryption-key-size" '
@@ -254,8 +254,8 @@ def get_parser(self, prog_name):
254254
parser.add_argument(
255255
'--encryption-provider',
256256
metavar='<provider>',
257-
help=_('Set the class that provides encryption support for '
258-
'this volume type (e.g "LuksEncryptor") (admin only) '
257+
help=_('Set the encryption provider format for '
258+
'this volume type (e.g "luks" or "plain") (admin only) '
259259
'(This option is required when setting encryption type '
260260
'of a volume. Consider using other encryption options '
261261
'such as: "--encryption-cipher", "--encryption-key-size" '

openstackclient/volume/v2/volume_type.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ def get_parser(self, prog_name):
112112
parser.add_argument(
113113
'--encryption-provider',
114114
metavar='<provider>',
115-
help=_('Set the class that provides encryption support for '
116-
'this volume type (e.g "LuksEncryptor") (admin only) '
115+
help=_('Set the encryption provider format for '
116+
'this volume type (e.g "luks" or "plain") (admin only) '
117117
'(This option is required when setting encryption type '
118118
'of a volume. Consider using other encryption options '
119119
'such as: "--encryption-cipher", "--encryption-key-size" '
@@ -371,8 +371,8 @@ def get_parser(self, prog_name):
371371
parser.add_argument(
372372
'--encryption-provider',
373373
metavar='<provider>',
374-
help=_('Set the class that provides encryption support for '
375-
'this volume type (e.g "LuksEncryptor") (admin only) '
374+
help=_('Set the encryption provider format for '
375+
'this volume type (e.g "luks" or "plain") (admin only) '
376376
'(This option is required when setting encryption type '
377377
'of a volume for the first time. Consider using other '
378378
'encryption options such as: "--encryption-cipher", '

0 commit comments

Comments
 (0)