Skip to content

Commit

Permalink
fix: links error in documents
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Hu <tao.hu@merico.dev>
  • Loading branch information
daniel-hutao committed Nov 1, 2022
1 parent 4b8ad85 commit 022e629
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/plugins/argocdapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This plugin creates an [ArgoCD Application](https://argo-cd.readthedocs.io/en/st
**Notes:**

- ArgoCD itself must have been already installed before the usage of this plugin.
To install ArgoCD, use the [argocd plugin](./argocd.md).
To install ArgoCD, use the [helm-installer plugin](./helm-installer/argocd.md).
Or you can use both plugins(argocd+argocdapp) at the same time.
See [GitOps Toolchain](../best-practices/gitops.md) for more info.
- Currently, only the Helm chart is supported when creating the ArgoCD application.
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/helm-installer/harbor.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Examples:

## 2 Harbor Architecture

![Harbor Architecture](./harbor/ha.png)
![Harbor Architecture](../harbor/ha.png)

## 3 Using the Harbor Plugin with DevStream

Expand Down Expand Up @@ -125,11 +125,11 @@ We can forward the port of the Harbor service and log in:
kubectl port-forward -n harbor service/harbor 8080:80
```

![Harbor Login](./harbor/login.png)
![Harbor Login](../harbor/login.png)

And the default login user/pwd is: `admin/Harbor12345`. You will see the dashboard after a successful login:

![Harbor Dashboard](./harbor/dashboard.png)
![Harbor Dashboard](../harbor/dashboard.png)

### 3.3 Default Config

Expand Down
10 changes: 5 additions & 5 deletions docs/plugins/helm-installer/harbor.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Harbor 本身并不关注如何实现存储高可用,所以 Harbor 通过 PVCs

Harbor 部署架构整体如下图所示(图片来自 Harbor 官网):

![Harbor Architecture](./harbor/ha.png)
![Harbor Architecture](../harbor/ha.png)

## 3、开始部署

Expand Down Expand Up @@ -130,11 +130,11 @@ standard (default) k8s.io/minikube-hostpath Delete Immediate

到这里,我们就可以通过 http://127.0.0.1:3002 访问到 Harbor 登录页面了,如下:

![Harbor Login](./harbor/login.png)
![Harbor Login](../harbor/login.png)

默认登录账号/密码是 `admin/Harbor12345`。登录后,可以看到默认首页如下:

![Harbor Dashboard](./harbor/dashboard.png)
![Harbor Dashboard](../harbor/dashboard.png)

如果是在云主机上部署的 Harbor,可以通过 `kubectl port-forward` 命令来暴露服务:

Expand Down Expand Up @@ -465,7 +465,7 @@ valuesYaml: |
tag: v2.5.3
```

这段配置中留了一个变量 `[[ imageRepo ]]`,你可以在[变量配置](../core-concepts/variables.zh.md)中定义这个变量,变量值设置成你的镜像仓库地址,例如:
这段配置中留了一个变量 `[[ imageRepo ]]`,你可以在[变量配置](../../core-concepts/variables.zh.md)中定义这个变量,变量值设置成你的镜像仓库地址,例如:

```yaml
imageRepo: harbor.example.com:9000
Expand All @@ -490,7 +490,7 @@ export IMAGE_REPO_ADDR=harbor.devstream.io
./image-pull-push.sh -f harbor-images.txt -r ${IMAGE_REPO_ADDR} -l -u
```

如果你还没有一个私有镜像仓库,可以参考[这篇文章](../best-practices/image-registry.zh.md)快速部署一个 Docker Registry。
如果你还没有一个私有镜像仓库,可以参考[这篇文章](../../best-practices/image-registry.zh.md)快速部署一个 Docker Registry。

### 5.3、参考配置

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
14 changes: 7 additions & 7 deletions docs/plugins/helm-installer/jenkins.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ tools:
nodePort: 32000
```
*注意:这个配置示例仅是 tool config,完整的 DevStream 配置文件还需要补充 core config 等内容,具体参考[这个文档](../core-concepts/config.zh.md)。*
*注意:这个配置示例仅是 tool config,完整的 DevStream 配置文件还需要补充 core config 等内容,具体参考[这个文档](../../core-concepts/config.zh.md)。*
在成功执行 `dtm apply` 命令后,我们可以在 jenkins 命名空间下看到下述主要资源:

Expand Down Expand Up @@ -103,13 +103,13 @@ standard (default) k8s.io/minikube-hostpath Delete Immediate

这时候 minikube 会自动打开浏览器,跳转到 http://127.0.0.1:65398 页面(如果没有自动跳转,可以手动打开浏览器,输入这个 url;注意:根据你的命令行输出内容修改 url 中的端口号):

![Jenkins Login](./jenkins/login.png)
![Jenkins Login](../jenkins/login.png)

- **登录**

如果你浏览过前面我们使用的"最小化配置文件",肯定已经注意到了里面和用户名、密码相关的配置,没错,通过 admin/changeme 就可以登录 Jenkins 了!

![Jenkins Dashboard](./jenkins/dashboard.png)
![Jenkins Dashboard](../jenkins/dashboard.png)

最后,记得修改密码哦!

Expand Down Expand Up @@ -354,15 +354,15 @@ valuesYaml: |
tag: 0.2.0
```

这段配置中留了一个变量 `[[ imageRepo ]]`,你可以在[变量配置](../core-concepts/variables.zh.md)中定义这个变量,变量值设置成你的镜像仓库地址,例如:
这段配置中留了一个变量 `[[ imageRepo ]]`,你可以在[变量配置](../../core-concepts/variables.zh.md)中定义这个变量,变量值设置成你的镜像仓库地址,例如:

```yaml
imageRepo: harbor.example.com:9000
```

当然,你需要保证需要的镜像都在你的镜像仓库中存在。

你可以下载[镜像列表文件](./jenkins/jenkins-images.txt),
你可以下载[镜像列表文件](../jenkins/jenkins-images.txt),
然后借助["Image Pull Push"](https://raw.githubusercontent.com/devstream-io/devstream/main/hack/image-pull-push.sh)工具脚本来准备镜像。

```shell
Expand All @@ -379,11 +379,11 @@ export IMAGE_REPO_ADDR=harbor.devstream.io
./image-pull-push.sh -f jenkins-images.txt -r ${IMAGE_REPO_ADDR} -l -u
```

如果你还没有一个私有镜像仓库,可以参考[这篇文章](../best-practices/image-registry.zh.md)快速部署一个 Docker Registry。
如果你还没有一个私有镜像仓库,可以参考[这篇文章](../../best-practices/image-registry.zh.md)快速部署一个 Docker Registry。

### 5.3、参考配置

可能你已经注意到前面的[镜像列表](./jenkins/jenkins-images.txt)里有一个 DevStream 自定义镜像 `devstreamdev/jenkins:2.361.1-jdk11-dtm-0.1`,
可能你已经注意到前面的[镜像列表](../jenkins/jenkins-images.txt)里有一个 DevStream 自定义镜像 `devstreamdev/jenkins:2.361.1-jdk11-dtm-0.1`,
在这个镜像里 DevStream 为离线部署场景做了增强,所以对应的配置文件我们也需要做一些调整,如下:

```yaml
Expand Down
File renamed without changes
File renamed without changes.
File renamed without changes
2 changes: 1 addition & 1 deletion docs/plugins/plugins-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
| CI | ci-generic | Generic CI plugin | [doc](ci-generic.md) |
| CD/GitOps | argocdapp | ArgoCD Application creation | [doc](argocdapp.md) |
| Image Repository | harbor-docker | Harbor Docker compose install | [doc](harbor-docker.md) |
| Deployment | helm-installer | Helm chart install | [doc](helm-installer.md) |
| Deployment | helm-installer | Helm chart install | [doc](helm-installer/helm-installer.md) |

Or, to get a list of plugins, run:

Expand Down

0 comments on commit 022e629

Please sign in to comment.