From e1f29a7e9b28e69a889f7b2632386ccc2100b093 Mon Sep 17 00:00:00 2001 From: Sivasathurappan Radhakrishnan Date: Thu, 2 Jun 2016 22:30:53 +0000 Subject: [PATCH] Help text for the ephemeral storage options The previous commit moved ephemeral storage options to a central location. This commit adds additional help text to those options. Blueprint centralize-config-options-newton Change-Id: Iea144bd66bcfdbe0d8f20edbd50939afaf5dd602 --- nova/conf/ephemeral_storage.py | 33 +++++++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/nova/conf/ephemeral_storage.py b/nova/conf/ephemeral_storage.py index 1679d15ef781..7396f49f6edb 100644 --- a/nova/conf/ephemeral_storage.py +++ b/nova/conf/ephemeral_storage.py @@ -23,18 +23,35 @@ ephemeral_storage_encryption_group = cfg.OptGroup( ephemeral_storage_encryption_opts = [ cfg.BoolOpt('enabled', default=False, - help='Whether to encrypt ephemeral storage'), + help=""" +Enables/disables LVM ephemeral storage encryption. +"""), + cfg.StrOpt('cipher', default='aes-xts-plain64', - help='The cipher and mode to be used to encrypt ephemeral ' - 'storage. Which ciphers are available ciphers depends ' - 'on kernel support. See /proc/crypto for the list of ' - 'available options.'), + help=""" +Cipher-mode string to be used + +The cipher and mode to be used to encrypt ephemeral +storage. The set of cipher-mode combinations available +depends on kernel support. + +Possible values: + + * aes-xts-plain64 (Default), see /proc/crypto for available options. +"""), + cfg.IntOpt('key_size', default=512, - help='The bit length of the encryption key to be used to ' - 'encrypt ephemeral storage (in XTS mode only half of ' - 'the bits are used for encryption key)') + min=1, + help=""" +Encryption key length in bits + +The bit length of the encryption key to be used to +encrypt ephemeral storage (in XTS mode only half of +the bits are used for encryption key). +"""), + ]