mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
7d1b1bed6c
Closes #159260 ## Summary Adds support for running ES through Docker and Serverless in `@kbn/es` ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Tiago Costa <tiago.costa@elastic.co>
130 lines
No EOL
3.8 KiB
Text
130 lines
No EOL
3.8 KiB
Text
---
|
|
id: kibDevDocsOpsEs
|
|
slug: /kibana-dev-docs/ops/es
|
|
title: "@kbn/es"
|
|
description: A cli package for running elasticsearch or building snapshot artifacts
|
|
date: 2022-05-24
|
|
tags: ['kibana', 'dev', 'contributor', 'operations', 'es']
|
|
---
|
|
|
|
> A command line utility for running elasticsearch from snapshot, source, archive, docker, serverless or even building snapshot artifacts.
|
|
|
|
## Getting started
|
|
If running elasticsearch from source, elasticsearch needs to be cloned to a sibling directory of Kibana.
|
|
|
|
If running elasticsearch serverless or a docker container, docker is required to be installed locally. Installation instructions can be found [here](https://www.docker.com/).
|
|
|
|
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
|
|
```
|
|
|
|
Run serverless with a specific image tag
|
|
```
|
|
node scripts/es serverless --tag git-fec36430fba2-x86_64
|
|
```
|
|
|
|
Run an official Docker release
|
|
```
|
|
node scripts/es docker --tag 8.8.2
|
|
```
|
|
|
|
## 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
|
|
|
|
## Snapshot Updates
|
|
|
|
Snapshots are built and tested daily. If tests pass, the snapshot is promoted and will automatically be used when started from the CLI.
|
|
|
|
CI pipelines supporting this can be found at:
|
|
|
|
- https://buildkite.com/elastic/kibana-elasticsearch-snapshot-build
|
|
- https://buildkite.com/elastic/kibana-elasticsearch-snapshot-verify
|
|
- https://buildkite.com/elastic/kibana-elasticsearch-snapshot-promote
|
|
|
|
## Snapshot Pinning
|
|
|
|
Sometimes we need to pin snapshots for a specific version. We'd really like to get this automated, but until that is completed here are the steps to take to build, upload, and switch to pinned snapshots for a branch.
|
|
|
|
To use these steps you'll need to setup the google-cloud-sdk, which can be installed on macOS with `brew cask install google-cloud-sdk`. Login with the CLI and you'll have access to the `gsutil` to do efficient/parallel uploads to GCS from the command line.
|
|
|
|
1. Clone the elasticsearch repo somewhere
|
|
2. Checkout the branch you want to build
|
|
3. Build the new artifacts
|
|
|
|
```
|
|
node scripts/es build_snapshots --output=~/Downloads/tmp-artifacts --source-path=/path/to/es/repo
|
|
```
|
|
|
|
4. Check that the files in `~/Downloads/tmp-artifacts` look reasonable
|
|
5. Upload the files to GCS
|
|
|
|
```
|
|
gsutil -m rsync . gs://kibana-ci-tmp-artifacts/
|
|
```
|
|
|
|
6. Once the artifacts are uploaded, modify `packages/kbn-es/src/custom_snapshots.js` in a PR to use a URL formatted like:
|
|
|
|
```
|
|
// force use of manually created snapshots until ReindexPutMappings fix
|
|
if (!process.env.KBN_ES_SNAPSHOT_URL && !process.argv.some(isVersionFlag)) {
|
|
// return undefined;
|
|
return 'https://storage.googleapis.com/kibana-ci-tmp-artifacts/{name}-{version}-{os}-x86_64.{ext}';
|
|
}
|
|
```
|
|
|
|
For 6.8, the format of the url should look like:
|
|
|
|
```
|
|
'https://storage.googleapis.com/kibana-ci-tmp-artifacts/{name}-{version}.{ext}';
|
|
``` |