summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2015-10-05 13:19:59 -0500
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2015-10-05 13:19:59 -0500
commit470723f1c9eabbeec63bba154e6d5c6dc75153ac (patch)
tree63c1e4b6b6a3e7b589bb4380d4a1bd073d94b519 /doc
parent35a2ad1d76790b62b3dbb41cb7fa112c81dc4d5f (diff)
parent3d2fca1e8573d60e67bb2fe642fb78c517d5ccc2 (diff)
downloadbcfg2-470723f1c9eabbeec63bba154e6d5c6dc75153ac.tar.gz
bcfg2-470723f1c9eabbeec63bba154e6d5c6dc75153ac.tar.bz2
bcfg2-470723f1c9eabbeec63bba154e6d5c6dc75153ac.zip
Merge pull request #299 from AlexanderS/fix/caching
Expire metadata cache in all Connector plugins.
Diffstat (limited to 'doc')
-rw-r--r--doc/development/plugins.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/development/plugins.txt b/doc/development/plugins.txt
index d292c9dd7..0d524973e 100644
--- a/doc/development/plugins.txt
+++ b/doc/development/plugins.txt
@@ -118,7 +118,9 @@ Invalidating Caches
In Bcfg2 1.3.0, some limited :ref:`server-caching` was introduced. If
you are writing a :class:`Bcfg2.Server.Plugin.interfaces.Connector`
plugin that implements
-:func:`Bcfg2.Server.Plugin.interfaces.Connector.get_additional_groups`,
+:func:`Bcfg2.Server.Plugin.interfaces.Connector.get_additional_groups`
+or
+:func:`Bcfg2.Server.Plugin.interfaces.Connector.get_additional_data`,
then you need to be able to invalidate the server metadata cache in
order to be compatible with the ``cautious`` or ``aggressive`` caching
modes.
@@ -140,9 +142,9 @@ called with one string argument, it expires cached data for the named
client.
It's important, therefore, that your Connector plugin can either track
-when changes are made to the group membership it reports, and expire
-cached data appropriately when in ``cautious`` or ``aggressive`` mode;
-or prudently flag an incompatibility with those two modes.
+when changes are made to the data or group membership it reports, and
+expire cached data appropriately when in ``cautious`` or ``aggressive``
+mode; or prudently flag an incompatibility with those two modes.
For examples, see: