From 022e62997b5f19ea410e0fd72bba80b32f2de7c7 Mon Sep 17 00:00:00 2001 From: Daniel Hu Date: Tue, 1 Nov 2022 11:07:03 +0800 Subject: [PATCH] fix: links error in documents Signed-off-by: Daniel Hu --- docs/plugins/argocdapp.md | 2 +- docs/plugins/helm-installer/harbor.md | 6 +++--- docs/plugins/helm-installer/harbor.zh.md | 10 +++++----- .../{ => helm-installer}/harbor/dashboard.png | Bin docs/plugins/{ => helm-installer}/harbor/ha.png | Bin .../{ => helm-installer}/harbor/harbor-images.txt | 0 .../plugins/{ => helm-installer}/harbor/login.png | Bin docs/plugins/helm-installer/jenkins.zh.md | 14 +++++++------- .../{ => helm-installer}/jenkins/dashboard.png | Bin .../jenkins/jenkins-images.txt | 0 .../{ => helm-installer}/jenkins/login.png | Bin docs/plugins/plugins-list.md | 2 +- 12 files changed, 17 insertions(+), 17 deletions(-) rename docs/plugins/{ => helm-installer}/harbor/dashboard.png (100%) rename docs/plugins/{ => helm-installer}/harbor/ha.png (100%) rename docs/plugins/{ => helm-installer}/harbor/harbor-images.txt (100%) rename docs/plugins/{ => helm-installer}/harbor/login.png (100%) rename docs/plugins/{ => helm-installer}/jenkins/dashboard.png (100%) rename docs/plugins/{ => helm-installer}/jenkins/jenkins-images.txt (100%) rename docs/plugins/{ => helm-installer}/jenkins/login.png (100%) diff --git a/docs/plugins/argocdapp.md b/docs/plugins/argocdapp.md index 8c1ee6930..a9b67aea3 100644 --- a/docs/plugins/argocdapp.md +++ b/docs/plugins/argocdapp.md @@ -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. diff --git a/docs/plugins/helm-installer/harbor.md b/docs/plugins/helm-installer/harbor.md index f50432ff9..6a43b19ca 100644 --- a/docs/plugins/helm-installer/harbor.md +++ b/docs/plugins/helm-installer/harbor.md @@ -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 @@ -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 diff --git a/docs/plugins/helm-installer/harbor.zh.md b/docs/plugins/helm-installer/harbor.zh.md index c6488e4b6..b632d21b6 100644 --- a/docs/plugins/helm-installer/harbor.zh.md +++ b/docs/plugins/helm-installer/harbor.zh.md @@ -18,7 +18,7 @@ Harbor 本身并不关注如何实现存储高可用，所以 Harbor 通过 PVCs Harbor 部署架构整体如下图所示(图片来自 Harbor 官网)： -![Harbor Architecture](./harbor/ha.png) +![Harbor Architecture](../harbor/ha.png) ## 3、开始部署 @@ -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` 命令来暴露服务： @@ -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 @@ -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、参考配置 diff --git a/docs/plugins/harbor/dashboard.png b/docs/plugins/helm-installer/harbor/dashboard.png similarity index 100% rename from docs/plugins/harbor/dashboard.png rename to docs/plugins/helm-installer/harbor/dashboard.png diff --git a/docs/plugins/harbor/ha.png b/docs/plugins/helm-installer/harbor/ha.png similarity index 100% rename from docs/plugins/harbor/ha.png rename to docs/plugins/helm-installer/harbor/ha.png diff --git a/docs/plugins/harbor/harbor-images.txt b/docs/plugins/helm-installer/harbor/harbor-images.txt similarity index 100% rename from docs/plugins/harbor/harbor-images.txt rename to docs/plugins/helm-installer/harbor/harbor-images.txt diff --git a/docs/plugins/harbor/login.png b/docs/plugins/helm-installer/harbor/login.png similarity index 100% rename from docs/plugins/harbor/login.png rename to docs/plugins/helm-installer/harbor/login.png diff --git a/docs/plugins/helm-installer/jenkins.zh.md b/docs/plugins/helm-installer/jenkins.zh.md index a4980bb0d..df6c743c8 100644 --- a/docs/plugins/helm-installer/jenkins.zh.md +++ b/docs/plugins/helm-installer/jenkins.zh.md @@ -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 命名空间下看到下述主要资源： @@ -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) 最后，记得修改密码哦！ @@ -354,7 +354,7 @@ valuesYaml: | tag: 0.2.0 ``` -这段配置中留了一个变量 `[[ imageRepo ]]`，你可以在[变量配置](../core-concepts/variables.zh.md)中定义这个变量，变量值设置成你的镜像仓库地址，例如： +这段配置中留了一个变量 `[[ imageRepo ]]`，你可以在[变量配置](../../core-concepts/variables.zh.md)中定义这个变量，变量值设置成你的镜像仓库地址，例如： ```yaml imageRepo: harbor.example.com:9000 @@ -362,7 +362,7 @@ 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 @@ -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 diff --git a/docs/plugins/jenkins/dashboard.png b/docs/plugins/helm-installer/jenkins/dashboard.png similarity index 100% rename from docs/plugins/jenkins/dashboard.png rename to docs/plugins/helm-installer/jenkins/dashboard.png diff --git a/docs/plugins/jenkins/jenkins-images.txt b/docs/plugins/helm-installer/jenkins/jenkins-images.txt similarity index 100% rename from docs/plugins/jenkins/jenkins-images.txt rename to docs/plugins/helm-installer/jenkins/jenkins-images.txt diff --git a/docs/plugins/jenkins/login.png b/docs/plugins/helm-installer/jenkins/login.png similarity index 100% rename from docs/plugins/jenkins/login.png rename to docs/plugins/helm-installer/jenkins/login.png diff --git a/docs/plugins/plugins-list.md b/docs/plugins/plugins-list.md index c99933081..eb2ed0db3 100644 --- a/docs/plugins/plugins-list.md +++ b/docs/plugins/plugins-list.md @@ -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: