From b6e20abe61596708eed1b33d08f7028584bee724 Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Tue, 3 Aug 2021 15:48:47 +0100 Subject: [PATCH] Docs: Documents caching encryption in enterprise config (#36766) (#37491) * Enterprise: adding documentation of two new configuration flags * Update docs/sources/enterprise/enterprise-configuration.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update enterprise-configuration.md * Fix grammar Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> (cherry picked from commit a05ae6768c7524d43346bbf336c23245632a36a8) Co-authored-by: Stephanie Hingtgen --- .../enterprise/enterprise-configuration.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/sources/enterprise/enterprise-configuration.md b/docs/sources/enterprise/enterprise-configuration.md index c1b85102a0a..c37dba6ff22 100644 --- a/docs/sources/enterprise/enterprise-configuration.md +++ b/docs/sources/enterprise/enterprise-configuration.md @@ -361,6 +361,19 @@ This value limits the size of a single cache value. If a cache value (or query r The default is `1`. +## [caching.encryption] +### enabled + +When 'enabled' is `true`, query values in the cache are encrypted. + +The default is `false`. + +### encryption_key + +A string used to generate a key for encrypting the cache. For the encrypted cache data to persist between Grafana restarts, you must specify this key. If it is empty when encryption is enabled, then the key is automatically generated on startup, and the cache clears upon restarts. + +The default is `""`. + ## [caching.memory] ### gc_interval @@ -371,7 +384,7 @@ The default is `1m`. ### max_size_mb -The maximum size of the in-memory cache in megabytes. Once this size is reached, new cache items are rejected. For more flexible control over cache eviction policies and size, use the Redis or Memcached backend. +The maximum size of the in-memory cache in megabytes. Once this size is reached, new cache items are rejected. For more flexible control over cache eviction policies and size, use the Redis or Memcached backend. To disable the maximum, set this value to `0`.