Skip to content

Deprecate global repositories.azure settings #22856

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

Merged
merged 2 commits into from
Feb 20, 2017
Merged

Deprecate global repositories.azure settings #22856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c61cb60
Deprecate global `repositories.azure` settings
dadoonet Jan 30, 2017
26a2205
Revert adding deprecate info in our docs
dadoonet Feb 17, 2017
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
16 changes: 0 additions & 16 deletions docs/plugins/repository-azure.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,22 +185,6 @@ client.admin().cluster().preparePutRepository("my_backup_java1")
).get();
----

[[repository-azure-global-settings]]
===== Global repositories settings

All those repository settings can also be defined globally in `elasticsearch.yml` file using prefix
`repositories.azure.`. For example:

[source,yaml]
----
repositories.azure:
container: backup-container
base_path: backups
chunk_size: 32m
compress": true
----


[[repository-azure-validation]]
===== Repository validation rules

Expand Down
20 changes: 14 additions & 6 deletions ...sitory-azure/src/main/java/org/elasticsearch/cloud/azure/storage/AzureStorageService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,26 @@ final class Storage {

public static final Setting<TimeValue> TIMEOUT_SETTING =
Setting.timeSetting("cloud.azure.storage.timeout", TimeValue.timeValueMinutes(-1), Property.NodeScope);
@Deprecated
public static final Setting<String> ACCOUNT_SETTING =
Setting.simpleString("repositories.azure.account", Property.NodeScope, Property.Filtered);
Setting.simpleString("repositories.azure.account", Property.NodeScope, Property.Filtered, Property.Deprecated);
@Deprecated
public static final Setting<String> CONTAINER_SETTING =
new Setting<>("repositories.azure.container", "elasticsearch-snapshots", Function.identity(), Property.NodeScope);
new Setting<>("repositories.azure.container", "elasticsearch-snapshots", Function.identity(), Property.NodeScope,
Property.Deprecated);
@Deprecated
public static final Setting<String> BASE_PATH_SETTING =
Setting.simpleString("repositories.azure.base_path", Property.NodeScope);
Setting.simpleString("repositories.azure.base_path", Property.NodeScope, Property.Deprecated);
@Deprecated
public static final Setting<String> LOCATION_MODE_SETTING =
Setting.simpleString("repositories.azure.location_mode", Property.NodeScope);
Setting.simpleString("repositories.azure.location_mode", Property.NodeScope, Property.Deprecated);
@Deprecated
public static final Setting<ByteSizeValue> CHUNK_SIZE_SETTING =
Setting.byteSizeSetting("repositories.azure.chunk_size", MAX_CHUNK_SIZE, MIN_CHUNK_SIZE, MAX_CHUNK_SIZE, Property.NodeScope);
Setting.byteSizeSetting("repositories.azure.chunk_size", MAX_CHUNK_SIZE, MIN_CHUNK_SIZE, MAX_CHUNK_SIZE, Property.NodeScope,
Property.Deprecated);
@Deprecated
public static final Setting<Boolean> COMPRESS_SETTING =
Setting.boolSetting("repositories.azure.compress", false, Property.NodeScope);
Setting.boolSetting("repositories.azure.compress", false, Property.NodeScope, Property.Deprecated);
}

boolean doesContainerExist(String account, LocationMode mode, String container);
Expand Down
21 changes: 21 additions & 0 deletions ...zure/src/test/java/org/elasticsearch/repositories/azure/AzureRepositorySettingsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

import com.microsoft.azure.storage.LocationMode;
import com.microsoft.azure.storage.StorageException;
import org.apache.logging.log4j.core.net.Protocol;
import org.elasticsearch.cloud.azure.storage.AzureStorageService;
import org.elasticsearch.cluster.metadata.RepositoryMetaData;
import org.elasticsearch.common.settings.Settings;
Expand Down Expand Up @@ -124,4 +125,24 @@ public void testChunkSize() throws StorageException, IOException, URISyntaxExcep
azureRepository(Settings.builder().put("chunk_size", "65mb").build()));
assertEquals("Failed to parse value [65mb] for setting [chunk_size] must be <= 64mb", e.getMessage());
}

public void testDeprecatedRepositoriesSettings() throws StorageException, IOException, URISyntaxException {
Settings settings = Settings.builder()
.put(AzureStorageService.Storage.ACCOUNT_SETTING.getKey(), "account")
.put(AzureStorageService.Storage.BASE_PATH_SETTING.getKey(), "path")
.put(AzureStorageService.Storage.CHUNK_SIZE_SETTING.getKey(), AzureStorageService.MAX_CHUNK_SIZE)
.put(AzureStorageService.Storage.COMPRESS_SETTING.getKey(), false)
.put(AzureStorageService.Storage.CONTAINER_SETTING.getKey(), "container")
.put(AzureStorageService.Storage.LOCATION_MODE_SETTING.getKey(), "primary_only")
.build();
azureRepository(settings);
assertWarnings("[" + AzureStorageService.Storage.ACCOUNT_SETTING.getKey() + "] setting was deprecated",
"[" + AzureStorageService.Storage.BASE_PATH_SETTING.getKey() + "] setting was deprecated",
"[" + AzureStorageService.Storage.CHUNK_SIZE_SETTING.getKey() + "] setting was deprecated",
"[" + AzureStorageService.Storage.COMPRESS_SETTING.getKey() + "] setting was deprecated",
"[" + AzureStorageService.Storage.CONTAINER_SETTING.getKey() + "] setting was deprecated",
"[" + AzureStorageService.Storage.LOCATION_MODE_SETTING.getKey() + "] setting was deprecated");
}


}