Improving help text for metadefs config option
Adding improved help text for the config option used to specify the location of the metadefs JSON files. Change-Id: Ia943444ac30c816e3e7f7e08d854334c106338cb Partial-bug: #1570946
This commit is contained in:
parent
34b34a806a
commit
5085b29bc2
|
@ -38,9 +38,28 @@ from glance.i18n import _, _LE, _LI, _LW
|
|||
LOG = logging.getLogger(__name__)
|
||||
|
||||
metadata_opts = [
|
||||
cfg.StrOpt('metadata_source_path', default='/etc/glance/metadefs/',
|
||||
help=_('Path to the directory where json metadata '
|
||||
'files are stored'))
|
||||
cfg.StrOpt('metadata_source_path',
|
||||
default='/etc/glance/metadefs/',
|
||||
help=_("""
|
||||
Absolute path to the directory where JSON metadefs files are stored.
|
||||
|
||||
Glance Metadata Definitions ("metadefs") are served from the database,
|
||||
but are stored in files in the JSON format. The files in this
|
||||
directory are used to initialize the metadefs in the database.
|
||||
Additionally, when metadefs are exported from the database, the files
|
||||
are written to this directory.
|
||||
|
||||
NOTE: If you plan to export metadefs, make sure that this directory
|
||||
has write permissions set for the user being used to run the
|
||||
glance-api service.
|
||||
|
||||
Possible values:
|
||||
* String value representing a valid absolute pathname
|
||||
|
||||
Related options:
|
||||
* None
|
||||
|
||||
""")),
|
||||
]
|
||||
|
||||
CONF = cfg.CONF
|
||||
|
|
Loading…
Reference in New Issue