Skip to content

Commit d54b23d

Browse files
IronCore864IronCore864
authored
Merge pull request #1421 from aFlyBird0/docs-helm
docs: use cases - helm installer
2 parents 67f819d + c953364 commit d54b23d

19 files changed

+230
-7
lines changed

‎docs/plugins/helm-installer/argocd.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Install Argo CD with DevStream
22

3+
## InstanceID Prefix
4+
5+
The `instanceID` prefix must be `argocd`, the minimum tools configuration example:
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: argocd
11+
```
12+
313
## Default Configs
414
515
| key | default value | description |

‎docs/plugins/helm-installer/argocd.zh.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 使用 DevStream 部署 Argo CD
22

3+
## 前缀匹配
4+
5+
`instanceID` 的前缀需要是 `argocd`，最小化 tools 配置示例：
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: argocd
11+
```
12+
313
## 默认配置
414
515
| 配置项 | 默认值 | 描述 |

‎docs/plugins/helm-installer/artifactory.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Install Artifactory with DevStream
22

3+
## InstanceID Prefix
4+
5+
The `instanceID` prefix must be `artifactory`, the minimum tools configuration example:
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: artifactory
11+
```
12+
313
## Default Configs
414
515
| key | default value | description |

‎docs/plugins/helm-installer/artifactory.zh.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 使用 DevStream 部署 Artifactory
22

3+
## 前缀匹配
4+
5+
`instanceID` 的前缀需要是 `artifactory`，最小化 tools 配置示例：
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: artifactory
11+
```
12+
313
## 默认配置
414
515
| key | default value | description |

‎docs/plugins/helm-installer/devlake.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Install DevLake with DevStream
22

3+
## InstanceID Prefix
4+
5+
The `instanceID` prefix must be `devlake`, the minimum tools configuration example:
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: devlake
11+
```
12+
313
## Default Configs
414
515
| key | default value | description |

‎docs/plugins/helm-installer/devlake.zh.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 使用 DevStream 部署 DevLake
22

3+
## 前缀匹配
4+
5+
`instanceID` 的前缀需要是 `devlake`，最小化 tools 配置示例：
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: devlake
11+
```
12+
313
## 默认配置
414
515
| 配置项 | 默认值 | 描述 |

‎docs/plugins/helm-installer/helm-installer.zh.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ tools:
1818
```
1919
2020
在这个配置文件里，和插件相关的配置 name 和 instanceID，前者表示你将使用 `helm-installer` 插件，后者表示插件实例名。
21-
请注意这个 instanceID 使用了 "argocd-" 前缀，DevStream 会识别这个前缀，尝试寻找 Argo CD 应用对应的 Chart，并设置一系列默认值，然后开始部署。
21+
请注意这个 instanceID 使用了 "argocd" 前缀，DevStream 会识别这个前缀，尝试寻找 Argo CD 应用对应的 Chart，并设置一系列默认值，然后开始部署。
2222

2323
你可以在 [Install Argo CD with DevStream](./argocd.zh.md) 中查看 DevStream 为你设置了哪些默认值。
2424

@@ -47,6 +47,7 @@ tools:
4747
chartName: ""
4848
version: ""
4949
namespace: ""
50+
releaseName: ""
5051
wait: true
5152
timeout: 10m
5253
upgradeCRDs: true
@@ -58,7 +59,7 @@ tools:
5859
### 2.1、instanceID 使用技巧
5960

6061
instanceID 的前缀如果能够匹配到某个已经被支持的工具（详见文末列表），那么 DevStream 会为你设置一系列的默认值。
61-
比如 "argocd-001" 的前缀 "argocd-" 能够匹配到 "argocd" + "-"，因此 Argo CD 的默认 Chart 配置会被应用，于是如下最小化配置：
62+
比如 "argocd-001" 的前缀 "argocd-" 能够匹配到 "argocd"，因此 Argo CD 的默认 Chart 配置会被应用，于是如下最小化配置：
6263

6364
```yaml
6465
tools:
@@ -74,13 +75,14 @@ tools:
7475
dependsOn: [ ]
7576
options:
7677
repo:
77-
name: ""
78-
url: ""
78+
name: "argo"
79+
url: "https://argoproj.github.io/argo-helm"
7980
chart:
8081
chartPath: ""
81-
chartName: ""
82+
chartName: "argo/argo-cd"
8283
version: ""
83-
namespace: ""
84+
namespace: "argocd"
85+
releaseName: "argocd"
8486
wait: true
8587
timeout: 10m
8688
upgradeCRDs: true

‎docs/plugins/helm-installer/kube-prometheus.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Install kube-prometheus with DevStream
22

3+
## InstanceID Prefix
4+
5+
The `instanceID` prefix must be `kube-prometheus`, the minimum tools configuration example:
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: kube-prometheus
11+
```
12+
313
## Default Configs
414
515
| key | default value | description |

‎docs/plugins/helm-installer/kube-prometheus.zh.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 使用 DevStream 部署 kube-prometheus
22

3+
## 前缀匹配
4+
5+
`instanceID` 的前缀需要是 `kube-prometheus`，最小化 tools 配置示例：
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: kube-prometheus
11+
```
12+
313
## 默认配置
414
515
| 配置项 | 默认值 | 描述 |

‎docs/plugins/helm-installer/openldap.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Install OpenLDAP with DevStream
22

3+
## InstanceID Prefix
4+
5+
The `instanceID` prefix must be `openldap`, the minimum tools configuration example:
6+
7+
```yaml
8+
tools:
9+
- name: helm-installer
10+
instanceID: openldap
11+
```
12+
313
### Default Configs
414
515
| key | default value | description |

0 commit comments

Comments
 (0)