README.md in routemaster-drain-3.0.1 vs README.md in routemaster-drain-3.0.2
- old
+ new
@@ -15,10 +15,11 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [Installation](#installation)
+ - [Upgrading](#upgrading)
- [Illustrated use cases](#illustrated-use-cases)
- [Simply receive events from Routemaster](#simply-receive-events-from-routemaster)
- [Receive change notifications without duplicates](#receive-change-notifications-without-duplicates)
- [Cache data for all notified resources](#cache-data-for-all-notified-resources)
- [HTTP Client](#http-client)
@@ -74,9 +75,27 @@
Routemaster::RedisBroker.instance.inject(
drain_redis: a_redis_object,
cache_redis: another_redis_object
)
```
+
+## Upgrading
+
+
+If upgrading from any version between 2.4.0 and 3.0.1, and are using caching,
+your cache may be corrupted by entries that lack a TTL (which will eventually
+cause your Redis
+storage to blow up).
+
+We provide a tool to fix your data. With your environment loaded and configured
+(e.g. from a Rails console), run:
+
+```ruby
+Routemaster::Tasks::FixCacheTTL.new.call
+```
+
+This will scan your cache and add TTLs where missing.
+
## Illustrated use cases
### Simply receive events from Routemaster