Merge "Add "encryption-*" options in volume type commands"

1 files changed, 81 insertions, 0 deletions

diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst
index 40e9825c..afa293d7 100644
--- a/doc/source/command-objects/volume-type.rst
+++ b/doc/source/command-objects/volume-type.rst
@@ -18,6 +18,10 @@ Create new volume type
         [--property <key=value> [...] ]
         [--project <project>]
         [--project-domain <project-domain>]
+        [--encryption-provider <provider>]
+        [--encryption-cipher <cipher>]
+        [--encryption-key-size <key-size>]
+        [--encryption-control-location <control-location>]
         <name>
 
 .. option:: --description <description>
@@ -56,6 +60,34 @@ Create new volume type
 
     *Volume version 2 only*
 
+.. option:: --encryption-provider <provider>
+
+    Set the class that provides encryption support for this volume type
+    (e.g "LuksEncryptor") (admin only)
+
+    This option is required when setting encryption type of a volume.
+    Consider using other encryption options such as: :option:`--encryption-cipher`,
+    :option:`--encryption-key-size` and :option:`--encryption-control-location`
+
+.. option:: --encryption-cipher <cipher>
+
+    Set the encryption algorithm or mode for this volume type
+    (e.g "aes-xts-plain64") (admin only)
+
+.. option:: --encryption-key-size <key-size>
+
+    Set the size of the encryption key of this volume type
+    (e.g "128" or "256") (admin only)
+
+.. option:: --encryption-control-location <control-location>
+
+    Set the notional service where the encryption is performed
+    ("front-end" or "back-end") (admin only)
+
+    The default value for this option is "front-end" when setting encryption type of
+    a volume. Consider using other encryption options such as: :option:`--encryption-cipher`,
+    :option:`--encryption-key-size` and :option:`--encryption-provider`
+
 .. _volume_type_create-name:
 .. describe:: <name>
 
@@ -88,6 +120,7 @@ List volume types
     openstack volume type list
         [--long]
         [--default | --public | --private]
+        [--encryption-type]
 
 .. option:: --long
 
@@ -111,6 +144,10 @@ List volume types
 
     *Volume version 2 only*
 
+.. option:: --encryption-type
+
+    Display encryption information for each volume type (admin only)
+
 volume type set
 ---------------
 
@@ -125,6 +162,10 @@ Set volume type properties
         [--property <key=value> [...] ]
         [--project <project>]
         [--project-domain <project-domain>]
+        [--encryption-provider <provider>]
+        [--encryption-cipher <cipher>]
+        [--encryption-key-size <key-size>]
+        [--encryption-control-location <control-location>]
         <volume-type>
 
 .. option:: --name <name>
@@ -154,6 +195,34 @@ Set volume type properties
 
     Set a property on this volume type (repeat option to set multiple properties)
 
+.. option:: --encryption-provider <provider>
+
+    Set the class that provides encryption support for this volume type
+    (e.g "LuksEncryptor") (admin only)
+
+    This option is required when setting encryption type of a volume for the first time.
+    Consider using other encryption options such as: :option:`--encryption-cipher`,
+    :option:`--encryption-key-size` and :option:`--encryption-control-location`
+
+.. option:: --encryption-cipher <cipher>
+
+    Set the encryption algorithm or mode for this volume type
+    (e.g "aes-xts-plain64") (admin only)
+
+.. option:: --encryption-key-size <key-size>
+
+    Set the size of the encryption key of this volume type
+    (e.g "128" or "256") (admin only)
+
+.. option:: --encryption-control-location <control-location>
+
+    Set the notional service where the encryption is performed
+    ("front-end" or "back-end") (admin only)
+
+    The default value for this option is "front-end" when setting encryption type of
+    a volume for the first time. Consider using other encryption options such as:
+    :option:`--encryption-cipher`, :option:`--encryption-key-size` and :option:`--encryption-provider`
+
 .. _volume_type_set-volume-type:
 .. describe:: <volume-type>
 
@@ -168,8 +237,13 @@ Display volume type details
 .. code:: bash
 
     openstack volume type show
+        [--encryption-type]
         <volume-type>
 
+.. option:: --encryption-type
+
+    Display encryption information of this volume type (admin only)
+
 .. _volume_type_show-volume-type:
 .. describe:: <volume-type>
 
@@ -187,6 +261,7 @@ Unset volume type properties
         [--property <key> [...] ]
         [--project <project>]
         [--project-domain <project-domain>]
+        [--encryption-type]
         <volume-type>
 
 .. option:: --property <key>
@@ -204,6 +279,12 @@ Unset volume type properties
     Domain the project belongs to (name or ID).
     This can be used in case collisions between project names exist.
 
+    *Volume version 2 only*
+
+.. option:: --encryption-type
+
+    Remove the encryption type for this volume type (admin only)
+
 .. _volume_type_unset-volume-type:
 .. describe:: <volume-type>