"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/source/admin/caching-layer.inc" between
keystone-17.0.0.tar.gz and keystone-18.0.0.tar.gz

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 (latest release).

caching-layer.inc  (keystone-17.0.0):caching-layer.inc  (keystone-18.0.0)
.. -*- rst -*- .. -*- rst -*-
.. _caching_layer:
Caching layer Caching layer
============= =============
OpenStack Identity supports a caching layer that is above the configurable OpenStack Identity supports a caching layer that is above the configurable
subsystems (for example, token). This gives you the flexibility to setup subsystems (for example, token). This gives you the flexibility to setup
caching for all or some subsystems. OpenStack Identity uses the `oslo.cache caching for all or some subsystems. OpenStack Identity uses the `oslo.cache
<https://docs.openstack.org/oslo.cache/latest/>`__ library which allows <https://docs.openstack.org/oslo.cache/latest/>`__ library which allows
flexible cache back ends. The majority of the caching configuration options are flexible cache back ends. The majority of the caching configuration options are
set in the ``[cache]`` section of the ``/etc/keystone/keystone.conf`` file. The set in the ``[cache]`` section of the ``/etc/keystone/keystone.conf`` file. The
``enabled`` option of the ``[cache]`` section must be set to ``True`` in order ``enabled`` option of the ``[cache]`` section must be set to ``True`` in order
skipping to change at line 165 skipping to change at line 167
.. note:: .. note::
The memory back end is not suitable for use in a production The memory back end is not suitable for use in a production
environment. environment.
- `dogpile.cache.redis <https://dogpilecache.sqlalchemy.org/en/latest/api.html#r edis-backends>`__ - `dogpile.cache.redis <https://dogpilecache.sqlalchemy.org/en/latest/api.html#r edis-backends>`__
- `dogpile.cache.dbm <https://dogpilecache.sqlalchemy.org/en/latest/api.html#fil e-backends>`__ - `dogpile.cache.dbm <https://dogpilecache.sqlalchemy.org/en/latest/api.html#fil e-backends>`__
.. _cache_invalidation:
Cache invalidation Cache invalidation
------------------ ------------------
A common concern with caching is relaying inaccurate information after updating A common concern with caching is relaying inaccurate information after updating
or deleting a resource. Most subsystems within OpenStack Identity invalidate or deleting a resource. Most subsystems within OpenStack Identity invalidate
specific cache entries once they have changed. In cases where a specific cache specific cache entries once they have changed. In cases where a specific cache
entry cannot be invalidated from the cache, the cache region will be entry cannot be invalidated from the cache, the cache region will be
invalidated instead. This invalidates all entries within the cache to prevent invalidated instead. This invalidates all entries within the cache to prevent
returning stale or misleading data. A subsequent request for the resource will returning stale or misleading data. A subsequent request for the resource will
be fully processed and cached. be fully processed and cached.
skipping to change at line 200 skipping to change at line 204
.. code-block:: ini .. code-block:: ini
[cache] [cache]
enabled = true enabled = true
backend = dogpile.cache.memcached backend = dogpile.cache.memcached
backend_argument = url:127.0.0.1:11211 backend_argument = url:127.0.0.1:11211
You need to specify the URL to reach the ``memcached`` instance with the You need to specify the URL to reach the ``memcached`` instance with the
``backend_argument`` parameter. ``backend_argument`` parameter.
Verbose cache logging
---------------------
We do not recommend using verbose cache logging by default in production
systems since it's extremely noisy. However, you may need to debug cache
issues. One way to see how keystone is interacting with a cache backend is to
enhance logging. The following configuration will aggregate oslo and dogpile
logs into keystone's log file with increased verbosity:
.. code-block:: ini
[DEFAULT]
default_log_levels = oslo.cache=DEBUG,dogpile.core.dogpile=DEBUG
[cache]
debug_cache_backend = True
These logs will include cache hits and misses, making it easier to diagnose
cache configuration and connectivity issues.
 End of changes. 3 change blocks. 
0 lines changed or deleted 4 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)