Comments are misleading as memcache_servers option configures only the token backend, but not the cache backend

Bug #1523393 reported by Toni Ylenius
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
puppet-keystone
Fix Released
Medium
Alex Schultz

Bug Description

Currently 'memcache_servers' option doesn't configure 'memcache_servers' in [cache] section as one would assume at first glance, but it sets 'servers' in [keystone] section. I consider this as a bug as puppet documentation in keystone.pp is misleading and one can understand that the option is related to caching.

The comment regarding the 'memcache_servers' states that it used with a token driver,
#
# [*memcache_servers*]
# (optional) List of memcache servers in format of server:port.
# Used with token_driver 'keystone.token.backends.memcache.Token'.
# Defaults to false. Example: ['localhost:11211']
#
but I misunderstood from the following comment that when I configure 'memcache_servers' and 'cache_backend' I will get a working cache
#
# [*cache_backend*]
# (optional) Dogpile.cache backend module. It is recommended that Memcache with pooling
# (keystone.cache.memcache_pool) or Redis (dogpile.cache.redis) be used in production.
# This has no effects unless 'memcache_servers' is set.
# Defaults to 'keystone.common.cache.noop'

I think that we should
a) configure memcache_servers option to set the 'cache/memcache_servers' also,
b) relax the dependency on memcache_servers from 'cache*' options and clearly state that these are not related,
b) or add an another option to configure caching servers and change the 'cache*' parameters to depend on the new option.

Changed in puppet-keystone:
status: New → Triaged
importance: Undecided → Low
importance: Low → Medium
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to puppet-keystone (master)

Fix proposed to branch: master
Review: https://review.openstack.org/262580

Changed in puppet-keystone:
assignee: nobody → Alex Schultz (alex-schultz)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to puppet-keystone (master)

Reviewed: https://review.openstack.org/262580
Committed: https://git.openstack.org/cgit/openstack/puppet-keystone/commit/?id=e5a4ad15de083e4f1bf06953efdd3f12b8c53259
Submitter: Jenkins
Branch: master

commit e5a4ad15de083e4f1bf06953efdd3f12b8c53259
Author: Alex Schultz <email address hidden>
Date: Wed Dec 30 11:30:56 2015 -0700

    Fix cache and cache memcache configurations

    This change adds the ability to manage the cache memcache servers.
    Previously we were enabling the cache if memcache servers were set but
    improperly configuring the cache configuration options for keystone.
    The memcache servers were being set for memcache/servers but
    the cache configuration looks at cache/memcache_servers for its server
    list. With this change we are adding a cache_memcache_servers parameter
    to allow the configuring the cache/memcache_servers. We are continuing to
    use the memcache_servers as the default if cache_memcache_servers is not
    provided.

    Additionally we are allowing the manual enabling and disabling of the
    cache configuration but will fall back to the previous behaviour
    of enabling the cache if memcache servers are specified.

    New parameters are:
      - cache_memcache_servers
      - cache_enabled

    Change-Id: I6f86c7f8f55a6f7a7e8caa922c55e618fec8e392
    Closes-Bug: #1523393

Changed in puppet-keystone:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.