honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-23 05:15:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Clarify client settings (#31469)

Browse Source
This commit is contained in:
Morris Schreibman 2019-01-09 19:12:31 +02:00 committed by lcawl
parent 6a5f3f05f4
commit 13b8bad2b8
1 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -34,10 +34,10 @@ PUT _snapshot/my_s3_repository
[[repository-s3-client]] [[repository-s3-client]]
==== Client Settings ==== Client Settings
The client used to connect to S3 has a number of settings available. Client setting names are of The client that you use to connect to S3 has a number of settings available. The
the form `s3.client.CLIENT_NAME.SETTING_NAME`. The default client name, which is looked up by settings have the form `s3.client.CLIENT_NAME.SETTING_NAME`. The default client
an `s3` repository, is called `default`. It can be modified using the name that is looked up by an `s3` repository is `default`. It can be modified
<<repository-s3-repository, repository setting>> `client`. For example: using the <<repository-s3-repository,repository setting>> `client`. For example:
[source,js] [source,js]
---- ----
@ -53,11 +53,13 @@ PUT _snapshot/my_s3_repository
// CONSOLE // CONSOLE
// TEST[skip:we don't have s3 setup while testing this] // TEST[skip:we don't have s3 setup while testing this]
Most client settings are specified inside `elasticsearch.yml`, but some are Most client settings can be added to the `elasticsearch.yml` configuration file
sensitive and must be stored in the {ref}/secure-settings.html[elasticsearch keystore]. with the exception of the secure settings, which you add to the {es} keystore.
For more information about creating and updating the {es} keystore, see
{ref}/secure-settings.html[Secure settings].
For example, before you start the node, run these commands to add AWS access For example, before you start the node, run these commands to add AWS access key
key settings to the keystore: settings to the keystore:
[source,sh] [source,sh]
---- ----
@ -76,16 +78,17 @@ NOTE: In progress snapshot/restore tasks will not be preempted by a *reload*
of the client's secure settings. The task will complete using the client as it of the client's secure settings. The task will complete using the client as it
was built when the operation started. was built when the operation started.
The following is the list of all the available client settings. The following list contains the available client settings. Those that must be
Those that must be stored in the keystore are marked as `Secure` and are *reloadable*. stored in the keystore are marked as "secure" and are *reloadable*; the other
settings belong in the `elasticsearch.yml` file.
`access_key`:: `access_key` ({ref}/secure-settings.html[Secure])::
An s3 access key. The `secret_key` setting must also be specified. (Secure) An s3 access key. The `secret_key` setting must also be specified.
`secret_key`:: `secret_key` ({ref}/secure-settings.html[Secure])::
An s3 secret key. The `access_key` setting must also be specified. (Secure) An s3 secret key. The `access_key` setting must also be specified.
`session_token`:: `session_token`::
An s3 session token. The `access_key` and `secret_key` settings must also An s3 session token. The `access_key` and `secret_key` settings must also
@ -110,13 +113,13 @@ Those that must be stored in the keystore are marked as `Secure` and are *reload
The port of a proxy to connect to s3 through. The port of a proxy to connect to s3 through.
`proxy.username`:: `proxy.username` ({ref}/secure-settings.html[Secure])::
The username to connect to the `proxy.host` with. (Secure) The username to connect to the `proxy.host` with.
`proxy.password`:: `proxy.password` ({ref}/secure-settings.html[Secure])::
The password to connect to the `proxy.host` with. (Secure) The password to connect to the `proxy.host` with.
`read_timeout`:: `read_timeout`::