Dev guide update to include building/using local os-min distro (#757) (…

…#764) * Added unwrapping exception from core; added more debug logs Signed-off-by: Petar Dzepina <[email protected]> * updated dev guide to include building/using custom os-min distro Signed-off-by: Petar Dzepina <[email protected]> Signed-off-by: Petar Dzepina <[email protected]> (cherry picked from commit e4236db) Co-authored-by: Petar Dzepina <[email protected]>
opensearch-project · Apr 12, 2024 · 0db1a51 · 0db1a51
1 parent a715fca
commit 0db1a51
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -128,6 +128,21 @@ You can also run the integration tests against a multi-node cluster by running `
 You can also debug a multi-node cluster, by using a combination of above multi-node and debug steps.
 But, you must set up debugger configurations to listen on each port starting from `5005` and increasing by 1 for each node.
 
+### Running with custom Opensearch distribution
+
+If you're trying to execute run/integTest on ARM MacOS, or current opensearch-min distro artifact is not available for any reason, you can use your own distro jar. 
+Pass `-PcustomDistributionUrl=/path/to/distro` to run/integTest to execute them with local opensearch distro.
+
+1. Build Opensearch min distribution:
+   1. Clone [Opensearch repo](https://github.com/opensearch-project/OpenSearch)
+   2. Execute ./gradlew assemble (you will need docker installed)
+   3. Built distros are in distribution/archives/<os-arch>/distributions/
+2. `./gradlew run -PcustomDistributionUrl=/path/to/distro`
+
+Example running on ARM MacOS with local artifact:
+
+`./gradlew integTest -PnumNodes=3 -PcustomDistributionUrl=/Users/macos-user/OpenSearch/distribution/archives/darwin-arm64-tar/build/distributions/opensearch-min-2.5.0-SNAPSHOT-darwin-arm64.tar.gz`
+
 ### Backport
 
 - [Link to backport documentation](https://github.com/opensearch-project/opensearch-plugins/blob/main/BACKPORT.md)