You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@submarine.apache.org by ka...@apache.org on 2021/07/14 09:50:37 UTC
[submarine] branch master updated: SUBMARINE-933. Update Overview
in Development Guide
This is an automated email from the ASF dual-hosted git repository.
kaihsun 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 50a77b4 SUBMARINE-933. Update Overview in Development Guide
50a77b4 is described below
commit 50a77b44b416adae44a9b7ba487fd99ad511d432
Author: Kenchu123 <k8...@gmail.com>
AuthorDate: Tue Jul 13 12:48:03 2021 +0800
SUBMARINE-933. Update Overview in Development Guide
### What is this PR for?
<!-- A few sentences describing the overall goals of the pull request's commits.
First time? Check out the contributing guide - https://submarine.apache.org/contribution/contributions.html
-->
The overview part in the development guide is outdated and should be updated.
### What type of PR is it?
[Documentation]
### Todos
None
### What is the Jira issue?
<!-- * Open an issue on Jira https://issues.apache.org/jira/browse/SUBMARINE/
* Put link here, and add [SUBMARINE-*Jira number*] in PR title, eg. `SUBMARINE-23. PR title`
-->
https://issues.apache.org/jira/browse/SUBMARINE-933
### How should this be tested?
<!--
* First time? Setup Travis CI as described on https://submarine.apache.org/contribution/contributions.html#continuous-integration
* Strongly recommended: add automated unit tests for any new or changed behavior
* Outline any manual steps to test the PR here.
-->
None
### Screenshots (if appropriate)
None
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: Kenchu123 <k8...@gmail.com>
Signed-off-by: Kai-Hsun Chen <ka...@apache.org>
Closes #667 from Kenchu123/SUBMARINE-933 and squashes the following commits:
c9c9e044 [Kenchu123] SUBMARINE-933. Update Development Guide Overview
---
website/docs/devDocs/Development.md | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/website/docs/devDocs/Development.md b/website/docs/devDocs/Development.md
index 6eda09a..0934c1d 100644
--- a/website/docs/devDocs/Development.md
+++ b/website/docs/devDocs/Development.md
@@ -19,9 +19,9 @@ title: Development Guide
## Overview
-From [Getting Started/Submarine Local Deployment](../gettingStarted/localDeployment.md), you already know that Submarine is installed and uninstalled by Helm. As you can see by `kubectl get pods`, there are six major components in Submarine, including `notebook-controller`, `pytorch-operator`, `submarine-database`, `submarine-server`, `submarine-traefik` and `tf-job-operator`. They are launched as pods in kubernetes from the corresponding docker images.
+From [Getting Started/Submarine Local Deployment](../gettingStarted/localDeployment.md), you already know that Submarine is installed and uninstalled by Helm. As you can see by `kubectl get pods`, there are nine major components in Submarine, including `notebook-controller`, `pytorch-operator`, `submarine-database`, `submarine-minio`, `submarine-mlflow`, `submarine-server`, `submarine-tensorboard`, `submarine-traefik`, and `tf-job-operator`. They are launched as pods in kubernetes from t [...]
-Some of the components are borrowed from other projects (kubeflow, traefik), including `notebook-controller`, `pytorch-operator`, `submarine-traefik` and `tf-job-operator`. The rest of them are built by ourselves, including `submarine-database` and `submarine-server`.
+Some of the components are borrowed from other projects (kubeflow, traefik), including `notebook-controller`, `pytorch-operator`, `submarine-traefik` and `tf-job-operator`. The rest of them are built by ourselves, including `submarine-database`, `submarine-minio`, `submarine-mlflow`, `submarine-tensorboard`, and `submarine-server`.
The purpose of the components are as the following:
@@ -31,9 +31,12 @@ The purpose of the components are as the following:
4. `submarine-traefik`: manage the ingress service
5. `submarine-database`: store metadata in mysql database
-6. `submarine-server`: handle api request, submit job to container orchestration, and connect with database.
+6. `submarine-minio`: store machine learning artifacts in minio object storage
+7. `submarine-mlflow`: platform for managing the end-to-end machine learning lifecycle
+8. `submarine-tensorboard`: tool for providing the measurements and visualizations during ml workflow.
+9. `submarine-server`: handle api request, submit job to container orchestration, and connect with database.
-In this document, we only focus on the last two components. You can learn how to develop server, database, and workbench here.
+In this document, we focus on `submarine-server` and `submarine-database`. You can learn how to develop server, database, and workbench here.
## Video
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org