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/13 03:56:22 UTC
[submarine] branch master updated: SUBMARINE-927. [gettingStarted]
How to setup KinD
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 5856f55 SUBMARINE-927. [gettingStarted] How to setup KinD
5856f55 is described below
commit 5856f5559837b8c0e0ca7c5c32a410a5898126bf
Author: KUAN-HSUN-LI <b0...@ntu.edu.tw>
AuthorDate: Tue Jul 13 08:59:49 2021 +0800
SUBMARINE-927. [gettingStarted] How to setup KinD
### What is this PR for?
* Add the tutorial of setup the KinD cluster in getting started page.
* Check the KinD dependency for submarine.
### What type of PR is it?
[Documentation]
### Todos
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-927
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: KUAN-HSUN-LI <b0...@ntu.edu.tw>
Signed-off-by: Kai-Hsun Chen <ka...@apache.org>
Closes #663 from KUAN-HSUN-LI/SUBMARINE-927 and squashes the following commits:
3e2526c8 [KUAN-HSUN-LI] SUBMARINE-927. Add Dashboard screenshot
e1ef493d [KUAN-HSUN-LI] SUBMARINE-927. how to setup KinD
---
website/docs/assets/kind-dashboard.png | Bin 0 -> 125035 bytes
website/docs/devDocs/Dependencies.md | 20 +++++++++++++++-----
website/docs/gettingStarted/kind.md | 24 ++++++++++++++++++------
website/sidebars.js | 2 ++
4 files changed, 35 insertions(+), 11 deletions(-)
diff --git a/website/docs/assets/kind-dashboard.png b/website/docs/assets/kind-dashboard.png
new file mode 100644
index 0000000..edcc337
Binary files /dev/null and b/website/docs/assets/kind-dashboard.png differ
diff --git a/website/docs/devDocs/Dependencies.md b/website/docs/devDocs/Dependencies.md
index cc4b500..48e054f 100644
--- a/website/docs/devDocs/Dependencies.md
+++ b/website/docs/devDocs/Dependencies.md
@@ -19,10 +19,9 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
-# Dependencies
* These are the dependencies currently used by Apache Submarine.
-# Kubernetes
+## Kubernetes
| Kubernetes Version | Support? |
| ------------- |:-------------:|
| 1.13.x (or earlier) | X |
@@ -32,11 +31,22 @@ under the License.
| 1.17.x | To be verified |
| 1.18.x | To be verified |
-# Java
+## KinD
+| KinD Version | Support? |
+| ------------- |:-------------:|
+| 0.5.x (or earlier) | X |
+| 0.6.x | √ |
+| 0.7.x | √ |
+| 0.8.x | √ |
+| 0.9.x | √ |
+| 0.10.x | √ |
+| 0.11.x | √ |
+
+## Java
* TODO
-# Maven
+## Maven
* TODO
-# Docker
+## Docker
* TODO
\ No newline at end of file
diff --git a/website/docs/gettingStarted/kind.md b/website/docs/gettingStarted/kind.md
index d609f49..8fbb18e 100644
--- a/website/docs/gettingStarted/kind.md
+++ b/website/docs/gettingStarted/kind.md
@@ -1,5 +1,5 @@
---
-title: Setup a Kubernetes cluster using Kind
+title: Setup a Kubernetes cluster using KinD
---
<!--
@@ -22,12 +22,20 @@ under the License.
-->
## Create K8s cluster
-We recommend using [`kind`](https://kind.sigs.k8s.io/) to setup a Kubernetes cluster on a local machine.
+We recommend using [`KinD`](https://kind.sigs.k8s.io/) to setup a Kubernetes cluster on a local machine.
-Running the following command:
-```
-kind create cluster --image kindest/node:v1.15.6 --name submarine
-kubectl create namespace submarine
+Running the following command, and specify the KinD version and Kubernetes version [`here`](../devDocs/Dependencies).
+```bash
+# Download the specific version of KinD (must >= v0.6.0)
+export KIND_VERSION=v0.11.1
+curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-linux-amd64
+# Make the binary executable
+chmod +x ./kind
+# Move the binary to your executable path
+sudo mv ./kind /usr/local/bin/
+# Create cluster with specific version of kubernetes
+export KUBE_VERSION=v1.15.12
+kind create cluster --image kindest/node:${KUBE_VERSION}
```
## Kubernetes Dashboard (optional)
@@ -61,3 +69,7 @@ kubectl proxy
Now access Dashboard at:
> http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/
+
+Dashboard screenshot:
+
+
diff --git a/website/sidebars.js b/website/sidebars.js
index 95af05d..1a65115 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -23,6 +23,7 @@ module.exports = {
"Introduction": [],
"Getting Started": [
"gettingStarted/localDeployment",
+ "gettingStarted/kind",
"gettingStarted/notebook",
"gettingStarted/python-sdk",
],
@@ -62,6 +63,7 @@ module.exports = {
],
"Developer Docs": [
"devDocs/README",
+ "devDocs/Dependencies",
"devDocs/BuildFromCode",
"devDocs/Development",
"devDocs/IntegrationTest",
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org