From 970cf8b9c034ee61713e35f0f0909f1d043f5342 Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Tue, 8 Oct 2019 10:08:29 +0200 Subject: [PATCH] docs: clarified the relation between retention period and table period --- docs/configuration/README.md | 3 ++- docs/operations/storage/retention.md | 6 ++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/configuration/README.md b/docs/configuration/README.md index 55988200e7cad..3e8f5aed5d4f4 100644 --- a/docs/configuration/README.md +++ b/docs/configuration/README.md @@ -745,7 +745,8 @@ and how to provision tables when DynamoDB is used as the backing store. [retention_deletes_enabled: | default = false] # How far back tables will be kept before they are deleted. 0s disables -# deletion. +# deletion. The retention period must be a multiple of the index / chunks +# table "period" (see period_config). [retention_period: | default = 0s] # Period with which the table manager will poll for tables. diff --git a/docs/operations/storage/retention.md b/docs/operations/storage/retention.md index afcf2e08c0cce..9c0c3c19954a0 100644 --- a/docs/operations/storage/retention.md +++ b/docs/operations/storage/retention.md @@ -10,8 +10,10 @@ Alternatively, the `table-manager.retention-period` and provided retention period needs to be a duration represented as a string that can be parsed using Go's [time.Duration](https://golang.org/pkg/time/#ParseDuration). -> **WARNING**: The retention period should be at least twice the [duration of -the periodic table config](https://github.com/grafana/loki/blob/347a3e18f4976d799d51a26cee229efbc27ef6c9/production/helm/loki/values.yaml#L53), which currently defaults to 7 days. +> **WARNING**: The retention period must be a multiple of the index and chunks table +`period`, configured in the [`period_config`](../../configuration/README.md#period_config) +block. See the [Table Manager](./table-manager.md#retention) documentation for +more information. When using S3 or GCS, the bucket storing the chunks needs to have the expiry policy set correctly. For more details check