[Reporting] Add new ILM policy notice to deprecations service #100567

jloleysens · 2021-05-25T16:01:16Z

Summary

Continuation of #100130 and fix #81544

This contribution adds an integration with the deprecation service. The deprecation flags the new reporting policy and provides a "quick resolution" in the upgrade assistant which uses the new "PUT /deprecations" endpoint.

How to review

Check the added copy for any obvious errors or wording issues (requires proper copy review)
Start Kibana & ES on a trial license
Add sample flight data
Choose the Global Flight dashboard and choose Share > PDF Reports > Generate report
Edit upgrade assistant to show deprecations UI. Open x-pack/plugins/upgrade_assistant/common/constants.ts and set:

export const UA_READONLY_MODE = false;

Go to the upgrade assistant and click on the "Quick resolve" button (screenshot 👇🏻)

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
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

jloleysens · 2021-05-25T16:01:23Z

@elasticmachine merge upstream

kibanamachine · 2021-05-25T16:01:25Z

merge conflict between base and head

…deprecation-ilm-policy * 'master' of github.com:elastic/kibana: (101 commits) [ftr] migrate "docTable" service to FtrService class (elastic#100595) [ftr] migrate "listingTable" service to FtrService class (elastic#100606) Fixed comparing real value with formatted according to mode. (elastic#100456) [ftr] migrate "dataGrid" service to FtrService class (elastic#100593) [ftr] migrate "fieldEditor" to FtrService class (elastic#100597) [ftr] migrate "filterBar" service to FtrService class (elastic#100601) [triggersActionsUi] Reduce page load bundle to under 100kB (elastic#97770) [build] Clean jest configs (elastic#100594) refact(NA): remove extra pkg_npm target and add specific target folders for @kbn/analytics on Bazel (elastic#100569) Update dependency @elastic/charts to v29.2.0 (elastic#100587) [Maps] convert LayerPanel to typescript (elastic#100481) [Upgrade Assistant] Address copy feedback (elastic#99632) Open/Closed filter for observability alerts page (elastic#99217) One liner to expose the EQL query for debugging for users (elastic#100565) [KibanaPageLayout] Solution Nav specific styles & props (elastic#100089) [ftr] implement FtrService classes and migrate common services (elastic#99546) [XY] [Lens] Adds opacity slider (elastic#100453) [Reporting] ILM policy for managing reporting indices (elastic#100130) [Reporting] ILM policy for managing reporting indices (elastic#100130) [DOCS] Remove redundant maps attribute (elastic#100426) ... # Conflicts: # x-pack/plugins/reporting/server/lib/store/report_ilm_policy.ts # x-pack/plugins/reporting/server/lib/store/store.test.ts # x-pack/plugins/reporting/server/lib/store/store.ts

elasticmachine · 2021-05-26T12:20:33Z

Pinging @elastic/kibana-app-services (Team:AppServices)

elasticmachine · 2021-05-26T12:20:35Z

Pinging @elastic/kibana-reporting-services (Team:Reporting Services)

jloleysens · 2021-05-27T10:16:56Z

@elasticmachine merge upstream

- renmoved manual steps section from the ilm migration deprecation - fixed Jest tests - fixed issues after merging master

jloleysens · 2021-06-02T08:07:59Z

@elasticmachine merge upstream

kibanamachine · 2021-06-02T08:46:02Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: b769761
Storybooks Preview
Pipeline Steps (look for red circles / failed steps)
Interpreting CI Failures

Failed CI Steps

Test Failures

Kibana Pipeline / jest / Jest Tests.x-pack/plugins/reporting/server/deprecations.Migrate existing indices' ILM policy deprecations returns deprecation information when reporting indices are not using the reporting ILM policy

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has not failed recently on tracked branches

Stack Trace

Error: expect(received).toMatchInlineSnapshot(snapshot)

Snapshot name: `Migrate existing indices' ILM policy deprecations returns deprecation information when reporting indices are not using the reporting ILM policy 1`

- Snapshot  - 3
+ Received  + 0

@@ -3,13 +3,10 @@
      "correctiveActions": Object {
        "api": Object {
          "method": "PUT",
          "path": "/api/reporting/deprecations/migrate_ilm_policy",
        },
-       "manualSteps": Array [
-         "Send a request to Elasticsearch that configures indices matching \".reporting-*\" to be managed by the \"kibana-reporting\" Index Lifecycle Policy.",
-       ],
      },
      "level": "warning",
      "message": "All new reporting indices will be managed by a provisioned ILM policy: \"kibana-reporting\". To manage the lifecycle of reports edit the kibana-reporting policy. Please note, this action will target all indices prefixed with \".reporting-*\".",
    },
  ]
    at Object.<anonymous> (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/x-pack/plugins/reporting/server/deprecations/migrage_existing_indices_ilm_policy.test.ts:55:75)
    at processTicksAndRejections (internal/process/task_queues.js:95:5)
    at _callCircusTest (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:212:5)
    at _runTest (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:149:3)
    at _runTestsForDescribeBlock (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:63:9)
    at _runTestsForDescribeBlock (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:57:9)
    at run (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/run.js:25:3)
    at runAndTransformResultsToJestFormat (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:176:21)
    at jestAdapter (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:109:19)
    at runTestInternal (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-runner/build/runTest.js:380:16)
    at runTest (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-runner/build/runTest.js:472:34)
    at Object.worker (/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/node_modules/jest-runner/build/testWorker.js:133:12)

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`reporting`	84.4KB	84.6KB	+195.0B

History

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

lockewritesdocs

Suggested a revision for the reporting indices message. As we discussed, I think there needs to be UI enhancements for the manual steps that users take for this action.

lockewritesdocs · 2021-06-02T16:31:44Z

x-pack/plugins/reporting/server/deprecations/migrate_existing_indices_ilm_policy.ts

+      {
+        level: 'warning',
+        message: i18n.translate('xpack.reporting.deprecations.migrateIndexIlmPolicyActionMessage', {
+          defaultMessage: `All new reporting indices will be managed by a provisioned ILM policy: "{reportingIlmPolicy}". To manage the lifecycle of reports edit the {reportingIlmPolicy} policy. Please note, this action will target all indices prefixed with "{indexPattern}".`,


Suggested change

defaultMessage: `All new reporting indices will be managed by a provisioned ILM policy: "{reportingIlmPolicy}". To manage the lifecycle of reports edit the {reportingIlmPolicy} policy. Please note, this action will target all indices prefixed with "{indexPattern}".`,

defaultMessage: `New reporting indices will be managed by the "{reportingIlmPolicy}" provisioned ILM policy. You must edit this policy to manage the report lifecycle. This change targets all indices prefixed with "{indexPattern}".`,

jloleysens · 2021-07-05T14:08:53Z

Opening a different PR for this since updating is non-trivial: #104303

jloleysens and others added 10 commits May 14, 2021 17:10

wip; added logic for creating ILM policy at start up

944c541

Merge branch 'master' into reporting/ilm-policy

13885c6

added log when ilm policy is not created

c94974f

added test for start function

cc739ba

updated ilm policy to not delete data

e9a27f7

actually update jest snapshots and remove unused import

385e170

Merge branch 'master' into reporting/ilm-policy

ccaa9a7

updated the ilm policy, removed the min_age for the hot phase

bcabc5c

wip: integrate reporting with upgrade assistant

37aa7fd

initial version of upgrade assistant integration

d649f56

jloleysens added (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead v8.0.0 Team:AppServices release_note:skip Skip the PR/issue when compiling release notes v7.14.0 labels May 25, 2021

jloleysens added 8 commits May 26, 2021 10:46

remove TODO and added manual step

24ec3b7

removed unnecessary api request body

bf030cb

added jest test for deprecations registration

7a0ff6d

use the scoped elasticsearch user

647827e

added jest test for deprecations route

f9e66a3

added additional test for error responses

d3d3211

fix i18n

cb5ecdc

jloleysens requested a review from tsullivan May 26, 2021 12:20

jloleysens marked this pull request as ready for review May 26, 2021 12:20

kibanamachine and others added 2 commits May 27, 2021 06:16

Merge branch 'master' into reporting/ua-deprecation-ilm-policy

01189d9

- moved deprecations.ts to deprecations folder

62989f7

- renmoved manual steps section from the ilm migration deprecation - fixed Jest tests - fixed issues after merging master

Merge branch 'master' into reporting/ua-deprecation-ilm-policy

b769761

lockewritesdocs reviewed Jun 2, 2021

View reviewed changes

jloleysens added v7.15.0 and removed v7.14.0 labels Jun 28, 2021

jloleysens closed this Jul 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Reporting] Add new ILM policy notice to deprecations service #100567

[Reporting] Add new ILM policy notice to deprecations service #100567

jloleysens commented May 25, 2021 •

edited by lockewritesdocs

Loading

jloleysens commented May 25, 2021

kibanamachine commented May 25, 2021

elasticmachine commented May 26, 2021

elasticmachine commented May 26, 2021

jloleysens commented May 27, 2021

jloleysens commented Jun 2, 2021

kibanamachine commented Jun 2, 2021 •

edited

Loading

Standard Out

Stack Trace

lockewritesdocs left a comment

lockewritesdocs Jun 2, 2021

jloleysens commented Jul 5, 2021

	defaultMessage: `All new reporting indices will be managed by a provisioned ILM policy: "{reportingIlmPolicy}". To manage the lifecycle of reports edit the {reportingIlmPolicy} policy. Please note, this action will target all indices prefixed with "{indexPattern}".`,
	defaultMessage: `New reporting indices will be managed by the "{reportingIlmPolicy}" provisioned ILM policy. You must edit this policy to manage the report lifecycle. This change targets all indices prefixed with "{indexPattern}".`,

[Reporting] Add new ILM policy notice to deprecations service #100567

[Reporting] Add new ILM policy notice to deprecations service #100567

Conversation

jloleysens commented May 25, 2021 • edited by lockewritesdocs Loading

Summary

How to review

Checklist

For maintainers

jloleysens commented May 25, 2021

kibanamachine commented May 25, 2021

elasticmachine commented May 26, 2021

elasticmachine commented May 26, 2021

jloleysens commented May 27, 2021

jloleysens commented Jun 2, 2021

kibanamachine commented Jun 2, 2021 • edited Loading

💔 Build Failed

Failed CI Steps

Test Failures

Standard Out

Stack Trace

Metrics [docs]

Page load bundle

History

lockewritesdocs left a comment

Choose a reason for hiding this comment

lockewritesdocs Jun 2, 2021

Choose a reason for hiding this comment

jloleysens commented Jul 5, 2021

jloleysens commented May 25, 2021 •

edited by lockewritesdocs

Loading

kibanamachine commented Jun 2, 2021 •

edited

Loading