Update docs

ferryproxy · Aug 4, 2022 · c265530 · c265530
1 parent 2dc999b
commit c265530
Show file tree

Hide file tree

Showing 16 changed files with 92 additions and 60 deletions.
diff --git a/content/en/docs/user/examples/control-plane-unreachable.md b/content/en/docs/user/examples/control-plane-unreachable.md
@@ -12,13 +12,9 @@ Can be a cluster of one node or a cluster of Kind but at least two.
 
 <img src="/images/edge-to-cloud.png" width="600">
 
-## Download ferryctl
+## Preparation
 
-ferryctl is the installation and operation tool for ferry 
-
-A ferryctl needs to be installed for each cluster's control node 
-
-https://github.com/ferryproxy/ferry/releases
+[Preparation](/docs/user/preparation)
 
 ## Initialize Control Plane Cluster
 

diff --git a/content/en/docs/user/examples/data-plane-unreachable.md b/content/en/docs/user/examples/data-plane-unreachable.md
@@ -12,13 +12,9 @@ Can be a cluster of one node or a cluster of Kind but at least two.
 
 <img src="/images/cloud-to-edge.png" width="600">
 
-## Download ferryctl
+## Preparation
 
-ferryctl is the installation and operation tool for ferry 
-
-A ferryctl needs to be installed for each cluster's control node 
-
-https://github.com/ferryproxy/ferry/releases
+[Preparation](/docs/user/preparation)
 
 ## Initialize Control Plane Cluster
 

diff --git a/content/en/docs/user/examples/default.md b/content/en/docs/user/examples/default.md
@@ -20,13 +20,9 @@ A ferryctl needs to be installed for each cluster's control node
 
 https://github.com/ferryproxy/ferry/releases
 
-## Initialize Control Plane Cluster
+## Preparation
 
-
-``` bash
-# execute on control plane
-ferryctl control-plane init
-```
+[Preparation](/docs/user/preparation)
 
 ## Join a Data Plane Cluster
 

diff --git a/content/en/docs/user/examples/forward-dial.md b/content/en/docs/user/examples/forward-dial.md
@@ -4,11 +4,9 @@ title: "Forward Local Port to Cluster"
 
 # Forward Local Port to Cluster
 
-## Installing Tunnel in the cluster
+## Preparation
 
-``` bash
-ferryctl data-plane init
-```
+[Preparation](/docs/user/preparation)
 
 ## Forward Local Port to Cluster
 

diff --git a/content/en/docs/user/examples/forward-listen.md b/content/en/docs/user/examples/forward-listen.md
@@ -4,11 +4,9 @@ title: "Forward Service to Local Port"
 
 # Forward Service to Local Port
 
-## Installing Tunnel in the cluster
+## Preparation
 
-``` bash
-ferryctl data-plane init
-```
+[Preparation](/docs/user/preparation)
 
 ## Forward Service to Local Port
 

diff --git a/content/en/docs/user/examples/manual.md b/content/en/docs/user/examples/manual.md
@@ -10,11 +10,9 @@ In some cluster unreachability scenarios, the apiserver address of the data plan
 
 The routing rules configured by this feature are not controlled by the ferry-controller.
 
-## Install Tunnel
+## Preparation
 
-``` bash
-ferryctl data-plane init
-```
+[Preparation](/docs/user/preparation)
 
 ## Manual Mapping Service
 

diff --git a/content/en/docs/user/preparation.md b/content/en/docs/user/preparation.md
@@ -0,0 +1,33 @@
+---
+title: "Preparation"
+---
+
+## Download ferryctl
+
+`ferryctl` is the installation and maintenance tool for `Ferry`
+
+You need to install `ferryctl` for each cluster
+
+https://github.com/ferryproxy/ferry/releases
+
+## Install Tunnel
+
+Tunnel needs to be installed for each cluster
+
+### Clusters that support LoadBalancer
+
+As in each public cloud environment
+
+``` bash
+ferryctl data-plane init --tunnel-service-type=LoadBalancer
+```
+
+### Other
+
+such as Kind or private cloud environments
+
+will use NodePort to expose port 31087 by default
+
+``` bash
+ferryctl data-plane init
+```
diff --git a/content/en/menu/index.md b/content/en/menu/index.md
@@ -4,6 +4,7 @@ headless: true
 
 - [**Home**]({{< relref "/" >}})
 - **User Guide**
+  - [Preparation]({{< relref "/docs/user/preparation" >}})
   - Examples
     - [Default Example]({{< relref "/docs/user/examples/default" >}})
     - [Control Plane Unreachable]({{< relref "/docs/user/examples/control-plane-unreachable" >}})

diff --git a/content/zh/docs/user/examples/control-plane-unreachable.md b/content/zh/docs/user/examples/control-plane-unreachable.md
@@ -12,13 +12,9 @@ title: "控制面集群不可达"
 
 <img src="/images/edge-to-cloud.png" width="600">
 
-## 下载 ferryctl
+## 准备工作
 
-ferryctl 是 ferry 的安装运维工具
-
-需要为每个集群的控制节点都安装一个 ferryctl
-
-https://github.com/ferryproxy/ferry/releases
+[准备工作](/docs/user/preparation)
 
 ## 初始化控制面集群
 

diff --git a/content/zh/docs/user/examples/data-plane-unreachable.md b/content/zh/docs/user/examples/data-plane-unreachable.md
@@ -12,13 +12,9 @@ title: "数据面集群不可达"
 
 <img src="/images/cloud-to-edge.png" width="600">
 
-## 下载 ferryctl
+## 准备工作
 
-ferryctl 是 ferry 的安装运维工具
-
-需要为每个集群的控制节点都安装一个 ferryctl
-
-https://github.com/ferryproxy/ferry/releases
+[准备工作](/docs/user/preparation)
 
 ## 初始化控制面集群
 

diff --git a/content/zh/docs/user/examples/default.md b/content/zh/docs/user/examples/default.md
@@ -12,13 +12,9 @@ title: "默认示例"
 
 <img src="/images/cloud-to-cloud.png" width="600">
 
-## 下载 ferryctl
+## 准备工作
 
-ferryctl 是 ferry 的安装运维工具
-
-需要为每个集群的控制节点都安装一个 ferryctl
-
-https://github.com/ferryproxy/ferry/releases
+[准备工作](/docs/user/preparation)
 
 ## 初始化控制面集群
 

diff --git a/content/zh/docs/user/examples/forward-dial.md b/content/zh/docs/user/examples/forward-dial.md
@@ -4,11 +4,9 @@ title: "转发本地端口到集群的端口"
 
 # 转发本地端口到集群的端口
 
-## 安装 Tunnel
+## 准备工作
 
-``` bash
-ferryctl data-plane init
-```
+[准备工作](/docs/user/preparation)
 
 ## 转发本地端口到集群的端口
 

diff --git a/content/zh/docs/user/examples/forward-listen.md b/content/zh/docs/user/examples/forward-listen.md
@@ -4,11 +4,9 @@ title: "创建并转发集群的 Service 端口到本地端口"
 
 # 创建并转发集群的 Service 端口到本地端口
 
-## 安装 Tunnel
+## 准备工作
 
-``` bash
-ferryctl data-plane init
-```
+[准备工作](/docs/user/preparation)
 
 ## 创建并转发集群的 Service 端口到本地端口
 

diff --git a/content/zh/docs/user/examples/manual.md b/content/zh/docs/user/examples/manual.md
@@ -10,11 +10,9 @@ title: "手动映射服务"
 
 由该功能配置的路由规则不受 ferry-controller 的控制
 
-## 安装 Tunnel
+## 准备工作
 
-``` bash
-ferryctl data-plane init
-```
+[准备工作](/docs/user/preparation)
 
 ## 手动映射服务
 

diff --git a/content/zh/docs/user/preparation.md b/content/zh/docs/user/preparation.md
@@ -0,0 +1,33 @@
+---
+title: "预备工作"
+---
+
+## 下载 ferryctl
+
+`ferryctl` 是 `Ferry` 的安装运维工具
+
+需要为每个集群安装 `ferryctl`
+
+https://github.com/ferryproxy/ferry/releases
+
+## 安装 Tunnel
+
+需要为每个集群安装 Tunnel
+
+### 支持 LoadBalancer 的集群
+
+如在各个公有云环境
+
+``` bash
+ferryctl data-plane init --tunnel-service-type=LoadBalancer
+```
+
+### 其他
+
+如 Kind 或私有云环境
+
+将默认使用 NodePort 暴露 31087 端口
+
+``` bash
+ferryctl data-plane init
+```
diff --git a/content/zh/menu/index.md b/content/zh/menu/index.md
@@ -4,6 +4,7 @@ headless: true
 
 - [**主页**]({{< relref "/" >}})
 - **用户指引**
+  - [准备工作]({{< relref "/docs/user/preparation" >}})
   - 示例
     - [默认示例]({{< relref "/docs/user/examples/default" >}})
     - [控制面集群不可达]({{< relref "/docs/user/examples/control-plane-unreachable" >}})