Use client settings in repository-gcs #28575
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tlrx
force-pushed
the
client-settings-for-repository-gcs
branch
2 times, most recently
from
4b2fc3c to
699cc7e
Compare
clintongormley
added
:Distributed Coordination/Snapshot/Restore
Similarly to what has been done for s3 and azure, this commit removes the repository settings `application_name` and `connect/read_timeout` in favor of client settings. It introduce a GoogleCloudStorageClientSettings class (similar to S3ClientSettings) and a bunch of unit tests for that, it aligns the documentation to be more coherent with the S3 one, it documents the connect/read timeouts that were not documented at all and also adds a new client setting that allows to define a custom endpoint.
Member
Author
|
@rjernst Would you like to review this please? I'd like to move forward on this, as exposing the endpoint setting will help to test the plugin using a fixture. |
tlrx
force-pushed
the
client-settings-for-repository-gcs
branch
from
699cc7e to
5d1ff1d
Compare
ywelsch
approved these changes
Feb 21, 2018
Contributor
ywelsch
left a comment
ywelsch
left a comment
There was a problem hiding this comment.
LGTM (some super minor nits)
docs/plugins/repository-gcs.asciidoc
Outdated
| // TEST[skip:we don't have gcs setup while testing this] | ||
|
|
||
| Some settings are sensitive and must be stored in the | ||
| {ref}/secure-settings.html[elasticsearch keystore]. This is the case of the service account file: |
docs/plugins/repository-gcs.asciidoc
Outdated
| `endpoint`:: | ||
|
|
||
| The Google Cloud Storage service endpoint to connect to. This will be automatically | ||
| figured out by the Google Cloud Storage client but can be specified explicitly. |
Contributor
There was a problem hiding this comment.
automatically determined by the ...
| ==== Google Cloud Storage Repository plugin | ||
|
|
||
| * The repository settings `application_name`, `connect_timeout` and `read_timeout` have been removed and | ||
| must now be specified in the client settings instead. |
| } | ||
|
|
||
| private final Map<String, GoogleCredential> credentials; | ||
| private final Map<String, GoogleCloudStorageClientSettings> clientsSettings; |
Contributor
There was a problem hiding this comment.
clientsSettings -> clientSettings?
Member
Author
There was a problem hiding this comment.
There can be multiple client settings keyed by their name so I chose the plural form :)
| 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 an s3 repository is called `default`, but can be customized | ||
| default client name looked up by a `s3` repository is called `default`, but can be customized |
Contributor
There was a problem hiding this comment.
Maybe instead "The default client name used by the "s3" repository is called default ...
rjernst
approved these changes
Feb 22, 2018
docs/plugins/repository-gcs.asciidoc
Outdated
|
|
||
| [source,sh] | ||
| ---- | ||
| bin/elasticsearch-keystore add gcs.client.default.credentials_file |
Member
There was a problem hiding this comment.
The subcommand is add-file, not add.
docs/plugins/repository-gcs.asciidoc
Outdated
| [source,sh] | ||
| ---- | ||
| bin/elasticsearch-keystore add gcs.client.default.credentials_file | ||
| bin/elasticsearch-keystore add gcs.client.default.credentials_file |
Member
There was a problem hiding this comment.
And this line seems to be duplicated?
Member
Author
tlrx
added a commit
that referenced
this pull request
Mar 9, 2018
Similarly to what has been done for s3 and azure, this commit removes the repository settings `application_name` and `connect/read_timeout` in favor of client settings. It introduce a GoogleCloudStorageClientSettings class (similar to S3ClientSettings) and a bunch of unit tests for that, it aligns the documentation to be more coherent with the S3 one, it documents the connect/read timeouts that were not documented at all and also adds a new client setting that allows to define a custom endpoint.
Member
Author
|
This change has been backported to 6.x in 240aa34 along with a deprecation log and updated migration documentation. |
sebasjm
pushed a commit
to sebasjm/elasticsearch
that referenced
this pull request
Mar 10, 2018
Similarly to what has been done for s3 and azure, this commit removes the repository settings `application_name` and `connect/read_timeout` in favor of client settings. It introduce a GoogleCloudStorageClientSettings class (similar to S3ClientSettings) and a bunch of unit tests for that, it aligns the documentation to be more coherent with the S3 one, it documents the connect/read timeouts that were not documented at all and also adds a new client setting that allows to define a custom endpoint.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similarly to what has been done for s3 and azure, this pull request removes
the repository settings
application_nameandconnect/read_timeoutin favour of settings at the client level.
It introduces a
GoogleCloudStorageClientSettingsclass (similar to
S3ClientSettings) and a bunch of unit tests for that,it aligns the documentation to be more coherent with the S3 one, it
documents the connect/read timeouts that were not documented at all
and also adds a new client setting that allows to define a custom
endpoint.