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
This commit is contained in:
Sivasathurappan Radhakrishnan 2016-06-02 22:30:53 +00:00 committed by John Garbutt
parent f610cbc8cc
commit e1f29a7e9b

View File

@ -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).
"""),
]