diff --git a/keystone/conf/role.py b/keystone/conf/role.py index e54fcbe8a5..569a0ec4e1 100644 --- a/keystone/conf/role.py +++ b/keystone/conf/role.py @@ -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. """))