updates docs with delete permissions notice (#2819)

* updates docs with delete permissions notice * delete ref for storage doc * boltdb ref * pr feedback
grafana · Oct 27, 2020 · 3e5e461 · 3e5e461
1 parent dda945b
commit 3e5e461
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/docs/sources/operations/storage/_index.md b/docs/sources/operations/storage/_index.md
@@ -51,7 +51,7 @@ When using S3 as object storage, the following permissions are needed:
 - `s3:ListBucket`
 - `s3:PutObject`
 - `s3:GetObject`
-- `s3:DeleteObject` (if running the compactor)
+- `s3:DeleteObject` (if running the Single Store (boltdb-shipper) compactor)
 
 Resources: `arn:aws:s3:::<bucket_name>`, `arn:aws:s3:::<bucket_name>/*`
 

diff --git a/docs/sources/operations/storage/boltdb-shipper.md b/docs/sources/operations/storage/boltdb-shipper.md
@@ -113,6 +113,10 @@ We recommend running a Compactor since a single Ingester creates 96 files per da
 
 Example compactor configuration with GCS:
 
+#### Delete Permissions
+
+The compactor is an optional but suggested component that combines and deduplicates the boltdb-shipper index files. When compacting index files, the compactor writes a new file and deletes unoptimized files. Ensure that the compactor has appropriate permissions for deleting files, for example, s3:DeleteObject permission for AWS S3.
+
 ```yaml
 compactor:
   working_directory: /loki/compactor

diff --git a/docs/sources/upgrading/_index.md b/docs/sources/upgrading/_index.md
@@ -154,6 +154,10 @@ Ingesters now expose a new RPC method that queriers use when the index type is `
 Queriers generally roll out faster than ingesters, so if new queriers query older ingesters using the new RPC, the queries would fail.
 To avoid any query downtime during the upgrade, rollout ingesters before queriers.
 
+#### If running the compactor, ensure it has delete permissions for the object storage.
+
+The compactor is an optional but suggested component that combines and deduplicates the boltdb-shipper index files. When compacting index files, the compactor writes a new file and deletes unoptimized files. Ensure that the compactor has appropriate permissions for deleting files, for example, s3:DeleteObject permission for AWS S3.
+
 ### IMPORTANT: `results_cache.max_freshness` removed from YAML config
 
 The `max_freshness` config from `results_cache` has been removed in favour of another flag called `max_cache_freshness_per_query` in `limits_config` which has the same effect.