[GitHub] [hadoop-submarine] jojochuang commented on a change in pull request #32: SUBMARINE-217. Add Submarine Workbench introduction document

[GitBox <gi...@apache.org>]

jojochuang commented on a change in pull request #32: SUBMARINE-217. Add Submarine Workbench introduction document
URL: https://github.com/apache/hadoop-submarine/pull/32#discussion_r332195130
 
 

 ##########
 File path: docs/workbench/HowToRun.md
 ##########
 @@ -0,0 +1,72 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+   http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+# How To Run Submarine Workbench
+
+## Run Workbench
+
+```$xslt
+cd submarine
+./bin/workbench-daemon.sh [start|stop|restart]
+```
+To start workbench server, you need to download mysql jdbc jar and put it in the
+path of workbench/lib for the first time. Or you can add parameter, getMysqlJar,
+to get mysql jar automatically.
+```$xslt
+cd submarine
+./bin/workbench-daemon.sh start getMysqlJar
+```
+
+## submarine-env.sh
+
+`submarine-env.sh` is automatically executed each time the `workbench.sh` script is executed, so we can set the `workbench.sh` script and the environment variables in the `WorkbenchServer` process via `submarine-env.sh`.
+
+| Name                | Variable                                                     |
+| ------------------- | ------------------------------------------------------------ |
+| JAVA_HOME           | Set your java home path, default is `java`.                  |
+| WORKBENCH_JAVA_OPTS | Set the JAVA OPTS parameter when the Workbench process starts. If you need to debug the Workbench process, you can set it to `-agentlib:jdwp=transport=dt_socket, server=y,suspend=n,address=5005` |
+| WORKBENCH_MEM       | Set the java memory parameter when the Workbench process starts. |
+| MYSQL_JAR_URL       | The customized URL to download mysql jdbc jar.               |
+| MYSQL_VERSION       | The version of mysql jdbc jar would be downloaded. The default value is 5.1.39. It's used to generate the default value of MYSQL_JDBC_URL|
 
 Review comment:
   "would be downloaded" -> "to download"

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services