diff --git a/x-pack/plugins/endpoint/scripts/README.md b/x-pack/plugins/endpoint/scripts/README.md index f749fc34d86158..de3447987dce85 100644 --- a/x-pack/plugins/endpoint/scripts/README.md +++ b/x-pack/plugins/endpoint/scripts/README.md @@ -1,17 +1,23 @@ This script makes it easy to create the endpoint metadata, alert, and event documents needed to test Resolver in Kibana. -The default behavior is to create 1 endpoint with 1 alert and a moderate number of events (random, typically on the order of 20). +The default behavior is to create 1 endpoint with 1 alert and a moderate number of events (random, typically on the order of 20). **THE EVENT AND METADATA INDICES WILL BE DELETED AND REMADE BEFORE INSERTING.** A seed value can be provided as a string for the random number generator for repeatable behavior, useful for demos etc. The sample data generator script depends on ts-node, install with npm: -`npm install -g ts-node` + +```npm install -g ts-node``` + Example command sequence to get ES and kibana running with sample data after installing ts-node: -`yarn es snapshot` -> starts ES -`npx yarn start --xpack.endpoint.enabled=true --no-base-path` -> starts kibana -`cd ~/path/to/kibana/x-pack/plugins/endpoint` -`yarn test:generate --auth elastic:changeme` + +```yarn es snapshot``` -> starts ES + +```npx yarn start --xpack.endpoint.enabled=true --no-base-path``` -> starts kibana + +```cd ~/path/to/kibana/x-pack/plugins/endpoint``` + +```yarn test:generate --auth elastic:changeme``` -> run the resolver_generator.ts script Resolver generator CLI options: - --help Show help [boolean] +```--help Show help [boolean] --seed, -s random seed to use for document generator [string] --node, -n elasticsearch node url [string] [default: "http://localhost:9200"] @@ -36,4 +42,4 @@ Resolver generator CLI options: --numEndpoints, --ne number of different endpoints to generate alerts for [number] [default: 1] --alertsPerEndpoint, --ape number of resolver trees to make for each endpoint - [number] [default: 1] \ No newline at end of file + [number] [default: 1]```