Skip to content

Commit f53803a

Browse files
authored
Merge pull request #32 from WeBankFinTech/dev-0.2.2
fix image link error
2 parents b531401 + 460d215 commit f53803a

File tree

8 files changed

+37
-47
lines changed

8 files changed

+37
-47
lines changed

docs/zh_CN/Deployment_Documents/DeploymentGuide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## 1. Prophecis简介
22

3-
​ Prophecis 使用`helm`来进行`kubernetes`包管理,主要安装文件位于install目录下。install目录包含了三个组件`notebook-controller`, `MinioDeployment`, `Prophecis`,主体为`Prophecis`。使用前,需要初始化MySQL数据库,并挂载NFS目录来存储数据。
3+
​ Prophecis 使用`helm`来进行`kubernetes`包管理,主要安装文件位于`install`目录下。`install`目录包含了三个组件`notebook-controller`, `MinioDeployment`, `Prophecis`,主体为`Prophecis`。使用前,需要初始化MySQL数据库,并挂载NFS目录来存储数据。
44

55

66
## 2. 环境准备
@@ -70,7 +70,7 @@ mount ${NFS_SERVER_IP}:${NFS_PATH_LOG} ${NFS_PATH_LOG}
7070
![图片](../image/deploy/deploy_dir_1.png)
7171

7272
* 文件清单:
73-
* Helm Chart:`./helm-charts`目录下`notebook-controller`,`MinioDeployment`,`Prophecis`
73+
* Helm Chart:`./install`目录下`notebook-controller`,`MinioDeployment`,`Prophecis`
7474
* SQL Script :`./cc/sql`目录下`prophecis.sql``prophecis-data.sql`文件
7575
* 镜像列表(**安装时自动下载**):
7676
```yaml
@@ -98,7 +98,7 @@ Prophecis_1.8.0_tensorflow-1.12.0-jupyterlab-cpu-v0.5.0
9898
```
9999
## 4. 配置文件修改
100100

101-
**需要修改****`./helm-charts/prophecis/values.yaml`****中的信息。**
101+
**需要修改`./install/prophecis/values.yaml`中的信息。**
102102

103103
### 4.1 配置数据库访问的信息
104104

@@ -172,7 +172,7 @@ kubectl label nodes ${LABEL_GPU} hardware-type=NVIDIAGPU
172172

173173
Prophecis部署需要三个组件`notebook-controller`,`MinioDeployment`,`Prophecis`。
174174

175-
**部署执行目录为****`./helm-Chart`****目录下。**
175+
**部署执行目录为`./install`目录下。**
176176

177177
```shell
178178
# 安装Notebook Controller组件

docs/zh_CN/Development_Documents/ConfigurationGuide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
### 2.1 目录结构
1010

11-
* 配置文件位置:**helm-chart/Prophecis**
11+
* 配置文件位置:**install/Prophecis**
1212
* 文件内容:
1313
* values.yaml
1414
* templates目录
@@ -100,7 +100,7 @@
100100

101101
### 3.1 目录结构
102102

103-
* 配置文件位置:**helm-chart/notebook-controller**
103+
* 配置文件位置:**install/notebook-controller**
104104
* 文件内容:
105105
* values.yaml
106106
* templates目录:

docs/zh_CN/Development_Documents/DevelopmentGuide.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,19 @@ helm install prophecis
6262

6363

6464

65-
* 配置触发器:
66-
* 勾选:Push Events、Opened Merge Request Event、Approved Merge Request、Comments
67-
* Rebuild open Merge Requests:Never
65+
- 配置触发器:
66+
- 勾选:Push Events、Opened Merge Request Event、Approved Merge Request、Comments
67+
- Rebuild open Merge Requests:Never
6868

6969
![图片](../image/dev/dev_jenkins_2.png)
7070

7171

7272

7373
- 构建变量信息(用于版本管理):
74-
- 勾选:Create a formatted version number
75-
- 填写:Environment Variable Name、Version Number Format String、Skip Builds worse than、Build Display Name(勾选)
76-
- AIDE:
77-
- 设置 Go Version
74+
- 勾选:Create a formatted version number
75+
- 填写:Environment Variable Name、Version Number Format String、Skip Builds worse than、Build Display Name(勾选)
76+
- AIDE:
77+
- 设置 Go Version
7878

7979
![图片](../image/dev/dev_jenkins_3.png)
8080

@@ -90,7 +90,6 @@ helm install prophecis
9090
- 填写镜像构建及推送相关:
9191

9292
![图片](../image/dev/dev_jenkins_5.png)
93-
9493

9594

9695

docs/zh_CN/Q&A.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,26 @@
88

99
1. `no matches for kind “DaemonSet“ in version “extensions/v1beta1“`
1010

11-
LogCollectorDS为kubernetes 1.8之前版本需要进行修改,将`LogCollectorDS/FluentBit.yaml`中的`extensions/v1beta1`改为`apps/v1`
11+
LogCollectorDS为kubernetes 1.8之前版本需要进行修改,将`Prophecis/templates/LogCollectorDS/FluentBit.yaml`中的`extensions/v1beta1`改为`apps/v1`
1212

1313

1414

1515
2. missing required field "selector" in io.k8s.api.apps.v1sssssssssssss.DaemonSetSpec
16-
- LogCollectorDS为kubernetes 1.8之前版本需要进行修改,将`LogCollectorDS/FluentBit.yaml`添加3行,并注释2行
16+
LogCollectorDS为kubernetes 1.8之前版本需要进行修改,将`Prophecis/templates/LogCollectorDS/FluentBit.yaml`添加3行,并注释2行
17+
1718
```yaml
1819
apiVersion: apps/v1
1920
spec:
20-
selector:
21-
matchLabels:
22-
app: fluent-bit
23-
template:
24-
metadata:
25-
creationTimestamp: null
26-
labels:
27-
# log_collector_image_short_name: fluent-bit
28-
# service: prophecis-lhelper
29-
app: fluent-bit
21+
selector:
22+
matchLabels:
23+
app: fluent-bit
24+
template:
25+
metadata:
26+
creationTimestamp: null
27+
labels:
28+
# log_collector_image_short_name: fluent-bit
29+
# service: prophecis-lhelper
30+
app: fluent-bit
3031
```
3132
3233
@@ -64,8 +65,8 @@ nfs未进行挂载
6465

6566

6667
6. `Error response from daemon: Get https://dockerhub.prophecis/v2/: http: server gave HTTP response to HTTPS client`
67-
docker registry未采用https服务,而客户端docker使用https请求push所致
68-
将以下配置添加到 /etc/docker/daemon.json 中:
68+
docker registry未采用https服务,而客户端docker使用https请求push所致
69+
将以下配置添加到 /etc/docker/daemon.json 中:
6970

7071
```shell
7172
{ "insecure-registries":["127.0.0.1:5000"] }
@@ -100,13 +101,3 @@ kubectl delete pod ${ERROR_POD} -n prophecis
100101

101102
![图片](./image/qa/sample_3.png)
102103

103-
104-
105-
106-
```
107-
108-
```
109-
110-
```
111-
112-
```

docs/zh_CN/QuickStartGuide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ mount ${NFS_SERVER_IP}:${NFS_PATH_LOG} ${NFS_PATH_LOG}
7272
```
7373
## 3. 配置文件修改
7474

75-
- **修改**`./helm-charts/prophecis/values.yaml`中的信息。
75+
- **修改**`./install/prophecis/values.yaml`中的信息。
7676

7777
```yaml
7878
## 配置数据库访问的信息
@@ -121,7 +121,7 @@ source prophecis-data.sql
121121

122122
Prophecis部署需要三个组件`notebook-controller`,`MinioDeployment`,`Prophecis`。
123123

124-
**部署执行目录为**`./helm-Chart`目录下。
124+
**部署执行目录为**`./install`目录下。
125125

126126
```shell
127127
## Prophecis默认使用kubernetes的命名空间prophecis,需要创建

docs/zh_CN/User_Manual/DIGuide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ DI是Prophecis的子系统,支持用户选择单机或者分布式的方式来
1515
* 命名空间(namespace):管理员用户通过CC控制台创建,与所用硬件资源相关。
1616
* 状态:任务的运行状态,分为QUEUED、PENDING、RUNNING、FAILED、COMPLETED。
1717

18-
![图片](../userGuideImage/di/di_model_list_1.png)
18+
![图片](../image/di/di_model_list_1.png)
1919

2020
### 2.2 创建GPU集群任务
2121

@@ -26,20 +26,20 @@ DI是Prophecis的子系统,支持用户选择单机或者分布式的方式来
2626
1. **基础信息配置**
2727
* 任务名称及备注:配置任务名称、任务描述等基本信息
2828

29-
![图片](../userGuideImage/di/single_model_create_1.png)
29+
![图片](../image/di/single_model_create_1.png)
3030

3131
2. **镜像配置**
3232
* 镜像类型:标准为列表中提供的镜像,自定义可设置任意Tag
3333
* 镜像名称:Docker Image Tag
3434

35-
![图片](../userGuideImage/di/single_model_create_2.png)
35+
![图片](../image/di/single_model_create_2.png)
3636

3737
3. **计算资源配置**
3838
* 命名空间:命名空间会与硬件机器做绑定,对应命名空间下的任务会启动到对应的服务器上面。
3939
* 任务类型:在任务资源页面任务类型可选择单机或分布式,分布式任务即tensorflow的分布式模式,下图为单机模式的范例。
4040
* CPU/GPU/Mmemory:填写执行任务所需的CPU/GPU/Memory即可。
4141

42-
![图片](../userGuideImage/di/single_model_create_3.png)
42+
![图片](../image/di/single_model_create_3.png)
4343

4444
4. **训练任务目录配置**
4545

@@ -49,7 +49,7 @@ DI是Prophecis的子系统,支持用户选择单机或者分布式的方式来
4949
* 训练数据子目录: 通常作为存放数据的目录,和DATA_DIR相对应。
5050
* 训练结果子目录: 通常作为存放日志的目录,和RESULT_DIR相对应。
5151

52-
![图片](../userGuideImage/di/single_model_create_4.png)
52+
![图片](../image/di/single_model_create_4.png)
5353

5454
5. **任务执行设置**
5555
* 执行入口设置:

docs/zh_CN/User_Manual/MLLabisGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ MLLabis是Prophecis的个人开发环境子系统,允许用户创建Notebook
1010

1111
### 2.1 创建Notebook
1212

13-
![图片](../userGuideImage/lab/notebook_create_1.png)
13+
![图片](../image/lab/notebook_create_1.png)
1414

1515
进入个人开发环境后,在个人开发环境页面中包含已创建Notebook得列表信息,包括名称、用户、命名空间等。点击创建notebook之后,按步骤填写创建Notebook的相关信息,依次为基础信息设置、镜像设置、计算资源设置、存储设置,其中:
1616

install/MinioDeployment/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ clusterDomain: cluster.local
1313
## Set default image, imageTag, and imagePullPolicy. mode is used to indicate the
1414
##
1515
image:
16-
repository: wedataspere/prophecis
16+
repository: wedatasphere/prophecis
1717
tag: minio-2020-06-14
1818
pullPolicy: IfNotPresent
1919

0 commit comments

Comments
 (0)