Skip to content

Commit 25bf290

Browse files
daniel-hutaodaniel-hutao
authored
Merge pull request #1088 from merico-dev/feat-air-gapped
Feat: Helm Chart Local Installation Support
2 parents 71f313c + c28ef1b commit 25bf290

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+340
-154
lines changed

‎docs/best-practices/gitlab-jenkins-harbor.zh.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,13 @@ jenkins 插件的配置如下：
9191
name: jenkins
9292
url: https://charts.jenkins.io
9393
chart:
94-
chart_name: jenkins/jenkins
94+
chartPath: ""
95+
chartName: jenkins/jenkins
9596
namespace: jenkins
9697
wait: true
9798
timeout: 5m
9899
upgradeCRDs: true
99-
values_yaml: |
100+
valuesYaml: |
100101
serviceAccount:
101102
create: true
102103
name: jenkins
@@ -131,7 +132,7 @@ harbor 插件的配置如下：
131132
dependsOn: [ ]
132133
options:
133134
chart:
134-
values_yaml: |
135+
valuesYaml: |
135136
externalURL: http://harbor.example.com
136137
expose:
137138
type: ingress
@@ -204,12 +205,13 @@ tools:
204205
name: jenkins
205206
url: https://charts.jenkins.io
206207
chart:
207-
chart_name: jenkins/jenkins
208+
chartPath: ""
209+
chartName: jenkins/jenkins
208210
namespace: jenkins
209211
wait: true
210212
timeout: 5m
211213
upgradeCRDs: true
212-
values_yaml: |
214+
valuesYaml: |
213215
serviceAccount:
214216
create: true
215217
name: jenkins
@@ -235,7 +237,7 @@ tools:
235237
dependsOn: [ ]
236238
options:
237239
chart:
238-
values_yaml: |
240+
valuesYaml: |
239241
externalURL: http://harbor.example.com
240242
expose:
241243
type: ingress

‎docs/core-concepts/output.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,9 @@ tools:
6969
name: argo
7070
url: https://argoproj.github.io/argo-helm
7171
chart:
72-
chart_name: argo/argo-cd
73-
release_name: argocd
72+
chartPath: ""
73+
chartName: argo/argo-cd
74+
releaseName: argocd
7475
namespace: argocd
7576
wait: true
7677
timeout: 10m

‎docs/plugins/argocd.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ This plugin installs [ArgoCD](https://argoproj.github.io/cd/) in an existing Kub
1212

1313
| key | default value | description |
1414
| ---------------- | ------------------------------------ | ------------------------------------------------ |
15-
| chart.chart_name | argo/argo-cd | chart name |
15+
| chart.chartPath | "" | local chart path |
16+
| chart.chartName | argo/argo-cd | chart name |
1617
| chart.timeout | 5m | this config will wait 5 minutes to deploy argocd |
1718
| chart.upgradeCRDs | true | default update CRD config |
18-
| chart.release_name | argocd | helm release name |
19+
| chart.releaseName | argocd | helm release name |
1920
| chart.namespace | argocd | namespace where helm to deploy |
2021
| chart.wait | true | whether to wait until installation is complete |
2122
| repo.url | https://argoproj.github.io/argo-helm | helm official repo address |
2223
| repo.name | argo | helm repo name |
2324

24-
Currently, except for `values_yaml` and default configs, all the parameters in the example above are mandatory.
25+
Currently, except for `valuesYaml` and default configs, all the parameters in the example above are mandatory.

‎docs/plugins/artifactory.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ This plugin installs [artifactory](https://jfrog.com/artifactory/) in an existin
66

77
### Test/Local Dev Environment
88

9-
If you want to **test the plugin locally**， The following `values_yaml` configuration can be used
9+
If you want to **test the plugin locally**， The following `valuesYaml` configuration can be used
1010

1111
```yaml
12-
values_yaml: |
12+
valuesYaml: |
1313
artifactory:
1414
service:
1515
type: NodePort
@@ -48,12 +48,13 @@ This plugin support`Ingress`, `ClusterIP`, `NodePort` and `LoadBalancer` , You c
4848

4949
| key | default value | description |
5050
| ---- | ---- | ---- |
51-
| chart.chart_name | jfrog/artifactory | chart name |
51+
| chart.chartPath | "" | local chart path |
52+
| chart.chartName | jfrog/artifactory | chart name |
5253
| chart.timeout | 10m | this config will wait 10 minutes to deploy |
53-
| chart.release_name | artifactory | helm release name |
54+
| chart.releaseName | artifactory | helm release name |
5455
| chart.upgradeCRDs | true | default update CRD config |
5556
| chart.wait | true | whether to wait until installation is complete |
5657
| chart.namespace | artifactory | namespace where helm to deploy |
5758
| repo.url | https://charts.jfrog.io | offical helm repo address |
5859
| repo.name | jfrog | helm repo name |
59-
Currently, except for `values_yaml` and default configs, all the parameters in the example above are mandatory.
60+
Currently, except for `valuesYaml` and default configs, all the parameters in the example above are mandatory.

‎docs/plugins/artifactory.zh.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
### 测试环境
88

9-
如果你想在**本地测试插件**， 可以使用如下 `values_yaml` 配置。
9+
如果你想在**本地测试插件**， 可以使用如下 `valuesYaml` 配置。
1010

1111
```yaml
12-
values_yaml: |
12+
valuesYaml: |
1313
artifactory:
1414
service:
1515
type: NodePort
@@ -48,13 +48,14 @@ values_yaml: |
4848

4949
| key | default value | description |
5050
| ---- | ---- | ---- |
51-
| chart.chart_name | jfrog/artifactory | helm 包名称 |
52-
| chart.timeout | 10m | 等待部署成功的时间 |
53-
| chart.upgradeCRDs | true | 默认更新 CRD 配置（如果存在的话） |
54-
| chart.release_name | artifactory | helm 发布名称 |
55-
| chart.wait | true | 是否等待部署完成 |
56-
| chart.namespace | artifactory | helm 部署的命名空间名称 |
57-
| repo.url | https://charts.jfrog.io | helm 官方仓库地址 |
51+
| chart.chartPath | "" | 本地 chart 包路径 |
52+
| chart.chartName | jfrog/artifactory | helm 包名称 |
53+
| chart.timeout | 10m | 等待部署成功的时间 |
54+
| chart.upgradeCRDs | true | 默认更新 CRD 配置（如果存在的话） |
55+
| chart.releaseName | artifactory | helm 发布名称 |
56+
| chart.wait | true | 是否等待部署完成 |
57+
| chart.namespace | artifactory | helm 部署的命名空间名称 |
58+
| repo.url | https://charts.jfrog.io | helm 官方仓库地址 |
5859
| repo.name | jfrog | helm 仓库名 |
5960

60-
目前除了 `values_yaml` 字段和默认配置，其它所有示例参数均为必填项。
61+
目前除了 `valuesYaml` 字段和默认配置，其它所有示例参数均为必填项。

‎docs/plugins/harbor.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ tools:
4242
dependsOn: [ ]
4343
options:
4444
chart:
45-
values_yaml: |
45+
valuesYaml: |
4646
externalURL: http://127.0.0.1
4747
expose:
4848
type: nodePort
@@ -149,13 +149,14 @@ The `harbor` plugin provides default values for many options:
149149

150150
| key | default value | description |
151151
| ---- | ---- | ---- |
152-
| chart.chart_name | harbor/harbor | helm chart name |
153-
| chart.timeout | 10m | timeout for helm install |
154-
| chart.upgradeCRDs | true | update CRDs or not (if any) |
155-
| chart.release_name | harbor | helm release name |
156-
| chart.wait | true | wait till deployment finishes |
157-
| chart.namespace | harbor | namespace |
158-
| repo.url | https://helm.goharbor.io | helm repo URL |
152+
| chart.chartPath | "" | local chart path |
153+
| chart.chartName | harbor/harbor | helm chart name |
154+
| chart.timeout | 10m | timeout for helm install |
155+
| chart.upgradeCRDs | true | update CRDs or not (if any) |
156+
| chart.releaseName | harbor | helm release name |
157+
| chart.wait | true | wait till deployment finishes |
158+
| chart.namespace | harbor | namespace |
159+
| repo.url | https://helm.goharbor.io | helm repo URL |
159160
| repo.name | harbor | helm repo name |
160161

161162
A maximum config is as follows:

‎docs/plugins/harbor.zh.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ tools:
4949
dependsOn: [ ]
5050
options:
5151
chart:
52-
values_yaml: |
52+
valuesYaml: |
5353
externalURL: http://127.0.0.1
5454
expose:
5555
type: nodePort
@@ -161,10 +161,11 @@ kubectl port-forward -n harbor service/harbor --address=${ip} 80
161161

162162
| 配置项 | 默认值 | 描述 |
163163
| ---- | ---- | ---- |
164-
| chart.chart_name | harbor/harbor | helm chart 包名称 |
164+
| chart.chartPath | "" | 本地 chart 包路径 |
165+
| chart.chartName | harbor/harbor | helm chart 包名称 |
165166
| chart.timeout | 10m | helm install 的超时时间 |
166-
| chart.upgradeCRDs | true | 是否更新 CRDs（如果有） |
167-
| chart.release_name | harbor | helm 发布名称 |
167+
| chart.upgradeCRDs | true | 是否更新 CRDs（如果有） |
168+
| chart.releaseName | harbor | helm 发布名称 |
168169
| chart.wait | true | 是否等待部署完成 |
169170
| chart.namespace | harbor | 部署的命名空间 |
170171
| repo.url | https://helm.goharbor.io | helm 仓库地址 |
@@ -176,7 +177,7 @@ kubectl port-forward -n harbor service/harbor --address=${ip} 80
176177
--8<-- "harbor.yaml"
177178
```
178179

179-
目前除了 `values_yaml` 字段和默认配置，其它所有示例参数均为必填项。
180+
目前除了 `valuesYaml` 字段和默认配置，其它所有示例参数均为必填项。
180181

181182
### 3.3、持久化存储数据
182183

@@ -226,7 +227,7 @@ tools:
226227
dependsOn: [ ]
227228
options:
228229
chart:
229-
values_yaml: |
230+
valuesYaml: |
230231
persistence:
231232
persistentVolumeClaim:
232233
registry:
@@ -258,7 +259,7 @@ tools:
258259
dependsOn: [ ]
259260
options:
260261
chart:
261-
values_yaml: |
262+
valuesYaml: |
262263
externalURL: http://127.0.0.1
263264
expose:
264265
type: nodePort
@@ -273,7 +274,7 @@ tools:
273274
dependsOn: [ ]
274275
options:
275276
chart:
276-
values_yaml: |
277+
valuesYaml: |
277278
externalURL: http://core.harbor.domain
278279
expose:
279280
type: ingress
@@ -329,7 +330,7 @@ tools:
329330
dependsOn: [ ]
330331
options:
331332
chart:
332-
values_yaml: |
333+
valuesYaml: |
333334
externalURL: http://core.harbor.domain
334335
expose:
335336
type: ingress

‎docs/plugins/hashicorp-vault.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ This plugin installs hashicorp-vault with replicas:3 by default value.
1414

1515
| key | default value | description |
1616
| ---- | ---- | ---- |
17-
| chart.chart_name | hashicorp/vault | chart name |
17+
| chart.chartPath | "" | local chart path |
18+
| chart.chartName | hashicorp/vault | chart name |
1819
| chart.timeout | 5m | this config will wait 5 minutes to deploy |
19-
| chart.release_name | vault | helm release name |
20+
| chart.releaseName | vault | helm release name |
2021
| chart.upgradeCRDs | true | default update CRD config |
2122
| chart.wait | true | whether to wait until installation is complete |
2223
| chart.namespace | vault | namespace where helm to deploy |
2324
| repo.url | https://helm.releases.hashicorp.com | helm official repo address |
2425
| repo.name | hashicorp | helm repo name |
26+
2527
## Initialize all the Vault pods
2628

2729
After installing the Vault on k8s, you can initialize all pods of the Vault on k8s. To know more about the Vault, you can refer to:

‎docs/plugins/jenkins-github-integ.zh.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,12 @@ tools:
5959
url: https://charts.jenkins.io
6060
# Helm chart information
6161
chart:
62+
# local path of the chart; if chartPath != "", repo.name and repo.url will be ignored. e.g. "foo.tgz", "./foo.tgz", "/tmp/foo.tgz"
63+
chartPath: ""
6264
# name of the chart
63-
chart_name: jenkins/jenkins
65+
chartName: jenkins/jenkins
6466
# release name of the chart
65-
release_name: dev
67+
releaseName: dev
6668
# k8s namespace where jenkins will be installed
6769
namespace: jenkins
6870
# whether to wait for the release to be deployed or not
@@ -72,7 +74,7 @@ tools:
7274
# whether to perform a CRD upgrade during installation
7375
upgradeCRDs: true
7476
# custom configuration. You can refer to [Jenkins values.yaml](https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/values.yaml)
75-
values_yaml: |
77+
valuesYaml: |
7678
persistence:
7779
# for prod env: the existent storageClass, please change it
7880
# for test env: just ignore it, but don't remove it

‎docs/plugins/jenkins-pipeline-kubernetes.zh.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,12 @@ tools:
4949
url: https://charts.jenkins.io
5050
# Helm chart information
5151
chart:
52+
# local path of the chart; if chartPath != "", repo.name and repo.url will be ignored. e.g. "foo.tgz", "./foo.tgz", "/tmp/foo.tgz"
53+
chartPath: ""
5254
# name of the chart
53-
chart_name: jenkins/jenkins
55+
chartName: jenkins/jenkins
5456
# release name of the chart
55-
release_name: dev
57+
releaseName: dev
5658
# k8s namespace where jenkins will be installed
5759
namespace: jenkins
5860
# whether to wait for the release to be deployed or not
@@ -62,7 +64,7 @@ tools:
6264
# whether to perform a CRD upgrade during installation
6365
upgradeCRDs: true
6466
# custom configuration. You can refer to [Jenkins values.yaml](https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/values.yaml)
65-
values_yaml: |
67+
valuesYaml: |
6668
persistence:
6769
# for prod env: the existent storageClass, please change it
6870
# for test env: just ignore it, but don't remove it

‎docs/plugins/jenkins.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ Please be sure to change the `storageClass` in the options of the config to an e
1616

1717
| key | default value | description |
1818
| ---- | ---- | ---- |
19-
| chart.chart_name | jenkins/jenkins | chart name |
19+
| chart.chartPath | "" | local chart path |
20+
| chart.chartName | jenkins/jenkins | chart name |
2021
| chart.timeout | 5m | this config will wait 5 minutes to deploy |
2122
| chart.upgradeCRDs | true | default update CRD config |
22-
| chart.release_name | jenkins | helm release name |
23+
| chart.releaseName | jenkins | helm release name |
2324
| chart.wait | true | whether to wait until installation is complete |
2425
| chart.namespace | jenkins | namespace where helm to deploy |
2526
| repo.url | https://charts.jenkins.io | helm official repo address |

0 commit comments

Comments
 (0)