Skip to content
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

[Security Solution] Show deprecated bulk endpoints in Upgrade Assistant #207091

Merged

Conversation

nikitaindik
Copy link
Contributor

@nikitaindik nikitaindik commented Jan 17, 2025

Partially addresses: #193184

Summary

We are going to remove our deprecated bulk action endpoints in v9.0.0. They are already unavailable in main.

This PR makes deprecated bulk endpoints visible in Upgrade Assistant. Also, it adds an upgrade guide to the documentation to help users transition to supported endpoints.

⚠️ This PR temporarily adds the deprecated endpoints back to register_routes.ts. This is needed to make merging changes easier. I'll open up a follow up PR for main that will delete these endpoints from 9.0. Will do it once this PR is merged.

Screenshots

Deprecated endpoints visible in Upgrade Assistant table
Scherm­afbeelding 2025-01-21 om 11 27 53

Clicking on a table item opens a flyout with more info

patch_update post_create
put_update post_delete

Clicking on "Learn more" in the flyout takes you to the upgrade guide
upgrade_notes

Testing

Once you send a request to one of the deprecated endpoints it should show up in Upgrade Assistant at <basePath>/app/management/stack/upgrade_assistant/kibana_deprecations.
Please refer to this ticket for the list of deprecated endpoints.

Work started on: 16-Jan-2025

@nikitaindik nikitaindik added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Feature:Rule Management Security Solution Detection Rule Management area Team:Detection Rule Management Security Detection Rule Management Team backport:version Backport to applied version labels v8.18.0 labels Jan 17, 2025
@nikitaindik nikitaindik self-assigned this Jan 17, 2025
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@nikitaindik
Copy link
Contributor Author

run docs-build

1 similar comment
@nikitaindik
Copy link
Contributor Author

run docs-build

@nikitaindik nikitaindik force-pushed the upgrade-assistant-deprecated-bulk-endpoints branch from 55399e8 to c536de8 Compare January 21, 2025 09:55
@nikitaindik
Copy link
Contributor Author

run docs-build

@nikitaindik nikitaindik added ci:cloud-deploy Create or update a Cloud deployment ci:project-deploy-security Create a Security Serverless Project labels Jan 21, 2025
@nikitaindik nikitaindik marked this pull request as ready for review January 21, 2025 10:45
@nikitaindik nikitaindik requested review from a team as code owners January 21, 2025 10:45
@nikitaindik nikitaindik requested a review from dplumlee January 21, 2025 10:45
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

@nikitaindik nikitaindik requested a review from jkelas January 21, 2025 11:21
@banderror
Copy link
Contributor

Hey @nikitaindik, could you please post a screenshot of the flyout for each deprecation issue from the first screenshot?

@nikitaindik
Copy link
Contributor Author

It works properly for me on Chrome even when opening in the same browser tab. Can you try clearing your cache or using incognito mode to see if that works?

@natasha-moore-elastic It seems to be intermittent when opening a new tab in Chrome for me - sometimes works, sometimes doesn't. If you open in a new window or incognito it works every time.

To make things a bit simpler, we can use the attribute for the API reference instead of hard-coding the URL

Done! Thanks, indeed hardcoding it wasn't a good idea!

@nikitaindik
Copy link
Contributor Author

run docs-build

@natasha-moore-elastic
Copy link
Contributor

natasha-moore-elastic commented Jan 22, 2025

It works properly for me on Chrome even when opening in the same browser tab. Can you try clearing your cache or using incognito mode to see if that works?

@natasha-moore-elastic It seems to be intermittent when opening a new tab in Chrome for me - sometimes works, sometimes doesn't. If you open in a new window or incognito it works every time.

To make things a bit simpler, we can use the attribute for the API reference instead of hard-coding the URL

Done! Thanks, indeed hardcoding it wasn't a good idea!

Let's see what it's like now when the updated links build. 🤞 I see here that the Kibana API docs were updated last night, so maybe that's what's causing the glitch for you and Nastasha.

@nikitaindik
Copy link
Contributor Author

run docs-build rebuild

@nikitaindik nikitaindik force-pushed the upgrade-assistant-deprecated-bulk-endpoints branch from 00e8e00 to 8b8b6ed Compare January 22, 2025 15:01
@nikitaindik nikitaindik enabled auto-merge (squash) January 22, 2025 15:11
@elasticmachine
Copy link
Contributor

elasticmachine commented Jan 22, 2025

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
aiAssistantManagementSelection 93.5KB 93.6KB +78.0B
lists 142.9KB 143.0KB +78.0B
securitySolution 21.3MB 21.3MB -78.0B
total +78.0B

Page load bundle

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

id before after diff
core 483.7KB 483.8KB +78.0B
securitySolution 88.1KB 88.1KB +55.0B
total +133.0B

History

cc @nikitaindik

@nikitaindik nikitaindik merged commit 3314537 into elastic:main Jan 22, 2025
8 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12912813832

@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.x Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 207091

Questions ?

Please refer to the Backport tool documentation

@nikitaindik
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

nikitaindik added a commit to nikitaindik/kibana that referenced this pull request Jan 22, 2025
…nt (elastic#207091)

**Partially addresses: elastic#193184

## Summary
We are going to remove our deprecated [bulk action
endpoints](elastic#193184) in v9.0.0.
They are already unavailable in `main`.

This PR makes deprecated bulk endpoints visible in Upgrade Assistant.
Also, it adds an upgrade guide to the documentation to help users
transition to supported endpoints.

⚠️ This PR temporarily adds the deprecated endpoints back to
`register_routes.ts`. This is needed to make merging changes easier.
I'll open up a follow up PR for `main` that will delete these endpoints
from `9.0`. Will do it once this PR is merged.

## Screenshots
**Deprecated endpoints visible in Upgrade Assistant table**
<img width="1276" alt="Scherm­afbeelding 2025-01-21 om 11 27 53"
src="https://github.com/user-attachments/assets/909c7a20-31d9-46bb-89ec-b409550074e4"
/>

**Clicking on a table item opens a flyout with more info**
<table>
  <tr>
    <td>
<img width="1270" alt="patch_update"
src="https://github.com/user-attachments/assets/8e99459d-1ea1-40c4-936c-23074c02cd6f"
/>
    </td>
    <td>
<img width="1270" alt="post_create"
src="https://github.com/user-attachments/assets/6e734e97-4cf4-4d96-9f8d-51efeb3977ad"
/>
    </td>
  </tr>
  <tr>
    <td>
<img width="1270" alt="put_update"
src="https://github.com/user-attachments/assets/d5b08e16-bf49-475d-81a9-fe5654483e1d"
/>
    </td>
    <td>
<img width="1271" alt="post_delete"
src="https://github.com/user-attachments/assets/ccb74552-50a4-4bdb-b04e-06857caa8f38"
/>
    </td>
  </tr>
</table>

**Clicking on "Learn more" in the flyout takes you to the [upgrade
guide](https://kibana_bk_207091.docs-preview.app.elstc.co/guide/en/kibana/master/breaking-changes-summary.html#breaking-207091)**
<img width="731" alt="upgrade_notes"
src="https://github.com/user-attachments/assets/b8b471ea-98c7-4b07-91db-b1630c382554"
/>

## Testing
Once you send a request to one of the deprecated endpoints it should
show up in Upgrade Assistant at
`<basePath>/app/management/stack/upgrade_assistant/kibana_deprecations`.
Please refer to [this
ticket](elastic#193184) for the list of
deprecated endpoints.

Work started on: 16-Jan-2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels ci:cloud-deploy Create or update a Cloud deployment ci:project-deploy-security Create a Security Serverless Project Feature:Rule Management Security Solution Detection Rule Management area release_note:skip Skip the PR/issue when compiling release notes Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. ui-copy Review of UI copy with docs team is recommended v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants