You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@submarine.apache.org by ji...@apache.org on 2020/12/01 01:13:55 UTC
[submarine] branch master updated: SUBMARINE-688. Improve the
document "helm.md"
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 9b669b8 SUBMARINE-688. Improve the document "helm.md"
9b669b8 is described below
commit 9b669b8c2b9b4a5858cc11fa7a8b0ce46ad571a3
Author: Ryan Lo <lo...@gmail.com>
AuthorDate: Mon Nov 30 10:46:24 2020 +0800
SUBMARINE-688. Improve the document "helm.md"
### What is this PR for?
Make the document "submarine/docs/userdocs/k8s/helm.md easier to read.
### What type of PR is it?
[Improvement | Documentation]
### Todos
### What is the Jira issue?
[SUBMARINE-688](https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE-688)
### How should this be tested?
[Travis CI](https://travis-ci.org/github/lowc1012/submarine/builds/746529317)
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Author: Ryan Lo <lo...@gmail.com>
Author: Wen-Chih Lo <52...@users.noreply.github.com>
Closes #465 from lowc1012/SUBMARINE-688 and squashes the following commits:
7b60b71 [Wen-Chih Lo] Update docs/userdocs/k8s/helm.md
eb2d126 [Ryan Lo] SUBMARINE-688. Improve the document "helm.md"
---
docs/userdocs/k8s/helm.md | 21 ++++++++++++---------
1 file changed, 12 insertions(+), 9 deletions(-)
diff --git a/docs/userdocs/k8s/helm.md b/docs/userdocs/k8s/helm.md
index 0ad7405..99d68e2 100644
--- a/docs/userdocs/k8s/helm.md
+++ b/docs/userdocs/k8s/helm.md
@@ -99,16 +99,19 @@ for more details if you want to customize the default value for Traefik.
http://127.0.0.1:32080
```
-Or you can use port-forward to forward a local port to a port on the
-submarine server pod.
+*Notice:*
+If you use `kind` to run local Kubernetes cluster,
+please refer to this [docs](https://kind.sigs.k8s.io/docs/user/configuration/#extra-port-mappings)
+and set the configuration "extraPortMappings" when creating the k8s cluster.
-```bash
-# Use port-forward
-kubectl port-forward svc/submarine-server 8080:8080
-
-# In another terminal. Run below command to verify it works
-curl http://127.0.0.1:8080/api/v1/experiment/ping
-{"status":"OK","code":200,"success":true,"message":null,"result":"Pong","attributes":{}}
+```
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+- role: control-plane
+ extraPortMappings:
+ - containerPort: 32080
+ hostPort: [the port you want to access]
```
### Uninstall Submarine
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org