-
Notifications
You must be signed in to change notification settings - Fork 24.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prevent snapshots to be mounted as system indices (#61517)
System indices can be snapshotted and are therefore potential candidates to be mounted as searchable snapshot indices. As of today nothing prevents a snapshot to be mounted under an index name starting with . and this can lead to conflicting situations because searchable snapshot indices are read-only and Elasticsearch expects some system indices to be writable; because searchable snapshot indices will soon use an internal system index (#60522) to speed up recoveries and we should prevent the system index to be itself a searchable snapshot index (leading to some deadlock situation for recovery). This commit introduces a changes to prevent snapshots to be mounted as a system index.
- Loading branch information
Showing
5 changed files
with
128 additions
and
8 deletions.
There are no files selected for viewing
This file contains 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 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 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 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
100 changes: 100 additions & 0 deletions
100
...g/elasticsearch/xpack/searchablesnapshots/SearchableSnapshotsSystemIndicesIntegTests.java
This file contains 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,100 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.xpack.searchablesnapshots; | ||
|
|
||
| import org.elasticsearch.ElasticsearchException; | ||
| import org.elasticsearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse; | ||
| import org.elasticsearch.client.Client; | ||
| import org.elasticsearch.client.OriginSettingClient; | ||
| import org.elasticsearch.cluster.metadata.IndexMetadata; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.indices.SystemIndexDescriptor; | ||
| import org.elasticsearch.plugins.Plugin; | ||
| import org.elasticsearch.plugins.SystemIndexPlugin; | ||
| import org.elasticsearch.xpack.core.ClientHelper; | ||
| import org.elasticsearch.xpack.core.searchablesnapshots.MountSearchableSnapshotAction; | ||
| import org.elasticsearch.xpack.core.searchablesnapshots.MountSearchableSnapshotRequest; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
|
|
||
| import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertAcked; | ||
| import static org.hamcrest.Matchers.containsString; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
|
|
||
| public class SearchableSnapshotsSystemIndicesIntegTests extends BaseSearchableSnapshotsIntegTestCase { | ||
|
|
||
| @Override | ||
| protected Collection<Class<? extends Plugin>> nodePlugins() { | ||
| final List<Class<? extends Plugin>> plugins = new ArrayList<>(super.nodePlugins()); | ||
| plugins.add(TestSystemIndexPlugin.class); | ||
| return plugins; | ||
| } | ||
|
|
||
| public void testCannotMountSystemIndex() throws Exception { | ||
| executeTest(TestSystemIndexPlugin.INDEX_NAME, new OriginSettingClient(client(), ClientHelper.SEARCHABLE_SNAPSHOTS_ORIGIN)); | ||
| } | ||
|
|
||
| public void testCannotMountSnapshotBlobCacheIndex() throws Exception { | ||
| executeTest(SearchableSnapshotsConstants.SNAPSHOT_BLOB_CACHE_INDEX, client()); | ||
| } | ||
|
|
||
| private void executeTest(final String indexName, final Client client) throws Exception { | ||
| final boolean isHidden = randomBoolean(); | ||
| createAndPopulateIndex(indexName, Settings.builder().put(IndexMetadata.SETTING_INDEX_HIDDEN, isHidden)); | ||
|
|
||
| final String repositoryName = randomAlphaOfLength(10).toLowerCase(Locale.ROOT); | ||
| createRepo(repositoryName); | ||
|
|
||
| final String snapshotName = randomAlphaOfLength(10).toLowerCase(Locale.ROOT); | ||
| final CreateSnapshotResponse snapshotResponse = client.admin() | ||
| .cluster() | ||
| .prepareCreateSnapshot(repositoryName, snapshotName) | ||
| .setIndices(indexName) | ||
| .setWaitForCompletion(true) | ||
| .get(); | ||
|
|
||
| final int numPrimaries = getNumShards(indexName).numPrimaries; | ||
| assertThat(snapshotResponse.getSnapshotInfo().successfulShards(), equalTo(numPrimaries)); | ||
| assertThat(snapshotResponse.getSnapshotInfo().failedShards(), equalTo(0)); | ||
|
|
||
| if (randomBoolean()) { | ||
| assertAcked(client.admin().indices().prepareClose(indexName)); | ||
| } else { | ||
| assertAcked(client.admin().indices().prepareDelete(indexName)); | ||
| } | ||
|
|
||
| final MountSearchableSnapshotRequest mountRequest = new MountSearchableSnapshotRequest( | ||
| indexName, | ||
| repositoryName, | ||
| snapshotName, | ||
| indexName, | ||
| Settings.builder().put(IndexMetadata.SETTING_INDEX_HIDDEN, randomBoolean()).build(), | ||
| Strings.EMPTY_ARRAY, | ||
| true | ||
| ); | ||
|
|
||
| final ElasticsearchException exception = expectThrows( | ||
| ElasticsearchException.class, | ||
| () -> client.execute(MountSearchableSnapshotAction.INSTANCE, mountRequest).actionGet() | ||
| ); | ||
| assertThat(exception.getMessage(), containsString("system index [" + indexName + "] cannot be mounted as searchable snapshots")); | ||
| } | ||
|
|
||
| public static class TestSystemIndexPlugin extends Plugin implements SystemIndexPlugin { | ||
|
|
||
| static final String INDEX_NAME = ".test-system-index"; | ||
|
|
||
| @Override | ||
| public Collection<SystemIndexDescriptor> getSystemIndexDescriptors(Settings settings) { | ||
| return List.of(new SystemIndexDescriptor(INDEX_NAME, "System index for [" + getTestClass().getName() + ']')); | ||
| } | ||
| } | ||
| } |