-
Notifications
You must be signed in to change notification settings - Fork 18
[EDR Workflows] Add Automatic Troubleshooting knowledge base documents #705
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
Conversation
|
@pzl |
joeypoon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for adding these, looks great to me 🙆♂️.
I don't think moving that readme file is the appropriate fix. That is the correct path for an integration's primary readme file (spec) and is required at that location. You may be seeing a bug in Fleet's handling of that directory also to note, since I was double-checking the spec: It looks like directories are not allowed in This package is out of spec in other places already, so we don't validate currently, but for legacy reasons. We should probably avoid adding more |
|
@pzl |
pzl
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the *.md files are good!
I don't think the other package assets need changes as part of this
package/endpoint/manifest.yml
Outdated
| title: Elastic Defend | ||
| description: Protect your hosts and cloud workloads with threat prevention, detection, and deep security data visibility. | ||
| version: 9.2.0 | ||
| version: 9.3.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if you want to set this to 9.3.0-prerelease.0 you can, but otherwise you can just leave this as is. 9.2.0 package shipped, this label is just behind. We can't merge with it set to 9.3.0 though
package/endpoint/changelog.yml
Outdated
| changes: | ||
| - description: Add Automatic Troubleshooting knowledge base documents for policy response failures | ||
| type: enhancement | ||
| link: https://github.com/elastic/endpoint-package/pull/705 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this will be added as part of release process automatically
adding it now will fail some validations
|
@pzl |
Summary
This PR adds Automatic Troubleshooting knowledge base documentation for policy response failures to the endpoint package. These docs will be automatically indexed by Fleet into the
.integration_knowledgesystem index when the package is installed.Part of the broader effort to migrate KB context docs from Kibana's Elastic Assistant plugin to the endpoint package, enabling out-of-band updates independent of Kibana releases.
Changes
Knowledge Base Documents
package/endpoint/docs/knowledge_base/automatic_troubleshooting/policy_response_failures/Document Headers
Updated frontmatter format from:
To:
This prepares for future expansion with additional insight types beyond policy response failures.
Package Configuration
manifest.yml: Version9.2.0→9.3.0-next, Kibana version requirement^9.2.0→^9.3.0changelog.yml: Added entry for knowledge base docs additionFile Structure
Testing
Prerequisites
yarn es snapshot --license trial.elser_model_2) required for semantic text indexinginstallIntegrationsKnowledgemake run-registryxpack.fleet.registryUrl: "http://127.0.0.1:8080"Test Steps
9.3.0-nextversion available viacurl "http://localhost:8080/search?package=endpoint&prerelease=true"9.3.0-nextthrough Kibana UI (Management → Integrations).integration_knowledgewith correct nested pathsVerification Query
Results: All 14 documents indexed with:
package_name:"endpoint"filename: Preserved nested paths like"automatic_troubleshooting/policy_response_failures/linux_agent_connectivity.md"content: Full markdown with updated frontmatter headersversion:"9.3.0-next"Closes https://github.com/elastic/security-team/issues/14877
Part of https://github.com/elastic/security-team/issues/14786