Add migrations.discardCorruptObjects flag #132984

gsoldevila · 2022-05-26T10:02:56Z

Summary

Part of the fix for #129018, introduces a new flag for the migration logic to ignore saved objects with unknown type:

migrations.discardUnknownObjects: "8.4.0"

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

…18-discard-corrupts-objects

…com/gsoldevila/kibana into kbn-129018-discard-corrupts-objects

gsoldevila · 2022-06-02T09:39:20Z

src/core/server/saved_objects/migrations/integration_tests/7_13_0_transform_failures.test.ts

      },
      logging: {
        appenders: {
          file: {
            type: 'file',
            fileName: logFilePath,
            layout: {
-              type: 'json',
+              type: 'pattern',


Need to change this back to 'json'

elasticmachine · 2022-06-02T12:38:35Z

Pinging @elastic/kibana-core (Team:Core)

TinaHeiligers · 2022-06-06T22:36:03Z

@elasticmachine merge upstream

rudolf · 2022-06-02T13:18:19Z

docs/setup/upgrade/resolving-migration-failures.asciidoc

@@ -85,6 +85,16 @@ DELETE .kibana_7.12.0_001/_doc/marketing_space:dashboard:e3c5fc71-ac71-4805-bcab
 +
 The dashboard with the `e3c5fc71-ac71-4805-bcab-2bcc9cc93275` ID that belongs to the `marketing_space` space **is no longer available**.

+You can configure {kib} to automatically discard all corrupt objects and transform errors that occur during a migration. When setting the configuration option `migrations.discardCorruptObjects`, {kib} will ignore the conflicting objects and proceed with the migration.


Suggested change

You can configure {kib} to automatically discard all corrupt objects and transform errors that occur during a migration. When setting the configuration option `migrations.discardCorruptObjects`, {kib} will ignore the conflicting objects and proceed with the migration.

You can configure {kib} to automatically discard all corrupt objects and transform errors that occur during a migration. When setting the configuration option `migrations.discardCorruptObjects`, {kib} will delete the conflicting objects and proceed with the migration.

I think we should use drop/delete/discard to make it clear that for all intents and purposes the data will be lost.

rudolf · 2022-06-08T08:58:51Z

x-pack/test/functional/es_archives/security_solution/migrations/mappings.json

@@ -1971,7 +1971,12 @@
              }
            },
            "type": {
-              "type": "keyword"
+              "type": "text",


These changes should probably be reverted?

Oops, rebase issue, good catch!

rudolf · 2022-06-08T09:09:03Z

docs/setup/upgrade/resolving-migration-failures.asciidoc

+migrations.discardCorruptObjects: "8.4.0"
+--------------------------------------------
+
+**WARNING:** These objects will be kept in the old indices for reference, but they will no longer be used by the system. Thus, it is recommended that you first review the list of conflicting objects in the logs.


We haven't had a lot of discussion around it, but I'm leaning towards, in the future, just deleting the old indices immediately after a successful migration. Some more context here #126672 (comment)

Also given that it's almost impossible for a user to safely restore from an old index after the migration completed successfully I think it's better to just tell users that the data will be lost. I still think it's useful to warn users to carefully review the documents.

Makes sense, I'll update the warning message then.

pgayvallet

Implementation seems fine to me

pgayvallet · 2022-06-13T08:49:28Z

src/core/server/saved_objects/migrations/integration_tests/7_13_0_transform_failures.test.ts

@@ -181,3 +215,36 @@ function createRoot() {
    }
  );
 }
+
+async function rootPrebotAndSetup(root: Root) {


NIT: typo: rootPrebotAndSetup

kibana-ci · 2022-06-13T16:43:21Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #50415 succeeded 5265cd6
💚 Build #50059 succeeded 45e7ac0
💛 Build #49468 was flaky a048caa
💚 Build #48826 succeeded fdf96ea
💔 Build #48812 failed 926cf1f
💚 Build #48791 succeeded a272c37

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

gsoldevila added 21 commits May 12, 2022 20:04

Add migrations.ignoreUnknownObjects flag

0f053fd

Misc enhancements following PR comments, fix UTs

6f2170e

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

7aaa4da

Fix validation

0280825

Make check_for_unknown_docs flag-agnostic. Misc enhancements

1324337

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

d2f5ea7

Minor fixes

f910871

Fix UTs

88f4462

misc doc updates

d22fa73

Simplify excludeOnUpgradeQuery helper methods

51c429a

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

1ef635e

Improve unknown type detection, improve e2e tests

9376ffa

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

13947ae

Fix tests

24c4e48

Simplify queries for unknown types, use "missing:" in agg

4e44a35

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

7a4ffaf

Unify logic from unknown_object_types and check_for_unknown_docs

a23db47

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

9fd3853

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

072a71a

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

11fe187

Small code enhancements

4ef37f4

gsoldevila added release_note:enhancement Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc backport:skip This commit does not require backporting docs v8.3.0 labels May 26, 2022

gsoldevila added 4 commits May 30, 2022 10:18

Merge branch 'main' into kbn-126672-129016-ignore-unknown-objects

0afc773

Update FTs datasets mappings, ensure saved object type is a "keyword"

05016c2

Undo changes in non-related type

f433877

Fix UTs

f9145a1

gsoldevila added 8 commits June 1, 2022 16:51

Fix imports that change with new packages

46386f5

Merge branch 'kbn-126672-129016-ignore-unknown-objects' into kbn-1290…

bde00dc

…18-discard-corrupts-objects

Merge branch 'kbn-129018-discard-corrupts-objects' of https://github.…

17912b4

…com/gsoldevila/kibana into kbn-129018-discard-corrupts-objects

Merge branch 'main' into kbn-129018-discard-corrupts-objects

a46049d

Fix imports that change with new packages

c539b62

Merge branch 'kbn-129018-discard-corrupts-objects' of https://github.…

bd58f36

…com/gsoldevila/kibana into kbn-129018-discard-corrupts-objects

Fix tests

4bb5be0

Update Jest snapshot

a272c37

gsoldevila added v8.4.0 and removed v8.3.0 labels Jun 2, 2022

Merge branch 'main' into kbn-129018-discard-corrupts-objects

926cf1f

gsoldevila commented Jun 2, 2022

View reviewed changes

Fix snapshots

fdf96ea

gsoldevila marked this pull request as ready for review June 2, 2022 12:38

gsoldevila requested a review from a team as a code owner June 2, 2022 12:38

Merge branch 'main' into kbn-129018-discard-corrupts-objects

a048caa

rudolf reviewed Jun 8, 2022

View reviewed changes

gsoldevila added 2 commits June 9, 2022 09:38

Update ascii docs, revert unwanted mapping update

9e687e2

Merge branch 'main' into kbn-129018-discard-corrupts-objects

45e7ac0

gsoldevila requested a review from rudolf June 13, 2022 08:24

gsoldevila added 2 commits June 13, 2022 10:53

Revert to default log output type

c75533e

Merge branch 'main' into kbn-129018-discard-corrupts-objects

5265cd6

pgayvallet approved these changes Jun 13, 2022

View reviewed changes

rudolf approved these changes Jun 13, 2022

View reviewed changes

Fix typo [Prebot => Preboot]

688c1a3

gsoldevila merged commit df5d2c9 into elastic:main Jun 14, 2022

rudolf mentioned this pull request Sep 9, 2022

[Discuss] Handle Saved Objects migrations for incompatible/conflicting Kibana configurations #131525

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add migrations.discardCorruptObjects flag #132984

Add migrations.discardCorruptObjects flag #132984

gsoldevila commented May 26, 2022 •

edited

Loading

gsoldevila Jun 2, 2022

elasticmachine commented Jun 2, 2022

TinaHeiligers commented Jun 6, 2022

rudolf Jun 2, 2022

rudolf Jun 8, 2022

gsoldevila Jun 9, 2022

rudolf Jun 8, 2022

gsoldevila Jun 9, 2022

pgayvallet left a comment

pgayvallet Jun 13, 2022

kibana-ci commented Jun 13, 2022

	You can configure {kib} to automatically discard all corrupt objects and transform errors that occur during a migration. When setting the configuration option `migrations.discardCorruptObjects`, {kib} will ignore the conflicting objects and proceed with the migration.
	You can configure {kib} to automatically discard all corrupt objects and transform errors that occur during a migration. When setting the configuration option `migrations.discardCorruptObjects`, {kib} will delete the conflicting objects and proceed with the migration.

Add migrations.discardCorruptObjects flag #132984

Add migrations.discardCorruptObjects flag #132984

Conversation

gsoldevila commented May 26, 2022 • edited Loading

Summary

Checklist

Risk Matrix

For maintainers

gsoldevila Jun 2, 2022

Choose a reason for hiding this comment

elasticmachine commented Jun 2, 2022

TinaHeiligers commented Jun 6, 2022

rudolf Jun 2, 2022

Choose a reason for hiding this comment

rudolf Jun 8, 2022

Choose a reason for hiding this comment

gsoldevila Jun 9, 2022

Choose a reason for hiding this comment

rudolf Jun 8, 2022

Choose a reason for hiding this comment

gsoldevila Jun 9, 2022

Choose a reason for hiding this comment

pgayvallet left a comment

Choose a reason for hiding this comment

pgayvallet Jun 13, 2022

Choose a reason for hiding this comment

kibana-ci commented Jun 13, 2022

💚 Build Succeeded

Metrics [docs]

History

gsoldevila commented May 26, 2022 •

edited

Loading