Skip to content

Refresh UEBA package docs - #9791

Merged
susan-shu-c merged 15 commits into
mainfrom
update-ueba-docs-with-install-instructions
May 16, 2024
Merged

Refresh UEBA package docs#9791
susan-shu-c merged 15 commits into
mainfrom
update-ueba-docs-with-install-instructions

Conversation

@jmcarlock

Copy link
Copy Markdown
Contributor

Proposed commit message

Refreshed the documentation for UEBA integration packages to clarify and help address incoming questions. The following packages were updated:

Changes include:

  • Links to all public facing blogs were added for additional context.
  • Added step-by-step installation instructions at the top of each readme.
  • Added anything that was missing for installation, such as how to use the enrichment policies for DGA/LotL.
  • The order of instructions is now consistent with how users will install packages.

A draft of these changes was reviewed by @susan-shu-c and @sodhikirti07.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs. These packages do not collect metrics/logs
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • Review installation instructions.

How to test this PR locally

  • Tested all packages working locally with EP.

Related issues

@jmcarlock jmcarlock added the enhancement New feature or request label May 6, 2024
@jmcarlock jmcarlock self-assigned this May 6, 2024
@jmcarlock
jmcarlock requested review from a team as code owners May 6, 2024 16:37
Comment thread packages/beaconing/docs/README.md Outdated
Comment thread packages/lmd/docs/README.md Outdated
Comment thread packages/problemchild/docs/README.md
@sodhikirti07

Copy link
Copy Markdown
Contributor

Overall, looks great! Just two minor comments:

  • Add <VERSION> instead of the current version, it'll keep us updating the versions everytime we make a change.
  • For consistency, add image for beaconing detection rules as well.

@susan-shu-c susan-shu-c left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for updating these docs!

Comment thread packages/lmd/elasticsearch/transform/pivot_transform/transform.yml Outdated
@jmcarlock
jmcarlock requested a review from qn895 May 15, 2024 20:40
@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @jmcarlock

@elastic-sonarqube

Copy link
Copy Markdown

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@susan-shu-c
susan-shu-c merged commit a7ffe7b into main May 16, 2024
@elasticmachine

Copy link
Copy Markdown

Package beaconing - 1.2.1 containing this change is available at https://epr.elastic.co/search?package=beaconing

@elasticmachine

Copy link
Copy Markdown

Package ded - 2.1.2 containing this change is available at https://epr.elastic.co/search?package=ded

@elasticmachine

Copy link
Copy Markdown

Package dga - 2.0.2 containing this change is available at https://epr.elastic.co/search?package=dga

@elasticmachine

Copy link
Copy Markdown

Package lmd - 2.1.3 containing this change is available at https://epr.elastic.co/search?package=lmd

@elasticmachine

Copy link
Copy Markdown

Package problemchild - 2.1.3 containing this change is available at https://epr.elastic.co/search?package=problemchild

@jmcarlock
jmcarlock deleted the update-ueba-docs-with-install-instructions branch May 22, 2024 17:50
@andrewkroh andrewkroh added Integration:dga Domain Generation Algorithm Detection Integration:lmd Lateral Movement Detection Integration:problemchild Living off the Land Attack Detection Integration:beaconing Network Beaconing Identification Integration:ded Data Exfiltration Detection labels Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request Integration:beaconing Network Beaconing Identification Integration:ded Data Exfiltration Detection Integration:dga Domain Generation Algorithm Detection Integration:lmd Lateral Movement Detection Integration:problemchild Living off the Land Attack Detection

6 participants