History

Tiago Costa 1972311f6f fix(NA): windows ts_project outside sandbox compilation (#100947 ) (#101305 ) * fix(NA): windows ts_project outside sandbox compilation adding tsconfig paths for packages * chore(NA): missing @kbn paths for node_modules so types can work * chore(NA): missing @kbn paths for node_modules so types can work * chore(NA): organizing deps on non ts_project packages * chore(NA): change order to find @kbn packages on node_modules first * chore(NA): add @kbn/expect typings setting on package.json * chore(NA): fix typechecking * chore(NA): add missing change on tsconfig file * chore(NA): unblock windows build by not depending on the pkg_npm rule symlink in the package.json * chore(NA): add missing depedencies on BUILD.bazel file for io-ts-list-types * chore(NA): remove rootDirs configs * chore(NA): change kbn/monaco targets order * chore(NA): update kbn-monaco build Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # package.json		2021-06-03 14:53:36 -04:00
..
src	[kbn-es] Allow overriding of Java heap (#99517 ) (#99794 )	2021-05-11 12:31:37 -04:00
.babelrc	chore(NA): moving @kbn/es into bazel (#99371 ) (#99405 )	2021-05-06 02:07:43 +00:00
BUILD.bazel	fix(NA): windows ts_project outside sandbox compilation (#100947 ) (#101305 )	2021-06-03 14:53:36 -04:00
jest.config.js	[7.x] Elastic License 2.0 (#90192 )	2021-02-03 18:39:13 -08:00
package.json	chore(NA): moving @kbn/es into bazel (#99371 ) (#99405 )	2021-05-06 02:07:43 +00:00
README.md	[kbn-es] Allow overriding of Java heap (#99517 ) (#99794 )	2021-05-11 12:31:37 -04:00
tsconfig.json	Introduce TS incremental builds & move src/test_utils to TS project (#76082 ) (#76632 )	2020-09-03 23:02:05 +02: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