f627ed57ca
* [kbn-es] Allow overriding of Java heap Fixes #99494 Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co> Co-authored-by: Tyler Smalley <tyler.smalley@elastic.co>
1.3 KiB
@kbn/es
A command line utility for running elasticsearch from source or archive.
Getting started
If running elasticsearch from source, elasticsearch needs to be cloned to a sibling directory of Kibana.
To run, go to the Kibana root and run node scripts/es --help to get the latest command line options.
The script attempts to preserve the existing interfaces used by Elasticsearch CLI. This includes passing through options with the -E argument and the ES_JAVA_OPTS environment variable for Java options.
Examples
Run a snapshot install with a trial license
node scripts/es snapshot --license=trial
Run from source with a configured data directory
node scripts/es source --Epath.data=/home/me/es_data
API
run
Start a cluster
var es = require('@kbn/es');
es.run({
license: 'basic',
version: 7.0,
})
.catch(function (e) {
console.error(e);
process.exitCode = 1;
});
Options
options.license
Type: String
License type, one of: trial, basic, gold, platinum
options.version
Type: String
Desired elasticsearch version
options['source-path']
Type: String
Cloned location of elasticsearch repository, used when running from source
options['base-path']
Type: String
Location where snapshots are cached