From 336ef4d468efb09ad671f49341a01a8d0c377df6 Mon Sep 17 00:00:00 2001 From: Paul Pearcy Date: Tue, 9 Sep 2014 00:17:38 -0400 Subject: [PATCH] Clarify s3 snapshot compress behavior Clarify s3 snapshot compress behavior only applies to metadata and no index files. Closes #7654 --- docs/reference/modules/snapshots.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/modules/snapshots.asciidoc b/docs/reference/modules/snapshots.asciidoc index 1610e23d756..90f204ae99e 100644 --- a/docs/reference/modules/snapshots.asciidoc +++ b/docs/reference/modules/snapshots.asciidoc @@ -66,7 +66,7 @@ on all data and master nodes. The following settings are supported: [horizontal] `location`:: Location of the snapshots. Mandatory. -`compress`:: Turns on compression of the snapshot files. Defaults to `true`. +`compress`:: Turns on compression of the snapshot files. Compression is applied only to metadata files (index mapping and settings). Data files are not compressed. Defaults to `true`. `chunk_size`:: Big files can be broken down into chunks during snapshotting if needed. The chunk size can be specified in bytes or by using size value notation, i.e. 1g, 10m, 5k. Defaults to `null` (unlimited chunk size). `max_restore_bytes_per_sec`:: Throttles per node restore rate. Defaults to `20mb` per second.