Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update zentao deployment docs #820

Merged
merged 2 commits into from
Jul 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/plugins/zentao.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,37 @@ tools:
# nodePort of zentao service, currently zentao plugin only support `nodePort` type
nodePort: 30081
```

## Deployment

### Step1: Prepare a Kubernetes Cluster
- If you already have a kubernetes cluster, ignore this step.
- If not, you can use `hack/e2e/e2e-up.sh` to create a k8s cluster via `Kind` as test environment.
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
```shell
bash hack/e2e/e2e-up.sh
```

### Step2: Create Zentao Application via Config File
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
- Create a zentao config file following the usage example above.
```shell
./dtm apply -f zentao.yaml --debug
```

### Step3: Initialize Zentao Application
- Visit `http://NodeIP:NodePort`("NodeIP" and "NodePort" are Kubernets node IP and node port) to start the initialization process. Press `Start Installation` button to the next step.
![](zentao/zentao-welcome.jpg)

- You don't need to do anything about the system check and it's done automatically. If there are system check items that do not pass, please make sure that the previous operation is correct. If it still doesn't work, create an issue to track your problem.
![](zentao/zentao-systemCheck.jpg)

- Fill in database password filed with `options.deployment.mysqlPasswdValue` which was set previously in `zentao.yaml`.
![](zentao/zentao-configuration.jpg)

- If everything proceeds successfully, you will see the Zendo introduction.
![](zentao/zentao-intro.jpg)

- Fill in your company name and create an administrator account.
![](zentao/zentao-account.jpg)

- Now, the Zendo application has been successfully deployed.
![](zentao/zentao-web.jpg)
38 changes: 36 additions & 2 deletions docs/plugins/zentao.zh.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zentao 插件
# 禅道插件
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved

该插件将通过`client-go`库在 Kubernetes 集群中安装[禅道应用](https://zentao.net/).

Expand All @@ -8,7 +8,7 @@
- 用户可以根据自己的需求修改以下配置文件中的字段,所有列出的字段都需要被设置。
- 该插件暂时不支持运行在`arm64`系统架构;`amd64`架构已经过测试运行正常。
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved

## Usage
## 用法示例

```yaml
---
Expand Down Expand Up @@ -74,3 +74,37 @@ tools:
# nodePort of zentao service, currently zentao plugin only support `nodePort` type
nodePort: 30081
```

## 部署

### 第一步:准备一个Kubernetes集群
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
- 如果已经部署Kubernetes集群环境,可以忽略第一步。
- 如果尚未部署Kubernetes集群环境,可以使用脚本`hack/e2e/e2e-up.sh`来创建一个Kubernetes测试环境,该脚本会基于`Kind`创建集群。
```shell
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
bash hack/e2e/e2e-up.sh
```

### 第二步:利用配置文件创建禅道应用
- 根据上面提供的示例用法创建一个`zentao.yaml`.
```shell
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
./dtm apply -f zentao.yaml --debug
```

### 第三步:初始化禅道应用
- 浏览器访问`http://NodeIP:NodePort`("NodeIP"与"NodePort"对应Kubernets节点IP和节点端口)来初始化禅道服务。点击`开始安装`按钮进入下一步。
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
![](zentao/zentao-welcome.jpg)

- 针对系统检查步骤,用户不需要做任何操作,系统检查会自动完成。如果存在未通过的检查项,请确保之前的部署流程均按照上述文档指示进行。如果仍不能解决问题,请在社区新建issue来跟踪相关问题。
![](zentao/zentao-systemCheck.jpg)

- 数据库部署步骤只需在`数据库密码`栏填入之前设置的`options.deployment.mysqlPasswdValue`值。
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
![](zentao/zentao-configuration.jpg)

- 如果上述所有操作均成功完成,这时将展示禅道应用介绍界面。
![](zentao/zentao-intro.jpg)

- 填写用户的公司信息并创建管理员账户,然后点击`保存`。
![](zentao/zentao-account.jpg)

- 至此,禅道服务就部署成功啦。
![](zentao/zentao-web.jpg)
Binary file added docs/plugins/zentao/zentao-account.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/plugins/zentao/zentao-configuration.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/plugins/zentao/zentao-intro.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/plugins/zentao/zentao-systemCheck.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/plugins/zentao/zentao-web.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/plugins/zentao/zentao-welcome.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.