Improve keystone.conf [domain_config] documentation

Change-Id: I89a797ce4f85ad0d710d38fb0973d3bf23141807
This commit is contained in:
Dolph Mathews 2016-06-29 09:51:20 -05:00
parent 83472401ef
commit 34736ecd7d
1 changed files with 9 additions and 6 deletions

View File

@ -19,24 +19,27 @@ driver = cfg.StrOpt(
'driver', 'driver',
default='sql', default='sql',
help=utils.fmt(""" help=utils.fmt("""
Entrypoint for the domain config backend driver in the Entry point for the domain-specific configuration driver in the
keystone.resource.domain_config namespace. `keystone.resource.domain_config` namespace. Only a `sql` option is provided by
keystone, so there is no reason to set this unless you are providing a custom
entry point.
""")) """))
caching = cfg.BoolOpt( caching = cfg.BoolOpt(
'caching', 'caching',
default=True, default=True,
help=utils.fmt(""" help=utils.fmt("""
Toggle for domain config caching. This has no effect unless global caching is Toggle for caching of the domain-specific configuration backend. This has no
enabled. effect unless global caching is enabled. There is normally no reason to disable
this.
""")) """))
cache_time = cfg.IntOpt( cache_time = cfg.IntOpt(
'cache_time', 'cache_time',
default=300, default=300,
help=utils.fmt(""" help=utils.fmt("""
TTL (in seconds) to cache domain config data. This has no effect unless domain Time-to-live (TTL, in seconds) to cache domain-specific configuration data.
config caching is enabled. This has no effect unless `[domain_config] caching` is enabled.
""")) """))