Skip to content

Commit dfc453e

Browse files
author
zhongzichao
authored
update docs (#895)
### PR types DOCS ### PR changes DOCS ### Describe update paddleflow version msg
1 parent 75b0663 commit dfc453e

File tree

9 files changed

+37
-37
lines changed

9 files changed

+37
-37
lines changed

client/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
from setuptools import setup, find_packages
2222

2323
NAME = 'PaddleFlow'
24-
VERSION = '1.4.4'
24+
VERSION = '1.4.5'
2525

2626
with open('requirements.txt') as f:
2727
REQUIRES = f.readlines()

docs/zh_cn/deployment/how_to_install_paddleflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ PaddleFlow部署分为客户端和服务端两个部分。
88

99
**安装**PaddleFlow客户端有两种方式:
1010

11-
1.[release](https://github.com/PaddlePaddle/PaddleFlow/releases)下载最新版, 执行`pip3 install PaddleFlow-1.4.2-py3-none-any.whl`
12-
2. 通过编译包安装,编译包有两处来源,分别是分支的最新产出、执行编译命令`cd client && python3 setup.py bdist_wheel`。得到编译包后执行`cd dist && pip3 install PaddleFlow-1.4.2-py3-none-any.whl`
11+
1.[release](https://github.com/PaddlePaddle/PaddleFlow/releases)下载最新版, 执行`pip3 install PaddleFlow-1.4.5-py3-none-any.whl`
12+
2. 通过编译包安装,编译包有两处来源,分别是分支的最新产出、执行编译命令`cd client && python3 setup.py bdist_wheel`。得到编译包后执行`cd dist && pip3 install PaddleFlow-1.4.5-py3-none-any.whl`
1313

1414
**卸载**PaddleFlow
1515

docs/zh_cn/deployment/install_paddleflow_on_k3s.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ touch /mnt/paddleflow.db && chmod 666 /mnt/paddleflow.db
99

1010
```shell
1111
# Kubernetes version >= v1.18
12-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/paddleflow-deployment.yaml
12+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/paddleflow-deployment.yaml
1313
# Kubernetes version < v1.18
14-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/paddleflow-deployment-before-v1-18.yaml
14+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/paddleflow-deployment-before-v1-18.yaml
1515
# For x86: todo
1616
# For arm64: todo
1717
```
@@ -25,7 +25,7 @@ kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/rele
2525
touch /mnt/paddleflow.db && chmod 666 /mnt/paddleflow.db
2626
# 创建基于sqllite的paddleflow-server
2727
# For x86:
28-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml
28+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml
2929
# For arm64: todo
3030
```
3131

@@ -42,7 +42,7 @@ wget https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/develop/installer
4242
bash < <(curl -s https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/develop/installer/database/execute.sh)
4343
# 创建基于mysql的paddleflow-server
4444
# For x86:
45-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml | \
45+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml | \
4646
sed -e "s/sqlite/${DB_DRIVER}/g" -e "s/host: 127.0.0.1/host: ${DB_HOST}/g" -e "s/3306/${DB_PORT}/g" -e "s/user: paddleflow/user: ${DB_USER}/g" -e "s/password: paddleflow/password: ${DB_PW}/g" -e "s/database: paddleflow/database: ${DB_DATABASE}/g" \
4747
| kubectl apply -f -
4848
# For arm64: todo
@@ -54,9 +54,9 @@ sed -e "s/sqlite/${DB_DRIVER}/g" -e "s/host: 127.0.0.1/host: ${DB_HOST}/g" -e
5454

5555
```shell
5656
# Kubernetes version >= v1.18
57-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml
57+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml
5858
# Kubernetes version < v1.18
59-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml
59+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml
6060
# For x86_64: todo
6161
# For arm64: todo
6262
```

docs/zh_cn/deployment/install_paddleflow_on_k8s.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ ps -ef | grep kubelet | grep root-dir
2020

2121
```shell
2222
# Kubernetes version >= v1.18
23-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/paddleflow-deployment.yaml
23+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/paddleflow-deployment.yaml
2424
# Kubernetes version < v1.18
25-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/paddleflow-deployment-before-v1-18.yaml
25+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/paddleflow-deployment-before-v1-18.yaml
2626
# For x86: todo
2727
# For arm64: todo
2828
```
2929

3030
**如果前面检查命令返回的结果不为空**,则代表 kubelet 的 root-dir 路径不是默认值,因此需要在 CSI Driver 的部署文件中更新 `kubeletDir` 路径并部署:
3131
```shell
3232
# Kubernetes version >= v1.18
33-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/paddleflow-deployment.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
33+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/paddleflow-deployment.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
3434
# Kubernetes version < v1.18
35-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/paddleflow-deployment-before-v1-18.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
35+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/paddleflow-deployment-before-v1-18.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
3636
# For x86: todo
3737
# For arm64: todo
3838
```
@@ -49,7 +49,7 @@ curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14
4949
touch /mnt/paddleflow.db && chmod 666 /mnt/paddleflow.db
5050
# 创建基于sqllite的paddleflow-server
5151
# For x86:
52-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml
52+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml
5353
# For arm64: todo
5454
```
5555

@@ -66,7 +66,7 @@ wget https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/develop/installer
6666
bash < <(curl -s https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/develop/installer/database/execute.sh)
6767
# 创建基于mysql的paddleflow-server
6868
# For x86:
69-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml | \
69+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml | \
7070
sed -e "s/sqlite/${DB_DRIVER}/g" -e "s/host: 127.0.0.1/host: ${DB_HOST}/g" -e "s/3306/${DB_PORT}/g" -e "s/user: paddleflow/user: ${DB_USER}/g" -e "s/password: paddleflow/password: ${DB_PW}/g" -e "s/database: paddleflow/database: ${DB_DATABASE}/g" \
7171
| kubectl apply -f -
7272
# For arm64: todo
@@ -87,19 +87,19 @@ ps -ef | grep kubelet | grep root-dir
8787
**如果前面检查命令返回的结果为空**,无需修改配置,可直接部署:
8888
```shell
8989
# Kubernetes version >= v1.18
90-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml
90+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml
9191
# Kubernetes version < v1.18
92-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml
92+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml
9393
# For x86_64: todo
9494
# For arm64: todo
9595
```
9696

9797
**如果前面检查命令返回的结果不为空**,则代表 kubelet 的 root-dir 路径不是默认值,因此需要在 CSI Driver 的部署文件中更新 `kubeletDir` 路径并部署:
9898
```shell
9999
# Kubernetes version >= v1.18
100-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
100+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
101101
# Kubernetes version < v1.18
102-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
102+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
103103
# For x86: todo
104104
# For arm64: todo
105105
```
@@ -109,7 +109,7 @@ curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14
109109
#### 2.3.3 安装volcano
110110
```shell
111111
# For x86_64:
112-
kubectl apply -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/volcano/pf-volcano-deploy.yaml
112+
kubectl apply -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/volcano/pf-volcano-deploy.yaml
113113

114114
# For arm64:
115115
todo

docs/zh_cn/reference/client_command_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ queue info:
193193
]
194194
```
195195

196-
队列创建:用户输入 ```paddleflow queue create queuename default 10 20Gi --clustername default-cluster```,创建成功后可以在界面上看到
196+
队列创建:用户输入 ```paddleflow queue create queuename default 10 20Gi --clustername default-cluster --quota volcanoCapabilityQuota```,创建成功后可以在界面上看到
197197

198198
```queue[queuename] create success```
199199

installer/deploys/paddleflow-csi-plugin/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ step2. 部署
1616
**如果前面检查命令返回的结果为空**,无需修改配置,可直接部署:
1717
```shell
1818
# Kubernetes version >= v1.18
19-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml
19+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml
2020
# Kubernetes version < v1.18
21-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml
21+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml
2222
```
2323

2424
**如果前面检查命令返回的结果不为空**,则代表 kubelet 的 root-dir 路径不是默认值,因此需要在 CSI Driver 的部署文件中更新 `kubeletDir` 路径并部署:
2525
```shell
2626
# Kubernetes version >= v1.18
27-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
27+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
2828
# Kubernetes version < v1.18
29-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
29+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-csi-plugin/paddleflow-csi-plugin-deploy-before-v1-18.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -
3030
```
3131

3232

installer/deploys/paddleflow-server/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
touch /mnt/paddleflow.db && chmod 666 /mnt/paddleflow.db
99
# 创建基于sqllite的paddleflow-server
1010
# For x86:
11-
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml
11+
kubectl create -f https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml
1212
# For arm64: todo
1313
```
1414

@@ -25,7 +25,7 @@ wget https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/develop/installer
2525
bash < <(curl -s https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/develop/installer/database/execute.sh)
2626
# 创建基于mysql的paddleflow-server
2727
# For x86:
28-
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.2/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml | \
28+
curl -sSL https://raw.githubusercontent.com/PaddlePaddle/PaddleFlow/release-0.14.5/installer/deploys/paddleflow-server/paddleflow-server-deploy.yaml | \
2929
sed -e "s/sqlite/${DB_DRIVER}/g" -e "s/host: 127.0.0.1/host: ${DB_HOST}/g" -e "s/3306/${DB_PORT}/g" -e "s/user: paddleflow/user: ${DB_USER}/g" -e "s/password: paddleflow/password: ${DB_PW}/g" -e "s/database: paddleflow/database: ${DB_DATABASE}/g" \
3030
| kubectl apply -f -
3131
# For arm64: todo
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
FROM paddleflow/paddleflow-server-base-arm:1.4.2
1+
FROM paddelflow/pfs-csi-plugin-arm:base
22

3+
RUN echo "Asia/shanghai" > /etc/timezone
34
ENV WORKDIR /home/paddleflow
4-
ADD bin/paddleflow $WORKDIR/server/
5-
RUN useradd paddleflow
5+
ADD bin/csi-plugin $WORKDIR/csi-plugin
6+
ADD bin/pfs-fuse $WORKDIR/pfs-fuse
7+
ADD bin/cache-worker $WORKDIR/cache-worker
68

7-
USER paddleflow
9+
WORKDIR /home/paddleflow
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
FROM paddelflow/pfs-csi-plugin-arm:base
1+
FROM paddleflow/paddleflow-server-base-arm:1.4.2
22

3-
RUN echo "Asia/shanghai" > /etc/timezone
43
ENV WORKDIR /home/paddleflow
5-
ADD bin/csi-plugin $WORKDIR/csi-plugin
6-
ADD bin/pfs-fuse $WORKDIR/pfs-fuse
7-
ADD bin/cache-worker $WORKDIR/cache-worker
4+
ADD bin/paddleflow $WORKDIR/server/
5+
RUN useradd paddleflow
86

9-
WORKDIR /home/paddleflow
7+
USER paddleflow

0 commit comments

Comments
 (0)