Deprecate REST access to System Indices #60945
Merged
Conversation
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
jaymode
approved these changes
Oct 6, 2020
|
|
||
| public class TransportGetAliasesAction extends TransportMasterNodeReadAction<GetAliasesRequest, GetAliasesResponse> { | ||
| private static DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(TransportGetAliasesAction.class); |
There was a problem hiding this comment.
Suggested change
| private static DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(TransportGetAliasesAction.class); | |
| private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(TransportGetAliasesAction.class); |
| @@ -103,8 +107,13 @@ public void setup() { | |||
| httpServerTransport.start(); | |||
| } | |||
|
|
|||
| @After | |||
| public void teardown() { | |||
| client.close(); | |||
There was a problem hiding this comment.
Suggested change
| client.close(); | |
| IOUtils.close(client); |
This allows us to guard in case the client is null to avoid unnecessary exceptions in case of odd setup failure. The IOUtils class I am referencing is from package org.elasticsearch.core.internal.io
| @@ -798,7 +812,17 @@ private void wipeRollupJobs() throws IOException { | |||
| protected void refreshAllIndices() throws IOException { | |||
| boolean includeHidden = minimumNodeVersion().onOrAfter(Version.V_7_7_0); | |||
| Request refreshRequest = new Request("POST", "/_refresh"); | |||
| refreshRequest.addParameter("expand_wildcards", "open,closed" + (includeHidden ? ",hidden" : "")); | |||
| refreshRequest.addParameter("expand_wildcards", "open" + (includeHidden ? ",hidden" : "")); | |||
There was a problem hiding this comment.
why did closed get dropped here?
There was a problem hiding this comment.
Trying to refresh a closed index appears to cause an exception, but that only came up after I switched a test which involves closing an index to use this instead of a direct POST _refresh call (to take advantage of the deprecation warning handling). This method is only used in a few tests, and I think specifying closed was always wrong, it just never mattered before.
gwbrown
added a commit
that referenced
this pull request
Oct 6, 2020
This PR adds deprecation warnings when accessing System Indices via the REST layer. At this time, these warnings are only enabled for Snapshot builds by default, to allow projects external to Elasticsearch additional time to adjust their access patterns.
Deprecation warnings will be triggered by all REST requests which access registered System Indices, except for purpose-specific APIs which access System Indices as an implementation detail a few specific APIs which will continue to allow access to system indices by default:
- `GET _cluster/health`
- `GET {index}/_recovery`
- `GET _cluster/allocation/explain`
- `GET _cluster/state`
- `POST _cluster/reroute`
- `GET {index}/_stats`
- `GET {index}/_segments`
- `GET {index}/_shard_stores`
- `GET _cat/[indices,aliases,health,recovery,shards,segments]`
Deprecation warnings for accessing system indices take the form:
```
this request accesses system indices: [.some_system_index], but in a future major version, direct access to system indices will be prevented by default
```
This was referenced Oct 6, 2020
61 tasks
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds deprecation warnings when accessing System Indices via the REST layer. At this time, these warnings are only enabled for Snapshot builds by default, to allow projects external to Elasticsearch additional time to adjust their access patterns.
Deprecation warnings will be triggered by all REST requests which access registered System Indices, except for purpose-specific APIs which access System Indices as an implementation detail and a few specific APIs which will continue to allow access to system indices by default:
GET _cluster/healthGET {index}/_recoveryGET _cluster/allocation/explainGET _cluster/statePOST _cluster/rerouteGET {index}/_statsGET {index}/_segmentsGET {index}/_shard_storesGET _cat/[indices,aliases,health,recovery,shards,segments]Deprecation warnings for accessing system indices take the form: