Use client settings in repository-gcs #28575
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.elasticsearch.repositories.gcs; | ||
|
|
||
| import com.google.api.client.googleapis.auth.oauth2.GoogleCredential; | ||
| import com.google.api.services.storage.StorageScopes; | ||
| import org.elasticsearch.common.settings.SecureSetting; | ||
| import org.elasticsearch.common.settings.Setting; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.common.unit.TimeValue; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.UncheckedIOException; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
|
|
||
| import static org.elasticsearch.common.settings.Setting.timeSetting; | ||
|
|
||
| /** | ||
| * Container for Google Cloud Storage clients settings. | ||
| */ | ||
| public class GoogleCloudStorageClientSettings { | ||
|
|
||
| private static final String PREFIX = "gcs.client."; | ||
|
|
||
| /** A json Service Account file loaded from secure settings. */ | ||
| static final Setting.AffixSetting<InputStream> CREDENTIALS_FILE_SETTING = Setting.affixKeySetting(PREFIX, "credentials_file", | ||
| key -> SecureSetting.secureFile(key, null)); | ||
|
|
||
| /** An override for the Storage endpoint to connect to. */ | ||
| static final Setting.AffixSetting<String> ENDPOINT_SETTING = Setting.affixKeySetting(PREFIX, "endpoint", | ||
| key -> new Setting<>(key, "", s -> s, Setting.Property.NodeScope)); | ||
|
|
||
| /** | ||
| * The timeout to establish a connection. A value of {@code -1} corresponds to an infinite timeout. A value of {@code 0} | ||
| * corresponds to the default timeout of the Google Cloud Storage Java Library. | ||
| */ | ||
| static final Setting.AffixSetting<TimeValue> CONNECT_TIMEOUT_SETTING = Setting.affixKeySetting(PREFIX, "connect_timeout", | ||
| key -> timeSetting(key, TimeValue.ZERO, TimeValue.MINUS_ONE, Setting.Property.NodeScope)); | ||
|
|
||
| /** | ||
| * The timeout to read data from an established connection. A value of {@code -1} corresponds to an infinite timeout. A value of | ||
| * {@code 0} corresponds to the default timeout of the Google Cloud Storage Java Library. | ||
| */ | ||
| static final Setting.AffixSetting<TimeValue> READ_TIMEOUT_SETTING = Setting.affixKeySetting(PREFIX, "read_timeout", | ||
| key -> timeSetting(key, TimeValue.ZERO, TimeValue.MINUS_ONE, Setting.Property.NodeScope)); | ||
|
|
||
| /** Name used by the client when it uses the Google Cloud JSON API. **/ | ||
| static final Setting.AffixSetting<String> APPLICATION_NAME_SETTING = Setting.affixKeySetting(PREFIX, "application_name", | ||
| key -> new Setting<>(key, "repository-gcs", s -> s, Setting.Property.NodeScope)); | ||
|
|
||
| /** The credentials used by the client to connect to the Storage endpoint **/ | ||
| private final GoogleCredential credential; | ||
|
|
||
| /** The Storage root URL the client should talk to, or empty string to use the default. **/ | ||
| private final String endpoint; | ||
|
|
||
| /** The timeout to establish a connection **/ | ||
| private final TimeValue connectTimeout; | ||
|
|
||
| /** The timeout to read data from an established connection **/ | ||
| private final TimeValue readTimeout; | ||
|
|
||
| /** The Storage client application name **/ | ||
| private final String applicationName; | ||
|
|
||
| GoogleCloudStorageClientSettings(final GoogleCredential credential, | ||
| final String endpoint, | ||
| final TimeValue connectTimeout, | ||
| final TimeValue readTimeout, | ||
| final String applicationName) { | ||
| this.credential = credential; | ||
| this.endpoint = endpoint; | ||
| this.connectTimeout = connectTimeout; | ||
| this.readTimeout = readTimeout; | ||
| this.applicationName = applicationName; | ||
| } | ||
|
|
||
| public GoogleCredential getCredential() { | ||
| return credential; | ||
| } | ||
|
|
||
| public String getEndpoint() { | ||
| return endpoint; | ||
| } | ||
|
|
||
| public TimeValue getConnectTimeout() { | ||
| return connectTimeout; | ||
| } | ||
|
|
||
| public TimeValue getReadTimeout() { | ||
| return readTimeout; | ||
| } | ||
|
|
||
| public String getApplicationName() { | ||
| return applicationName; | ||
| } | ||
|
|
||
| public static Map<String, GoogleCloudStorageClientSettings> load(final Settings settings) { | ||
| final Map<String, GoogleCloudStorageClientSettings> clients = new HashMap<>(); | ||
| for (String clientName: settings.getGroups(PREFIX).keySet()) { | ||
| clients.put(clientName, getClientSettings(settings, clientName)); | ||
| } | ||
| if (clients.containsKey("default") == false) { | ||
| // this won't find any settings under the default client, | ||
| // but it will pull all the fallback static settings | ||
| clients.put("default", getClientSettings(settings, "default")); | ||
| } | ||
| return Collections.unmodifiableMap(clients); | ||
| } | ||
|
|
||
| static GoogleCloudStorageClientSettings getClientSettings(final Settings settings, final String clientName) { | ||
| return new GoogleCloudStorageClientSettings( | ||
| loadCredential(settings, clientName), | ||
| getConfigValue(settings, clientName, ENDPOINT_SETTING), | ||
| getConfigValue(settings, clientName, CONNECT_TIMEOUT_SETTING), | ||
| getConfigValue(settings, clientName, READ_TIMEOUT_SETTING), | ||
| getConfigValue(settings, clientName, APPLICATION_NAME_SETTING) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Loads the service account file corresponding to a given client name. If no file is defined for the client, | ||
| * a {@code null} credential is returned. | ||
| * | ||
| * @param settings the {@link Settings} | ||
| * @param clientName the client name | ||
| * | ||
| * @return the {@link GoogleCredential} to use for the given client, {@code null} if no service account is defined. | ||
| */ | ||
| static GoogleCredential loadCredential(final Settings settings, final String clientName) { | ||
| try { | ||
| if (CREDENTIALS_FILE_SETTING.getConcreteSettingForNamespace(clientName).exists(settings) == false) { | ||
| // explicitly returning null here so that the default credential | ||
| // can be loaded later when creating the Storage client | ||
| return null; | ||
| } | ||
| try (InputStream credStream = CREDENTIALS_FILE_SETTING.getConcreteSettingForNamespace(clientName).get(settings)) { | ||
| GoogleCredential credential = GoogleCredential.fromStream(credStream); | ||
| if (credential.createScopedRequired()) { | ||
| credential = credential.createScoped(Collections.singleton(StorageScopes.DEVSTORAGE_FULL_CONTROL)); | ||
| } | ||
| return credential; | ||
| } | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| } | ||
| } | ||
|
|
||
| private static <T> T getConfigValue(final Settings settings, final String clientName, final Setting.AffixSetting<T> clientSetting) { | ||
| Setting<T> concreteSetting = clientSetting.getConcreteSettingForNamespace(clientName); | ||
| return concreteSetting.get(settings); | ||
| } | ||
| } |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The subcommand is
add-file, notadd.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch