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.

Sign up for GitHub

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

Jump to bottom

Update Resolver generator script documentation #69912

Merged
merged 1 commit into from
Jun 25, 2020
Merged

Update Resolver generator script documentation #69912

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 4 additions & 46 deletions x-pack/plugins/security_solution/scripts/endpoint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,52 +13,10 @@ Example command sequence to get ES and kibana running with sample data after ins

`yarn es snapshot` -> starts ES

`npx yarn start --xpack.securitySolution.enabled=true --no-base-path` -> starts kibana
`npx yarn start --no-base-path` -> starts kibana. Note: you may need other configurations steps to start the security solution with endpoint support.
Copy link
Contributor

Choose a reason for hiding this comment

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

--xpack.ingestManager.enabled=true and --xpack.ingestManager.fleet.enabled=true aren't needed here?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think xpack.ingestManager.enabled might default to true and it automatically turns on fleet as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@michaelolo24 Right now other stuff is needed, but I don't want to host documentation about that here. When that stuff changes, I'd rather document it in one place. I think we used to have a README file, but I don't see it now.

We could add instructions to this file: https:/elastic/kibana/blob/master/x-pack/plugins/security/README.md and then link to that file from this one.

Copy link
Contributor

Choose a reason for hiding this comment

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

If it's defaulted, then no need :) Was just making sure.


`cd ~/path/to/kibana/x-pack/plugins/endpoint`
`cd x-pack/plugins/security_solution/scripts/endpoint`

`yarn test:generate --auth elastic:changeme` -> run the resolver_generator.ts script
`yarn test:generate` -> run the resolver_generator.ts script

Resolver generator CLI options:
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 for removing this


```bash
Options:
--help Show help [boolean]
--seed, -s random seed to use for document generator
[string]
--node, -n elasticsearch node url
[string] [default: "http://elastic:changeme@localhost:9200"]
--kibana, -k kibana url
[string] [default: "http://elastic:changeme@localhost:5601"]
--eventIndex, --ei index to store events in
[string] [default: "events-endpoint-1"]
--metadataIndex, --mi index to store host metadata in
[string] [default: "metrics-endpoint.metadata-default-1"]
--policyIndex, --pi index to store host policy in
[string] [default: "metrics-endpoint.policy-default-1"]
--ancestors, --anc number of ancestors of origin to create
[number] [default: 3]
--generations, --gen number of child generations to create
[number] [default: 3]
--children, --ch maximum number of children per node
[number] [default: 3]
--relatedEvents, --related number of related events to create for each
process event [number] [default: 5]
--relatedAlerts, --relAlerts number of related alerts to create for each
process event [number] [default: 5]
--percentWithRelated, --pr percent of process events to add related events
and related alerts to [number] [default: 30]
--percentTerminated, --pt percent of process events to add termination
event for [number] [default: 30]
--maxChildrenPerNode, --maxCh always generate the max number of children per
node instead of it being random up to the max
children [boolean] [default: false]
--numHosts, --ne number of different hosts to generate alerts
for [number] [default: 1]
--numDocs, --nd number of metadata and policy response doc to
generate per host [number] [default: 5]
--alertsPerHost, --ape number of resolver trees to make for each host
[number] [default: 1]
--delete, -d delete indices and remake them
[boolean] [default: false]
```
To see Resolver generator CLI options, run `yarn test:generate --help`.