History

Kibana Machine c2f054f7a6 [ci] bump Jenkins worker memory and es JVM size (#111760 ) (#111787 ) Co-authored-by: spalger <spalger@users.noreply.github.com> Co-authored-by: Spencer <email@spalger.com> Co-authored-by: spalger <spalger@users.noreply.github.com>		2021-09-09 20:39:43 +00:00
..
src	[ci] bump Jenkins worker memory and es JVM size (#111760 ) (#111787 )	2021-09-09 20:39:43 +00:00
BUILD.bazel	chore(NA): moving @kbn/es to babel transpiler (#107577 ) (#107595 )	2021-08-03 19:26:00 -04:00
jest.config.js
package.json	chore(NA): moving @kbn/es to babel transpiler (#107577 ) (#107595 )	2021-08-03 19:26:00 -04:00
README.md
tsconfig.json	[build_ts_refs] improve caches, allow building a subset of projects (#107981 ) (#108139 )	2021-08-11 05:08:54 -04:00

README.md

@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