This is an automated email from the ASF dual-hosted git repository.
jiwq pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new d29ddb1 SUBMARINE-683. Clarify project structure in doc
d29ddb1 is described below
commit d29ddb128f80eb7136d7894b21762443df3cb8bb
Author: ByronHsu <[email protected]>
AuthorDate: Sat Nov 21 20:59:06 2020 +0800
SUBMARINE-683. Clarify project structure in doc
### What is this PR for?
Clarify the project structure information in
https://github.com/apache/submarine/tree/master/docs/development.
### What type of PR is it?
[Documentation]
### What is the Jira issue?
[SUBMARINE-683](https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE-683?filter=allopenissues)
Author: ByronHsu <[email protected]>
Closes #458 from ByronHsu/SUBMARINE-683 and squashes the following commits:
8a05c21 [ByronHsu] improve doc
---
docs/development/README.md | 64 ++++++++++++++++++++++------------------------
1 file changed, 30 insertions(+), 34 deletions(-)
diff --git a/docs/development/README.md b/docs/development/README.md
index 56c045e..bb74be5 100644
--- a/docs/development/README.md
+++ b/docs/development/README.md
@@ -20,7 +20,34 @@ This document mainly describes the structure of each module
of the Submarine pro
## 2. Submarine Project Structure
-### 2.1. dev-support
+### 2.1. submarine-client
+Provide the CLI interface for submarine user. (Currently only support YARN
service)
+
+### 2.2. submarine-cloud
+Define submarine operator. (Work in progress)
+
+### 2.3. submarine-commons
+Define utility function used in multiple packages, mainly related to hadoop.
+
+### 2.4. submarine-dist
+Store the pre-release files.
+
+### 2.5. submarine-sdk
+Provide Python SDK for submarine user.
+
+### 2.6. submarine-security
+Provide authorization for Apache Spark to talking to Ranger Admin.
+
+### 2.7. submarine-server
+Include core server, restful api, and k8s/yarn submitter.
+
+### 2.8. submarine-test
+Provide end-to-end and k8s test for submarine.
+### 2.9. submarine-workbench
+
+- workbench-server: is a Jetty-based web server service. Workbench-server
provides RESTful interface and Websocket interface. The RESTful interface
provides workbench-web with management capabilities for databases such as
project, department, user, and role.
+- workbench-web: is a web front-end service based on Angular.js framework.
With workbench-web users can manage Submarine project, department, user, role
through browser. You can also use the notebook to develop machine learning
algorithms, model release and other lifecycle management.
+### 2.10 dev-support
+ **mini-submarine**: by using the docker image provided by Submarine, you can
experience all the functions of Submarine in a single docker environment, while
@@ -33,37 +60,6 @@ submarine-installer, it is easy to install and deploy system
services such as
`docker`, `nvidia-docker`, `nvidia driver`, `ETCD`, `Calico network` etc.
required by yarn-3.1+.
-### 2.2. submarine-all
-
-Waiting for supplement
-
-### 2.3. submarine-core
-
-Waiting for supplement
-
-### 2.4. submarine-dist
-
-Waiting for supplement
-
-### 2.5. submarine-runtime
-
-Waiting for supplement
-
-### 2.6. submarine-sdk
-+ **pysubmarine**: By using Submarine's python sdk library, you can output
-metrics such as metrics when the algorithm is executed in your python program
by
-importing pysubmarine during the development of the machine learning algorithm.
-
-### 2.7. submarine-workbench
-+ **workbench-server**: is a Jetty-based web server service. Workbench-server
-provides RESTful interface and Websocket interface. The RESTful interface
-provides workbench-web with management capabilities for databases such as
-project, department, user, and role.
-+ **workbench-web**: is a web front-end service based on `VUE.js` framework.
-With `workbench-web` users can manage Submarine project, department, user, role
-through browser. You can also use the notebook to develop machine learning
-algorithms, model release and other lifecycle management.
-
## 3. Submarine Workbench Development Guide
Submarine workbench consists of three modules: workbench-server, workbench-web
@@ -108,7 +104,7 @@ By executing the above command, `workbench-web` will
publish the web page to the
+ **Lints and fixes files**
-When you write the `vue, js` file in `workbench-web` through IDEA, because
IDEA can't format these files well, you need to execute the following command
to format the vue and js files to avoid some warnings during the yarn build.
+When you write the `angular, js` file in `workbench-web` through IDEA, because
IDEA can't format these files well, you need to execute the following command
to format the angular and js files to avoid some warnings during the yarn build.
```
yarn run lint
@@ -134,4 +130,4 @@ So you can pass http://127.0.0.1:8080 debugging or running
to submarine-workbenc
3. The submarine-workbench, IP and 8080 ports that are accessible locally
through the port 8080 of 127.0.0.1 are configured via `workbench-site.xml`,
but we do not recommend you to modify it.
-4. When you modify the `vue` or `js` of workbench-web, you need to execute the
yarn run build command in the workbench-web directory, and let your modified
code update to the dist directory, so that you can see the effect of your code
modification in the workbench.
+4. When you modify the `angular` or `js` of workbench-web, you need to execute
the yarn run build command in the workbench-web directory, and let your
modified code update to the dist directory, so that you can see the effect of
your code modification in the workbench.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
