add section on local CDAP sandbox run, with commands

cdapio · Apr 17, 2019 · 1b8bba3 · 1b8bba3
1 parent 094791c
commit 1b8bba3
Showing 1 changed file with 32 additions and 3 deletions.
diff --git a/DEVELOPERS.rst b/DEVELOPERS.rst
@@ -29,15 +29,15 @@ Then, configure a run configuration to run CDAP Sandbox:
 You can now use this run configuration to start an instance of CDAP Sandbox.
 
 
-Build and Run CDAP Sandbox in a Docker Container
-================================================
+Build and Run CDAP Sandbox in a Docker Container (Recommended)
+==============================================================
 
 These instructions assume the user has a working installation of Docker and a working
 understanding of Docker behavior and commands.
 
 - Obtain a fresh copy of the CDAP (GitHub) repo::
 
-    git clone git@github.com:caskdata/cdap.git
+    git clone git@github.com:cdapio/cdap.git
 
 - Build the Docker image: (from the cdap/ root directory)::
 
@@ -48,3 +48,32 @@ understanding of Docker behavior and commands.
     docker run -d -p 11011:11011 -p 11015:11015 caskdata/cdap-sandbox
 
 You now have a new Docker container running with CDAP Sandbox.
+
+Build and Run CDAP Sandbox Locally with Maven
+=============================================
+
+The following builds and runs the CDAP sandbox via mvn package. For more details on development
+environments and build options, please see the
+`BUILD.rst <https://github.com/caskdata/cdap/blob/develop/BUILD.rst>`__ file.
+
+- Obtain a fresh copy of the CDAP (GitHub) repo::
+
+    git clone git@github.com:cdapio/cdap.git
+
+- Build CDAP Sandbox distribution ZIP via mvn::
+
+    MAVEN_OPTS="-Xmx2048m" mvn clean package \
+    -pl cdap-standalone,cdap-app-templates/cdap-etl,cdap-app-templates/cdap-program-report \
+    -am -amd -DskipTests -P templates,dist,release,unit-tests
+
+- Navigate to cdap-standalone subdirectory, unzip the SDK snapshot, and use the ``cdap`` binary to start the sandbox::
+
+    cd cdap-standalone/target
+
+    unzip cdap-sandbox-<version>-SNAPSHOT.zip && cd cdap-sandbox-<version>-SNAPSHOT/bin
+
+    ./cdap sandbox start
+
+The UI runs on http://localhost:11011. To stop the sandbox, use::
+
+    ./cdap sandbox stop