honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-25 09:28:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

S3/Azure snapshot repo documentation wrong for "read_only"

Browse Source 
We used to write that people should use `read_only` although it should be `readonly`.

Closes #22007.
This commit is contained in:
David Pilato 2016-12-08 16:57:50 +01:00
parent 182e119699
commit 18a3d6b4f3
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/plugins/repository-azure.asciidoc
View File

@ -121,14 +121,14 @@ The Azure repository supports following settings:
setting doesn't affect index files that are already compressed by default.
Defaults to `false`.
`read_only`::
`readonly`::
Makes repository read-only. coming[2.1.0] Defaults to `false`.
Makes repository read-only. Defaults to `false`.
`location_mode`::
`primary_only` or `secondary_only`. Defaults to `primary_only`. Note that if you set it
to `secondary_only`, it will force `read_only` to true.
to `secondary_only`, it will force `readonly` to true.
Some examples, using scripts:

2
docs/plugins/repository-s3.asciidoc
View File

@ -240,7 +240,7 @@ The following settings are supported:
Set to `true` if you want to throttle retries. Defaults to AWS SDK default value (`false`).
`read_only`::
`readonly`::
Makes repository read-only. Defaults to `false`.