Skip to content

Default gateway.auto_import_dangling_indices to false #59302

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.

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

Conversation

pugnascotia
Copy link
Contributor

Backport of #58898.

Part of #48366. Now that there is a dedicated API for dangling indices, the auto-import behaviour can default to off. Also add a note to the breaking changes for 7.9.0.

@pugnascotia pugnascotia added >enhancement >breaking :Distributed Indexing/Distributed A catch all label for anything in the Distributed Indexing Area. Please avoid if you can. backport v7.9.0 labels Jul 9, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/Distributed)

@elasticmachine elasticmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label Jul 9, 2020
@pugnascotia
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/oss-distro-docs

Copy link
Contributor

@lockewritesdocs lockewritesdocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a suggested revision to the release notes, but LGTM otherwise. Thanks!

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a breaking change I think we should document it in docs/reference/migration/migrate_7_9.asciidoc rather than docs/reference/release-notes/7.9.asciidoc. I suppose we can do both, but that seems excessive to me.

@lockewritesdocs
Copy link
Contributor

Since this is a breaking change I think we should document it in docs/reference/migration/migrate_7_9.asciidoc rather than docs/reference/release-notes/7.9.asciidoc. I suppose we can do both, but that seems excessive to me.

That's a good call @DaveCTurner 👍 Thanks for pointing out that change.

@pugnascotia
Copy link
Contributor Author

Thanks @DaveCTurner. I didn't feel entirely comfortable with completely removing the content from the release notes, so I abbreviated it and pointed it to the migration notes.

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some suggestions

=== Settings changes

[[deprecate_auto_import_dangling_indices]]
.Automatically importing dangling indices is deprecated.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest this, since deprecating something isn't itself a breaking change:

Suggested change
.Automatically importing dangling indices is deprecated.
.Automatically importing dangling indices is disabled by default.

[%collapsible]
====
*Details* +
<<dangling-indices,Dangling indices>> will no longer be imported
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it'd help to move some things around here: IMO the Details section describes the change and the Impact tells the user what to do about it. How about this:

diff --git a/docs/reference/migration/migrate_7_9.asciidoc b/docs/reference/migration/migrate_7_9.asciidoc
index e60c4f3588d..acfd11fc38b 100644
--- a/docs/reference/migration/migrate_7_9.asciidoc
+++ b/docs/reference/migration/migrate_7_9.asciidoc
@@ -80,16 +80,18 @@ context.  For example, for the `processor_conditional` context, use
 [%collapsible]
 ====
 *Details* +
-<<dangling-indices,Dangling indices>> will no longer be imported
-automatically by default. A new
-<<dangling-indices-api,Dangling indices API>> is now available, which you
-can use to list, import, or delete. Because importing dangling indices
-automatically into the cluster is unsafe, use the dedicated API instead.
+Automatically importing <<dangling-indices,dangling indices>> into the cluster
+is unsafe and is now disabled by default. This feature will be removed entirely
+in {es} 8.0.0.

 *Impact* +
-Automatically importing dangling indices is now deprecated, disabled by
-default, and will be removed in (es) 8.0. If you need to re-enable
-auto-imports, set `gateway.auto_import_dangling_indices` to `true`.
+Use the <<dangling-indices-api,Dangling indices API>> to list, delete or import
+any dangling indices manually.
++
+Alternatively you can enable automatic imports of dangling indices, recovering
+the unsafe behaviour of earlier versions, by setting
+`gateway.auto_import_dangling_indices` to `true`. This setting is deprecated
+and will be removed in {es} 8.0.0. We do not recommend using this setting.

 ====
 //end::notable-breaking-changes[]


Dangling indices::
* Automatically importing dangling indices is now deprecated, disabled by
default, and will be removed in (es) 8.0. See the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you meant this:

Suggested change
default, and will be removed in (es) 8.0. See the
default, and will be removed in {es} 8.0. See the

@pugnascotia pugnascotia force-pushed the auto-dangling-index-import-default-off-7x branch from c4f08d1 to af7a176 Compare July 15, 2020 14:33
@pugnascotia pugnascotia changed the base branch from 7.x to 7.9 July 15, 2020 14:42
Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pugnascotia pugnascotia changed the base branch from 7.9 to 7.x July 15, 2020 14:43
pugnascotia and others added 6 commits July 15, 2020 15:44
Part of elastic#48366. Now that there is a dedicated API for dangling indices,
the auto-import behaviour can default to off.
Move most of the breaking changes regarding dangling indices in the 7.9
release notes to the 7.9 migration doc. Abbreviate the release ntoes
content and point to the migration notes instead.
@pugnascotia pugnascotia force-pushed the auto-dangling-index-import-default-off-7x branch from af7a176 to 6eb2c5f Compare July 15, 2020 14:48
@pugnascotia pugnascotia merged commit b8d73a1 into elastic:7.x Jul 15, 2020
@pugnascotia pugnascotia deleted the auto-dangling-index-import-default-off-7x branch July 15, 2020 16:10
@pugnascotia
Copy link
Contributor Author

Cherry-picked to 7.9 in 84f4635

pugnascotia added a commit that referenced this pull request Jul 15, 2020
Backport of #58898.

Part of #48366. Now that there is a dedicated API for dangling indices, the auto-import
behaviour can default to off. Also add a note to the breaking changes for 7.9.0.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport >breaking :Distributed Indexing/Distributed A catch all label for anything in the Distributed Indexing Area. Please avoid if you can. >enhancement Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. v7.9.0 v7.10.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants