[GitHub] [submarine] pingsutw commented on a change in pull request #303: (WIP) Submarine-519, refactor of submarine documentation.

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

pingsutw commented on a change in pull request #303:
URL: https://github.com/apache/submarine/pull/303#discussion_r432828766



##########
File path: docs/userdocs/k8s/deploy-submarine.md
##########
@@ -0,0 +1,76 @@
+
+
+# Deploy Submarine On K8s
+
+## Deploy Submarine using Helm Chart (Recommended)
+
+### Create images
+submarine server
+```bash
+./dev-support/docker-images/submarine/build.sh
+```
+
+submarine database
+```bash
+./dev-support/docker-images/database/build.sh
+```
+
+### install helm
+For more info see https://helm.sh/docs/intro/install/
+
+### Deploy Submarine Server, mysql
+You can modify some settings in ./helm-charts/submarine/values.yaml
+```bash
+helm install submarine ./helm-charts/submarine
+```
+
+### Delete deployment
+```bash
+helm delete submarine
+```
+
+FIXME: TF Operator / PyTorch Operator can be deployed by Helm Chart, correct?
+
+## Deploy Submarine Manually
+
+### Get package
+You can dowload submarine from releases page or build from source.
+
+### Configuration
+Copy the kube config into `conf/k8s/config` or modify the `conf/submarine-site.xml`:
+```
+<property>
+  <name>submarine.k8s.kube.config</name>
+  <value>PATH_TO_KUBE_CONFIG</value>
+</property>

Review comment:
       we've removed this config in https://github.com/apache/submarine/commit/d8f682fd6e8552e4467d012be6190412f22dc499, 
   currently users only need to set `KUBE_CONFIG` in the environment variable. 
   https://github.com/apache/submarine/blob/87b2296da9eeadd80765cfa49e3d262c7d32b4e1/submarine-server/server-submitter/submitter-k8s/src/main/java/org/apache/submarine/server/submitter/k8s/K8sJobSubmitter.java#L73-L79

##########
File path: docs/user-guide-home.md
##########
@@ -0,0 +1,34 @@
+<!--
+   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.
+-->
+# User Document of Submarine
+
+This is index of user-document of Submarine.
+
+## Build From Code
+
+[Build From Code Guide](./development/BuildFromCode.md)
+
+FIXME: Where's build guide for K8s? How can we make it clear?
+
+## Use Submarine on YARN
+
+Please refer to [Submarine On YARN](userdocs/yarn/README.md)
+
+## Use Submarine on K8s
+
+Please refer to [Submarine On YARN]()

Review comment:
       ```suggestion
   Please refer to [Submarine On K8s]()
   ```

##########
File path: docs/userdocs/k8s/README.md
##########
@@ -0,0 +1,41 @@
+<!--
+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.
+-->
+
+# Running Submarine on K8s
+
+Submarine for K8s supports standalone distributed TensorFlow and PyTorch.
+
+Submarine can run on K8s >= (FIXME, version), supports features like GPU isolation.
+
+## Submarine on K8s guide
+
+### Prepare K8s and deploy Submarine Service
+
+[Setup Kubernetes](setup-kubernetes.md): Submarine can be deployed on any K8s environment if version matches. If you don't have a running K8s, you can follow the steps to set up a K8s using [kind, Kubernetes-in-Docker](https://kind.sigs.k8s.io/) for testing purpose.
+
+After you have an up-and-running K8s, you can follow [Deploy Submarine Services on K8s](deploy-submarine.md) guide to deploy Submarine services on K8s using Helmchart in minutes (FIXME: is it true?).
+
+### Use Submarine
+
+#### Model training (experiment) on K8s
+
+- [Run model training using Tensorflow](run-tensorflow-on-k8s.md)
+- [Run model training using PyTorch](FIXME, add one).

Review comment:
       I will file a separated JIRA to update these.




----------------------------------------------------------------
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