Skip to content

Commit 0ea67aa

Browse files
authored
[DOCS] Document common settings for snapshot repository plugins (#40475) (#40607)
1 parent 3f05186 commit 0ea67aa

File tree

5 files changed

+18
-3
lines changed

5 files changed

+18
-3
lines changed

docs/plugins/repository-azure.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,7 @@ The Azure repository supports following settings:
126126
setting doesn't affect index files that are already compressed by default.
127127
Defaults to `false`.
128128

129-
`readonly`::
130-
131-
Makes repository read-only. Defaults to `false`.
129+
include::repository-shared-settings.asciidoc[]
132130

133131
`location_mode`::
134132

docs/plugins/repository-gcs.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,8 @@ The following settings are supported:
240240
setting doesn't affect index files that are already compressed by default.
241241
Defaults to `false`.
242242

243+
include::repository-shared-settings.asciidoc[]
244+
243245
`application_name`::
244246

245247
deprecated[7.0.0, This setting is now defined in the <<repository-gcs-client, client settings>>]

docs/plugins/repository-hdfs.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ The following settings are supported:
6464

6565
Whether to compress the metadata or not. (Disabled by default)
6666

67+
include::repository-shared-settings.asciidoc[]
68+
6769
`chunk_size`::
6870

6971
Override the chunk size. (Disabled by default)

docs/plugins/repository-s3.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,8 @@ The following settings are supported:
213213
setting doesn't affect index files that are already compressed by default.
214214
Defaults to `false`.
215215

216+
include::repository-shared-settings.asciidoc[]
217+
216218
`server_side_encryption`::
217219

218220
When set to `true` files are encrypted on server side using AES256
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
`max_restore_bytes_per_sec`::
2+
3+
Throttles per node restore rate. Defaults to `40mb` per second.
4+
5+
`max_snapshot_bytes_per_sec`::
6+
7+
Throttles per node snapshot rate. Defaults to `40mb` per second.
8+
9+
`readonly`::
10+
11+
Makes repository read-only. Defaults to `false`.

0 commit comments

Comments
 (0)