Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify difference between public and secure client settings in discu… #31469

Merged
merged 3 commits into from
Jan 9, 2019
Merged

Clarify difference between public and secure client settings in discu… #31469

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a4bbff
Clarify difference between public and secure client settings in discu…
MorrieAtElastic Jun 20, 2018
108ee3b
[DOCS] Edits the client settings
lcawl Jan 4, 2019
c5440df
[DOCS] Clarifies keystore vs config file
lcawl Jan 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions docs/plugins/repository-s3.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,7 @@ PUT _snapshot/my_s3_repository
[[repository-s3-client]]
==== Client Settings

The client used to connect to S3 has a number of settings available. Client setting names are of
the form `s3.client.CLIENT_NAME.SETTING_NAME` and specified inside `elasticsearch.yml`. The
default client name looked up by a `s3` repository is called `default`, but can be customized
with the repository setting `client`. For example:
The client used to connect to S3 has a number of settings available. Settings are either "public" or "secure", Public client settings may be specified in the `elasticsearch.yml` file and are of the form `s3.client.CLIENT_NAME.SETTING_NAME`. The default client name looked up by a `s3` repository is called `default`, but can be customized with the repository setting `client`. For example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than introducing the idea of "public" settings, I'd suggest something like this:
"The client ... has a number of settings available. All of these settings can be added to the elasticsearch.yml configuration file, with the exception of the secure settings, which you add to the Elasticsearch keystore. The settings have the form..."


[source,js]
----
Expand All @@ -53,8 +50,7 @@ PUT _snapshot/my_s3_repository
// CONSOLE
// TEST[skip:we don't have s3 setup while testing this]

Some settings are sensitive and must be stored in the {ref}/secure-settings.html[elasticsearch keystore].
For example, to use explicit AWS access keys:
`Secure` settings are sensitive and must be stored in the {ref}/secure-settings.html[elasticsearch keystore].For example, to use explicit AWS access keys:

[source,sh]
----
Expand All @@ -63,7 +59,7 @@ bin/elasticsearch-keystore add s3.client.default.secret_key
----

The following are the available client settings. Those that must be stored in the keystore
are marked as `Secure`.
are marked as `Secure`; all other settings are public and may be included in the `elasticsearch.yml` file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per above, I'd just say "...all other settings can be included in the elasticsearch.yml file".


`access_key`::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other docs (e.g. https://www.elastic.co/guide/en/elasticsearch/reference/master/security-settings.html), we put the "secure" identifier directly after the setting name (instead of after the description) and it's a link to the secure settings page. I suggest doing the same here.


Expand Down