You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/new-helm/using-helm-in-codefresh-pipeline.md
+27-26Lines changed: 27 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -241,32 +241,33 @@ Notes:
241
241
242
242
## Configuration
243
243
244
-
Name|Required|Description
245
-
---|---|---
246
-
action|defaults to `install'|Operation mode:`install`/`push`/`auth`
247
-
chart_name|required for install/push|Chart reference to use, adhering to Helm's lookup rules (path to chart folder, or name of packaged chart). There's no need to prefix with `/reponame` if referencing a chart in a repository, this is handled automatically. a.k.a `CHART_NAME` but `CHART_NAME` shouldn't be used anymore.
248
-
chart_repo_url|optional|Helm chart repository URL. If a [Helm repository configuration](#step-4-optional---import-the-helm-configuration-in-your-pipeline-definition) is attached to the pipeline, this setting is ignored
249
-
chart_subdir |optional | The subfolder where the chart is located in the JFrog Artifactory Helm repository.
250
-
chart_version|optional|Override or set the chart version
251
-
cmd_ps|optional|Command Postscript - this will be appended as is to the generated helm command string. Can be used to set additional parameters supported by the command but not exposed as configuration options.
252
-
commands|optional|commands to execute in plugin after auth action
253
-
credentials_in_arguments | optional | The username and password credentials to add to the Helm command as arguments. If not added to the Helm command, the credentials are passed in the URL `http(s)://username:password@url`. Should be enabled for JFrog Artifactory Helm repositories.
254
-
custom_value_files|optional|values file to provide to Helm as --values or -f
255
-
custom_values|optional|values to provide to Helm as --set
256
-
helm_repository_context | The name of the Helm repository integration configured in Codefresh.
257
-
helm_version|optional|version of [cfstep-helm image](https://hub.docker.com/r/codefresh/cfstep-helm/tags)
258
-
kube_context|required for install|Kubernetes context to use. The name of the cluster as [configured in Codefresh]({{site.baseurl}}/docs/deploy-to-kubernetes/add-kubernetes-cluster/)
259
-
namespace|optional|Target Kubernetes namespace to deploy to
260
-
primary_helm_context |optional |Required for `install` and `push` actions when the pipeline has multiple Helm contexts. The Helm context to use for the Helm command. When omitted, the repo most recently added to the pipeline is used.
261
-
release_name|used for `install`|The Helm release name. If the release exists, it is upgraded.
262
-
repos|optional|array of custom repositories
263
-
set_file | optional | Set values from the respective files specified by the command line in `key=value` format. To specify multiple key-value pairs, separate them with commas.
tiller_namespace|optional|Kubernetes namespace where Tiller is installed (unnecessary for Helm 3).
266
-
timeout | optional | The maximum time, in seconds, to wait for Kubernetes commands to complete.
267
-
use_debian_image | optional | Use Debian-based `cfstep-helm` image.
268
-
use_repos_for_auth_action |optional | Required for the `auth` action to use repos from attached contexts. When required, set value to `true`.
269
-
wait |optional | When specified, waits until all pods are in state `ready` to mark the release as successful. Otherwise, release is marked as successful when the minimum number of pods are `ready` and the Services have IP addresses.
244
+
{: .table .table-bordered .table-hover}
245
+
|Name|Required|Description|
246
+
|---|---|---|
247
+
|action|defaults to `install'|Operation mode:`install`/`push`/`auth`|
248
+
|chart_name|required for install/push|Chart reference to use, adhering to Helm's lookup rules (path to chart folder, or name of packaged chart). There's no need to prefix with `/reponame` if referencing a chart in a repository, this is handled automatically. a.k.a `CHART_NAME` but `CHART_NAME` shouldn't be used anymore. |
249
+
|chart_repo_url|optional|Helm chart repository URL. If a [Helm repository configuration](#step-4-optional---import-the-helm-configuration-in-your-pipeline-definition) is attached to the pipeline, this setting is ignored.|
250
+
|chart_subdir |optional | The subfolder where the chart is located in the JFrog Artifactory Helm repository.|
251
+
|chart_version|optional|Override or set the chart version.|
252
+
|cmd_ps|optional|Command Postscript - this will be appended as is to the generated helm command string. Can be used to set additional parameters supported by the command but not exposed as configuration options.|
253
+
|commands|optional|commands to execute in plugin after auth action|
254
+
|credentials_in_arguments | optional | The username and password credentials to add to the Helm command as arguments. If not added to the Helm command, the credentials are passed in the URL `http(s)://username:password@url`. Should be enabled for JFrog Artifactory Helm repositories.|
255
+
|custom_value_files|optional|values file to provide to Helm as --values or -f.|
256
+
|custom_values|optional|values to provide to Helm as --set.|
257
+
|helm_repository_context | The name of the Helm repository integration configured in Codefresh.|
258
+
|helm_version|optional|version of [cfstep-helm image](https://hub.docker.com/r/codefresh/cfstep-helm/tags).|
259
+
|kube_context|required for install|Kubernetes context to use. The name of the cluster as [configured in Codefresh]({{site.baseurl}}/docs/deploy-to-kubernetes/add-kubernetes-cluster/).|
260
+
|namespace|optional|Target Kubernetes namespace to deploy to.|
261
+
|primary_helm_context |optional |Required for `install` and `push` actions when the pipeline has multiple Helm contexts. The Helm context to use for the Helm command. When omitted, the repo most recently added to the pipeline is used.|
262
+
|release_name|used for `install`|The Helm release name. If the release exists, it is upgraded.|
263
+
|repos|optional|array of custom repositories.|
264
+
|set_file | optional | Set values from the respective files specified by the command line in `key=value` format. To specify multiple key-value pairs, separate them with commas. |
|tiller_namespace|optional|Kubernetes namespace where Tiller is installed .|
267
+
|timeout | optional | The maximum time, in seconds, to wait for Kubernetes commands to complete.|
268
+
|use_debian_image | optional | Use Debian-based `cfstep-helm` image.|
269
+
|use_repos_for_auth_action |optional | Required for the `auth` action to use repos from attached contexts. When required, set value to `true`.|
270
+
wait |optional | When specified, waits until all pods are in state `ready` to mark the release as successful. Otherwise, release is marked as successful when the minimum number of pods are `ready` and the Services have IP addresses. |