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

Change Prebuilt Security Rules Changelog Reference #156716

Merged
merged 3 commits into from
May 18, 2023

Conversation

terrancedejesus
Copy link
Contributor

Summary

This PR changes the URL reference link from Kibana UI to downloadable updates security docs site. The current link directs the user to the security doc updates that relate to file system rule updates, which is now deprecated. This update would point the user to the downloadable OOB package updates which is how we currently release prebuilt rules.

Existing: https://www.elastic.co/guide/en/security/master/prebuilt-rules-changelog.html (docs built from filesystem rules - deprecated)
Proposed: https://www.elastic.co/guide/en/security/master/prebuilt-rules-downloadable-updates.html (aligns with OOB packages - currently how we release and build docs)

@terrancedejesus terrancedejesus requested a review from spong May 4, 2023 17:00
@terrancedejesus terrancedejesus self-assigned this May 4, 2023
@terrancedejesus terrancedejesus requested a review from a team as a code owner May 4, 2023 17:00
@terrancedejesus terrancedejesus added release_note:skip Skip the PR/issue when compiling release notes Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules labels May 4, 2023
Copy link
Member

@spong spong left a comment

Choose a reason for hiding this comment

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

Change makes sense and LGTM, however I don't see any references for this being used in the app when searching for the ruleChangeLog key. Is this intended to update an existing link in the app, or just as used within the docs over in:

{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.siem",
"type": "Object",
"tags": [],
"label": "siem",
"description": [],
"signature": [
"{ readonly privileges: string; readonly guide: string; readonly gettingStarted: string; readonly ml: string; readonly ruleChangeLog: string; readonly detectionsReq: string; readonly networkMap: string; readonly troubleshootGaps: string; readonly ruleApiOverview: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},

Approving for now, but let me know if you want to update any links within Kibana and happy to take another look 🙂

@spong spong added Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team v8.9.0 labels May 5, 2023
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@spong
Copy link
Member

spong commented May 5, 2023

Also, if we need to target 8.8.0, we'll need to add the backport:prev-minor label so it'll be automatically backported.

@terrancedejesus
Copy link
Contributor Author

@spong - The release notes link in the following image is where we are attempting to change the link. Any ideas?

Re-create:

  1. Load cloud stack 8.6.0
  2. Force install outdated rules
POST kbn:/api/fleet/epm/packages/security_detection_engine/8.6.1
{
  "force": true
}
  1. Security > Manage > Rules

Notification box should pop-up.
Screenshot 2023-05-16 at 10 33 05 AM

@spong
Copy link
Member

spong commented May 17, 2023

@spong - The release notes link in the following image is where we are attempting to change the link. Any ideas?

Something must've been up with my IDE when I was checking this, as I'm seeing the reference fine now. It's over in

<EuiLink href={`${services.docLinks.links.siem.ruleChangeLog}`} target="_blank">

So we should be all good here! Sorry for the confusion @terrancedejesus, and thanks for verifying! 🙂

@terrancedejesus
Copy link
Contributor Author

terrancedejesus commented May 17, 2023

So we should be all good here! Sorry for the confusion @terrancedejesus, and thanks for verifying! 🙂

Fantastic, glad we got it squared away and thank you for always taking the time to review!

@kibana-ci
Copy link
Collaborator

💚 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
lists 158.9KB 158.9KB +11.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 365.5KB 365.5KB +11.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 19 21 +2
securitySolution 400 404 +4
total +6

Total ESLint disabled count

id before after diff
enterpriseSearch 20 22 +2
securitySolution 480 484 +4
total +6

History

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

cc @terrancedejesus

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM

@terrancedejesus terrancedejesus merged commit 839da37 into main May 18, 2023
@terrancedejesus terrancedejesus deleted the update-prebuilt-rules-doc-changes-link branch May 18, 2023 15:18
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label May 18, 2023
delanni pushed a commit to delanni/kibana that referenced this pull request May 25, 2023
## Summary
This PR changes the URL reference link from Kibana UI to downloadable
updates security docs site. The current link directs the user to the
security doc updates that relate to file system rule updates, which is
now deprecated. This update would point the user to the downloadable OOB
package updates which is how we currently release prebuilt rules.

Existing:
https://www.elastic.co/guide/en/security/master/prebuilt-rules-changelog.html
(docs built from filesystem rules - deprecated)
Proposed:
https://www.elastic.co/guide/en/security/master/prebuilt-rules-downloadable-updates.html
(aligns with OOB packages - currently how we release and build docs)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules 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. v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants