Skip to content

Commit e332737

Browse files
committed
feat: update docs content
1 parent 6edb771 commit e332737

File tree

6 files changed

+58
-65
lines changed

6 files changed

+58
-65
lines changed

docs/03-getting-started/02-install-lower-layer-system/02-install-kubernetes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Install the following software packages on the cloud:
2525
- `kubelet`:used to launch pods on each node in the cluster.
2626
- `kubectl`:command-line tool used to communicate with the cluster.
2727

28-
See the corresponding Kubernetes and KubeEdge versions at [kubeedge/kubeedge](https://github.com/kubeedge/kubeedge)
28+
See the corresponding Kubernetes and KubeEdge versions at [kubeedge/kubeedge](https://github.com/kubeedge/kubeedge).
2929
```bash
3030
# Check software version
3131
apt-cache madison kubeadm
@@ -40,7 +40,7 @@ sudo apt-mark hold kubelet kubeadm kubectl
4040

4141
## Start Kubernetes cluster (cloud)
4242

43-
This step may occur [Question 1: kube-proxy report iptables problems](/docs/getting-started/install-lower-layer-system/faqs#question-1-kube-proxy-report-iptables-problems), [Question 2: calico and coredns are always in initializing state](/docs/getting-started/install-lower-layer-system/faqs#question-2-calico-and-coredns-are-always-in-initializing-state) and [Question 3:metrics-server keeps unsuccessful state](/docs/getting-started/install-lower-layer-system/faqs#question-3metrics-server-keeps-unsuccessful-state)
43+
This step may occur [Question 1: kube-proxy report iptables problems](/docs/getting-started/install-lower-layer-system/faqs#question-1-kube-proxy-report-iptables-problems), [Question 2: calico and coredns are always in initializing state](/docs/getting-started/install-lower-layer-system/faqs#question-2-calico-and-coredns-are-always-in-initializing-state) and [Question 3:metrics-server keeps unsuccessful state](/docs/getting-started/install-lower-layer-system/faqs#question-3metrics-server-keeps-unsuccessful-state).
4444

4545
### Reset environment (Skip on first installation)
4646

docs/03-getting-started/02-install-lower-layer-system/03-install-kubeedge.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ custom_edit_url: null
1010

1111
keadm is mainly used for kubeedge management, installation, and usage.
1212

13-
Official release version link: [Release KubeEdge v1.9.2 release · kubeedge/kubeedge (github.com)](https://github.com/kubeedge/kubeedge/releases/)
13+
Official release version link: [Release KubeEdge v1.9.2 release · kubeedge/kubeedge (github.com)](https://github.com/kubeedge/kubeedge/releases/).
1414

1515
```bash
1616
# Check machine architecture
@@ -27,7 +27,7 @@ cp keadm-v1.9.2-linux-amd64/keadm/keadm /usr/local/bin/
2727

2828
## Start KubeEdge (cloud)
2929

30-
This step may occur [Question 4:10002 already in use](/docs/getting-started/install-lower-layer-system/faqs#question-410002-already-in-use)
30+
This step may occur [Question 4:10002 already in use](/docs/getting-started/install-lower-layer-system/faqs#question-410002-already-in-use).
3131

3232
### Reset environment (Skip on first installation)
3333

@@ -37,7 +37,7 @@ keadm reset
3737

3838
### Start cloudcore
3939

40-
Start cloudcore by keadm
40+
Start cloudcore by keadm.
4141
```bash
4242
# Modify the ip address of '--adverse-address'
4343
keadm init --advertise-address=114.212.81.11 --kubeedge-version=1.9.2
@@ -90,7 +90,7 @@ Use `journalctl -u cloudcore.service -xe` to check if cloudcore is running norma
9090

9191
## Join KubeEdge cluster (edge)
9292

93-
This step may occur [Question 5:edgecore file exists](/docs/getting-started/install-lower-layer-system/faqs#question-5edgecore-file-exists)
93+
This step may occur [Question 5:edgecore file exists](/docs/getting-started/install-lower-layer-system/faqs#question-5edgecore-file-exists).
9494

9595
If `keadm join` fails, you can retry from `keadm reset`.
9696

docs/03-getting-started/02-install-lower-layer-system/04-install-edgemesh.md

Lines changed: 41 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,26 @@ custom_edit_url: null
66

77
# Install EdgeMesh
88

9-
[TBD]
9+
## EdgeMesh environment preparation (cloud)
1010

11-
## EdgeMesh 环境准备(云端)
11+
This Step may occur [Question 6:TLSStreamPrivateKeyFile not exist](/docs/getting-started/install-lower-layer-system/faqs#question-6tlsstreamprivatekeyfile-not-exist)
1212

13-
14-
可能出现 [问题六:缺少 TLSStreamCertFile](/docs/getting-started/install-lower-layer-system/faqs#问题六缺少-tlsstreamcertfile)
15-
16-
步骤 1: 去除 K8s master 节点的污点
13+
Step 1: Remove the taint on the master node.
1714
```bash
1815
kubectl taint nodes --all node-role.kubernetes.io/master-
1916
```
2017

21-
步骤 2: Kubernetes API 服务添加过滤标签
18+
Step 2: Add filter tags to Kubernetes API services.
2219
```bash
2320
kubectl label services kubernetes service.edgemesh.kubeedge.io/service-proxy-name=""
2421
```
2522

26-
步骤 3: 启用 KubeEdge 的边缘 Kube-API 端点服务
23+
Step 3: Enable Kube-API endpoint service of KubeEdge on edges.
2724

28-
在云端,开启 dynamicController 模块:
25+
On the cloud, enable `dynamicController`:
2926
```bash
3027
vim /etc/kubeedge/config/cloudcore.yaml
31-
# 修改 cloudcore.yaml 内容
28+
# Modify cloudcore.yaml
3229
modules:
3330
..
3431
cloudStream:
@@ -38,14 +35,14 @@ modules:
3835
dynamicController:
3936
enable: true
4037

41-
# 重启cloucore
38+
# Restart cloucore
4239
systemctl restart cloudcore.service
4340
```
4441

45-
在边端,打开 metaServer 模块和 edgeStream (注意,keadm reset后需要重新修改)
42+
On the edges, enable `metaServer` and `edgeStream` (note that this operation should redo after `keadm reset`).
4643
```bash
4744
vim /etc/kubeedge/config/edgecore.yaml
48-
# 修改 edgecore.yaml 内容
45+
# Modify edgecore.yaml
4946
edgeStream:
5047
enable: true
5148
handshakeTimeout: 30
@@ -61,47 +58,44 @@ metaManager:
6158
enable: true
6259
...
6360

64-
#重启edgecore
61+
# Restart edgecore
6562
systemctl restart edgecore.service
66-
#检查状况
63+
# Check running state
6764
journalctl -u edgecore.service -f
68-
#确定正常运行
6965
```
7066

71-
步骤 4: 在边缘节点,测试边缘 Kube-API 端点功能是否正常
72-
67+
Step 4: On the edge, test whether the edge Kube-API endpoint functions normally.
7368
```bash
74-
# 边缘节点上
69+
# Execute on edges
7570
curl 127.0.0.1:10550/api/v1/services
7671
```
7772

7873
![api](/img/install/api.png)
7974

80-
如果返回值是空列表,或者响应时长很久(接近 10 s)才拿到返回值,说明配置可能有误,请仔细检查。
75+
If the return value is an empty list, or it takes a long time (close to 10 seconds) to receive the return value, it indicates that there may be an error in the configuration, please check it carefully.
8176

82-
## 启动 EdgeMesh(云边共用)
77+
## Start EdgeMesh (both cloud/edge)
8378

84-
> 此处问题重灾区,遇到问题可参照EdgeMesh官方手册排查:
79+
> This is a hot spot for problems, when encountering issues, please refer to the EdgeMesh official manual for troubleshooting:
8580
>
8681
> [快速上手 | EdgeMesh](https://edgemesh.netlify.app/zh/guide/#%E6%89%8B%E5%8A%A8%E5%AE%89%E8%A3%85)
8782
>
8883
> [全网最全EdgeMesh Q&A手册 - 知乎 (zhihu.com)](https://zhuanlan.zhihu.com/p/585749690)
8984
90-
### 部署edgemesh-agent(云端)
85+
### Deploy edgemesh-agent (cloud)
9186

92-
下载 edgemesh代码
87+
Download edgemesh code:
9388
```bash
94-
# clone edgemesh代码
89+
# clone edgemesh code (customized by dayu)
9590
git clone https://github.com/dayu-autostreamer/dayu-edgemesh.git
96-
# 进入代码文件夹
91+
# move in code directory
9792
cd dayu-edgemesh
9893
```
9994

100-
添加relay node
95+
Add `relay node`:
10196
```bash
10297
vim build/agent/resources/04-configmap.yaml
103-
104-
# 添加云服务器为relay node, 以便云边通信,如:
98+
# Add the master node (cloud) as relay node for cloud-edge communication:
10599
....
106100
edgeTunnel:
107101
enable: true
@@ -110,29 +104,28 @@ edgeTunnel:
110104
advertiseAddress:
111105
- <ip>
112106
....
113-
114-
# (<hostname> <ip> 分别需要填入云服务器的hostname与ip
107+
# Fulfill <hostname> <ip> with hostname and ip of the cloud.
115108
```
116109

117-
部署edgemesh
110+
Deploy edgemesh:
118111
```bash
119-
# crd 文件部署
112+
# Deploy crd files
120113
kubectl apply -f build/crds/istio/
121-
# 在集群中部署 edgemesh-agent
114+
# Deploy edgemesh-agent
122115
kubectl apply -f build/agent/resources/
123116
```
124117

125-
126-
提示: 如果使用[内网镜像仓库](/docs/developer-guide/how-to-build/docker-registry/),请进入yaml文件中修改image源,如:
118+
NOTE: If using the [Intranet Image Repository](/docs/developer-guide/how-to-build/docker-registry/), please modify the image in the yaml file, such as:
127119
```
128120
dayuhub/edgemesh-gateway:v1.0 -> repo:5000/dayuhub/edgemesh-gateway:v1.0
129121
```
130122

131-
### 配置edge端网络(边端)
132-
配置 edge
123+
### Configure edge network (edge)
124+
125+
Configure the edge:
133126
```bash
134127
vim /etc/kubeedge/config/edgecore.yaml
135-
# 修改 edgecore.yaml 内容
128+
# Modify edgecore.yaml
136129
edged:
137130
clusterDNS: 169.254.96.16
138131
clusterDomain: cluster.local
@@ -142,43 +135,43 @@ edged:
142135

143136
![edgecore](/img/install/edgecore2.png)
144137

145-
重启edgecore:
138+
Restart edgecore:
146139
```bash
147140
systemctl restart edgecore
148141
```
149142

150-
### 正常运行状态
143+
### Check running state
151144

152-
查看iptables状态:
145+
Check iptables state:
153146
```bash
154147
iptables -t nat -nvL
155148
```
156149
![iptables](/img/install/iptables.png)
157150

158-
查看edgemesh pods状态:
151+
Check the state of edgemesh pods:
159152
```bash
160153
kubectl get pods -n kubeedge
161154
```
162155
![normal-run](/img/install/EdgeMeshNormalRun.jpg)
163156

164-
云端logs
157+
Logs on the cloud
165158
```bash
166159
kubectl logs -n kubeedge [pod-name]
167160
```
168161
![cloud-agent](/img/install/cloud-agent.png)
169162

170-
边端logs
163+
Logs on the edge
171164
```bash
172-
# 查看边端edgemesh
165+
# Check edgemesh logs on the edge
173166
kubectl logs -n kubeedge [pod-name]
174167
```
175168

176169
![edge-agent.png](/img/install/edge-agent.png)
177170

178171

179-
### 卸载Edgemesh
172+
### Uninstall Edgemesh
180173

181-
如需重装Edgemesh,请先卸载
174+
If you need to reinstall Edgemesh, please uninstall it first.
182175
```bash
183176
cd dayu-edgemesh
184177
kubectl delete -f build/crds/istio/

i18n/zh/docusaurus-plugin-content-docs/current/03-getting-started/02-install-lower-layer-system/03-install-kubeedge.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ keadm reset
3939

4040
通过 keadm 启动
4141
```bash
42-
#注意修改--advertise-address的ip地址
42+
# 注意修改--advertise-address的ip地址
4343
keadm init --advertise-address=114.212.81.11 --kubeedge-version=1.9.2
4444

45-
#打开转发路由
45+
# 打开转发路由
4646
kubectl get cm tunnelport -n kubeedge -o yaml
47-
#找到10350 或者10351
48-
#set the rule of trans,设置自己的端口
49-
export CLOUDCOREIPS=xxx.xxx.xxx.xxx
47+
# 找到10350 或者 10351
5048

51-
# dport的内容对应tunnelport
49+
# 设置CLOUDCOREIPS
50+
export CLOUDCOREIPS=xxx.xxx.xxx.xxx
51+
# 设置dport(内容对应之前获取的tunnelport)
5252
iptables -t nat -A OUTPUT -p tcp --dport 10351 -j DNAT --to $CLOUDCOREIPS:10003
5353

5454
cd /etc/kubeedge/

i18n/zh/docusaurus-plugin-content-docs/current/03-getting-started/02-install-lower-layer-system/04-install-edgemesh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ metaManager:
5858
enable: true
5959
...
6060

61-
#重启edgecore
61+
# 重启edgecore
6262
systemctl restart edgecore.service
63-
#检查状况
63+
# 检查状况
6464
journalctl -u edgecore.service -f
65-
#确定正常运行
65+
# 确定正常运行
6666
```
6767

6868
步骤 4: 在边缘节点,测试边缘 Kube-API 端点功能是否正常
@@ -108,7 +108,7 @@ edgeTunnel:
108108
- <ip>
109109
....
110110

111-
# <hostname> <ip> 分别需要填入云服务器的hostname与ip
111+
# <hostname> <ip> 分别需要填入云服务器的hostname与ip
112112
```
113113

114114
部署edgemesh

i18n/zh/docusaurus-plugin-content-docs/current/03-getting-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ slug: /getting-started
33
custom_edit_url: null
44
---
55

6-
# Getting Started
6+
# 快速开始
77

88
[TBD]
99

0 commit comments

Comments
 (0)