Skip to content

Commit caae025

Browse files
authored
Init @kbn/es readme (#39850)
* init kbn-es readme * formatting
1 parent f8065a9 commit caae025

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

Diff for: packages/kbn-es/README.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# @kbn/es
2+
3+
> A command line utility for running elasticsearch from source or archive.
4+
5+
## Getting started
6+
If running elasticsearch from source, elasticsearch needs to be cloned to a sibling directory of Kibana.
7+
8+
To run, go to the Kibana root and run `node scripts/es --help` to get the latest command line options.
9+
10+
### Examples
11+
12+
Run a snapshot install with a trial license
13+
```
14+
node scripts/es snapshot --license=trial
15+
```
16+
17+
Run from source with a configured data directory
18+
```
19+
node scripts/es source --Epath.data=/home/me/es_data
20+
```
21+
22+
## API
23+
24+
### run
25+
Start a cluster
26+
```
27+
var es = require('@kbn/es');
28+
es.run({
29+
license: 'basic',
30+
version: 7.0,
31+
})
32+
.catch(function (e) {
33+
console.error(e);
34+
process.exitCode = 1;
35+
});
36+
```
37+
38+
#### Options
39+
40+
##### options.license
41+
42+
Type: `String`
43+
44+
License type, one of: trial, basic, gold, platinum
45+
46+
##### options.version
47+
48+
Type: `String`
49+
50+
Desired elasticsearch version
51+
52+
##### options['source-path']
53+
54+
Type: `String`
55+
56+
Cloned location of elasticsearch repository, used when running from source
57+
58+
##### options['base-path']
59+
60+
Type: `String`
61+
62+
Location where snapshots are cached

0 commit comments

Comments
 (0)