From c00c98209d1af763a62441e1048708ddc6f1b388 Mon Sep 17 00:00:00 2001 From: Rodrigo Duarte Sousa Date: Mon, 17 Nov 2014 13:13:18 -0300 Subject: [PATCH] Adds Memcached dependencies doc Since Memcached is not used by the majority of deployments, its dependencies are not included by default in the requirements.txt file. This patch adds the documentation about the need to manually install those dependencies. Change-Id: Ic6252b1e00168fa2236f8a892212084da6cfdd64 Closes-Bug: 1392264 --- doc/source/middlewarearchitecture.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/source/middlewarearchitecture.rst b/doc/source/middlewarearchitecture.rst index be2c690a..e93bc4b9 100644 --- a/doc/source/middlewarearchitecture.rst +++ b/doc/source/middlewarearchitecture.rst @@ -365,6 +365,18 @@ provide the ``cache`` option. * ``cache``: (optional) if defined, the environment key where the Swift MemcacheRing object is stored. +Memcached dependencies +====================== + +In order to use `memcached`_ it is necessary to install the `python-memcached`_ +library. If data stored in `memcached`_ will need to be encrypted it is also +necessary to install the `pycrypto`_ library. These libs are not listed in +the requirements.txt file. + +.. _`memcached`: http://memcached.org/ +.. _`python-memcached`: https://pypi.python.org/pypi/python-memcached +.. _`pycrypto`: https://pypi.python.org/pypi/pycrypto + Memcached and System Time ========================= @@ -374,8 +386,6 @@ time in determining whether a key has expired, whereas Keystone sets key expiry in UTC. The timezone used by Keystone and memcached must match if key expiry is to behave as expected. -.. _`memcached`: http://memcached.org/ - Memcache Protection ===================