Improve keystone.conf [catalog] documentation
Change-Id: Ib106cb075d58ee69b0e72101b9b0122ebee58913
This commit is contained in:
parent
a2d1fbad6f
commit
85be70c85d
|
@ -19,15 +19,19 @@ template_file = cfg.StrOpt(
|
|||
'template_file',
|
||||
default='default_catalog.templates',
|
||||
help=utils.fmt("""
|
||||
Catalog template file name for use with the template catalog backend.
|
||||
Absolute path to the file used for the templated catalog backend. This option
|
||||
is only used if the `[catalog] driver` is set to `templated`.
|
||||
"""))
|
||||
|
||||
driver = cfg.StrOpt(
|
||||
'driver',
|
||||
default='sql',
|
||||
help=utils.fmt("""
|
||||
Entrypoint for the catalog backend driver in the keystone.catalog namespace.
|
||||
Supplied drivers are kvs, sql, templated, and endpoint_filter.sql
|
||||
Entry point for the catalog driver in the `keystone.catalog` namespace.
|
||||
Keystone provides a `sql` option (which supports basic CRUD operations through
|
||||
SQL), a `templated` option (which loads the catalog from a templated catalog
|
||||
file on disk), and a `endpoint_filter.sql` option (which supports arbitrary
|
||||
service catalogs per project).
|
||||
"""))
|
||||
|
||||
aching = cfg.BoolOpt(
|
||||
|
@ -35,20 +39,24 @@ aching = cfg.BoolOpt(
|
|||
default=True,
|
||||
help=utils.fmt("""
|
||||
Toggle for catalog caching. This has no effect unless global caching is
|
||||
enabled.
|
||||
enabled. In a typical deployment, there is no reason to disable this.
|
||||
"""))
|
||||
|
||||
cache_time = cfg.IntOpt(
|
||||
'cache_time',
|
||||
help=utils.fmt("""
|
||||
Time to cache catalog data (in seconds). This has no effect unless global and
|
||||
catalog caching are enabled.
|
||||
catalog caching are both enabled. Catalog data (services, endpoints, etc.)
|
||||
typically does not change frequently, and so a longer duration than the global
|
||||
default may be desirable.
|
||||
"""))
|
||||
|
||||
list_limit = cfg.IntOpt(
|
||||
'list_limit',
|
||||
help=utils.fmt("""
|
||||
Maximum number of entities that will be returned in a catalog collection.
|
||||
Maximum number of entities that will be returned in a catalog collection. There
|
||||
is typically no reason to set this, as it would be unusual for a deployment to
|
||||
have enough services or endpoints to exceed a reasonable limit.
|
||||
"""))
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue