Skip to content

Commit

Permalink
Small README note on bumping memory for builds (#75247)
Browse files Browse the repository at this point in the history
  • Loading branch information
Joel Griffith authored Aug 18, 2020
1 parent bfdaacd commit e30220f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/dev/build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ node scripts/build --release
node scripts/build --skip-node-download --debug --no-oss
```

# Fixing out of memory issues

Building Kibana and its distributables can take a lot of memory to finish successfully. Builds do make use of child processes, which means you can increase the amount of memory available by specifying `NODE_OPTIONS="--max-old-space-size=VALUE-IN-MEGABYTES"`.

```sh

# Use 4GB instead of the standard 1GB for building
NODE_OPTIONS="--max-old-space-size=4096" node scripts/build --release
```

# Structure

The majority of this logic is extracted from the grunt build that has existed forever, and is designed to maintain the general structure grunt provides including tasks and config. The [build_distributables.js] file defines which tasks are run.
Expand Down

0 comments on commit e30220f

Please sign in to comment.