From 1675b41b9df81e29bc43503dd7fa64fa789c786f Mon Sep 17 00:00:00 2001 From: Alexei Karikov Date: Fri, 7 Apr 2023 22:22:47 +0600 Subject: [PATCH] Update DEVELOPER_GUIDE.md (#3764) * Update for devguide.md * Add changelog entry Signed-off-by: Alexei Karikov Signed-off-by: David Sinclair --- CHANGELOG.md | 1 + DEVELOPER_GUIDE.md | 32 +++++++++++++++++++++++++++++++- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0264ed087127..38464c637494 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -145,6 +145,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - [Doc] Add docker dev set up instruction ([#3444](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3444)) - [Doc] UI actions explorer ([#3614](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3614)) - [Doc] Update SECURITY.md with instructions for nested dependencies and backporting ([#3497](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3497)) +- [Doc] Update DEVELOPER_GUIDE.md with added manual bootstrap timeout solution and max virtual memory error solution with docker ([#3764](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3764)) ### 🛠 Maintenance diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 2c964f3d6989..d3c8b269c4c0 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -98,7 +98,19 @@ The `osd bootstrap` command will install the project's dependencies and build al $ yarn osd bootstrap ``` -Note: If you experience a network timeout while bootstrapping, you can update the timeout by configuring it in the [`.yarnrc`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/.yarnrc). For example: +Note: If you experience a network timeout while bootstrapping: + +``` +| There appears to be trouble with your network connection. Retrying... +``` + +You can run command with —network-timeout flag: + +``` +$ yarn osd bootstrap —network-timeout 1000000 +``` + +Or use the timeout by configuring it in the [`.yarnrc`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/.yarnrc). For example: ``` network-timeout 1000000 @@ -146,6 +158,24 @@ Note - it may take a couple minutes to generate all the necessary bundles. If th [success][@osd/optimizer] 28 bundles compiled successfully after 145.9 sec, watching for changes ``` +Note: If you run a docker image, an error may occur: + +``` +Error: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144] +``` + +This error is because there is not enough memory so more memory must be allowed to be used: + +``` +$ sudo sysctl -w vm.max_map_count=262144 +``` + +For windows: + +``` +$ wsl -d docker-desktop +$ sysctl -w vm.max_map_count=262144 +``` ### Next Steps Now that you have a development environment to play with, there are a number of different paths you may take next.