keystone  18.0.0
About: OpenStack Keystone (Core Service: Identity) provides an authentication and authorization service for other OpenStack services. Provides a catalog of endpoints for all OpenStack services.
The "Victoria" series (maintained release).
  Fossies Dox: keystone-18.0.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

catalog.py
Go to the documentation of this file.
1 # Licensed under the Apache License, Version 2.0 (the "License"); you may
2 # not use this file except in compliance with the License. You may obtain
3 # a copy of the License at
4 #
5 # http://www.apache.org/licenses/LICENSE-2.0
6 #
7 # Unless required by applicable law or agreed to in writing, software
8 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
9 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
10 # License for the specific language governing permissions and limitations
11 # under the License.
12 
13 from oslo_config import cfg
14 
15 from keystone.conf import utils
16 
17 
18 template_file = cfg.StrOpt(
19  'template_file',
20  default='default_catalog.templates',
21  help=utils.fmt("""
22 Absolute path to the file used for the templated catalog backend. This option
23 is only used if the `[catalog] driver` is set to `templated`.
24 """))
25 
26 driver = cfg.StrOpt(
27  'driver',
28  default='sql',
29  help=utils.fmt("""
30 Entry point for the catalog driver in the `keystone.catalog` namespace.
31 Keystone provides a `sql` option (which supports basic CRUD operations through
32 SQL), a `templated` option (which loads the catalog from a templated catalog
33 file on disk), and a `endpoint_filter.sql` option (which supports arbitrary
34 service catalogs per project).
35 """))
36 
37 caching = cfg.BoolOpt(
38  'caching',
39  default=True,
40  help=utils.fmt("""
41 Toggle for catalog caching. This has no effect unless global caching is
42 enabled. In a typical deployment, there is no reason to disable this.
43 """))
44 
45 cache_time = cfg.IntOpt(
46  'cache_time',
47  help=utils.fmt("""
48 Time to cache catalog data (in seconds). This has no effect unless global and
49 catalog caching are both enabled. Catalog data (services, endpoints, etc.)
50 typically does not change frequently, and so a longer duration than the global
51 default may be desirable.
52 """))
53 
54 list_limit = cfg.IntOpt(
55  'list_limit',
56  help=utils.fmt("""
57 Maximum number of entities that will be returned in a catalog collection. There
58 is typically no reason to set this, as it would be unusual for a deployment to
59 have enough services or endpoints to exceed a reasonable limit.
60 """))
61 
62 
63 GROUP_NAME = __name__.split('.')[-1]
64 ALL_OPTS = [
65  template_file,
66  driver,
67  caching,
68  cache_time,
69  list_limit,
70 ]
71 
72 
73 def register_opts(conf):
74  conf.register_opts(ALL_OPTS, group=GROUP_NAME)
75 
76 
77 def list_opts():
78  return {GROUP_NAME: ALL_OPTS}
keystone.conf.catalog.list_opts
def list_opts()
Definition: catalog.py:77
keystone.conf.catalog.register_opts
def register_opts(conf)
Definition: catalog.py:73
keystone.conf
Definition: __init__.py:1