openstack
/
keystone
Code Issues Proposed changes

Improve keystone.conf [role] documentation 

Change-Id: I0a11ef20a08beb490d23a71c29787834ac2d0996
This commit is contained in:
Dolph Mathews 2016-07-11 07:46:26 -05:00
parent 24cbd28b1f
commit a288d5c532
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
keystone/conf/role.py
View File

@ -20,8 +20,9 @@ from keystone.conf import utils
driver = cfg.StrOpt(
'driver',
help=utils.fmt("""
Entrypoint for the role backend driver in the keystone.role namespace. Only an
SQL driver is supplied
Entry point for the role backend driver in the `keystone.role` namespace.
Keystone only provides a `sql` driver, so there's no reason to change this
unless you are providing a custom entry point.
"""))
caching = cfg.BoolOpt(
@ -29,19 +30,22 @@ caching = cfg.BoolOpt(
default=True,
help=utils.fmt("""
Toggle for role caching. This has no effect unless global caching is enabled.
In a typical deployment, there is no reason to disable this.
"""))
cache_time = cfg.IntOpt(
'cache_time',
help=utils.fmt("""
TTL (in seconds) to cache role data. This has no effect unless global caching
is enabled.
Time to cache role data, in seconds. This has no effect unless both global
caching and `[role] caching` are enabled.
"""))
list_limit = cfg.IntOpt(
'list_limit',
help=utils.fmt("""
Maximum number of entities that will be returned in a role collection.
Maximum number of entities that will be returned in a role collection. This may
be useful to tune if you have a large number of discrete roles in your
deployment.
"""))