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
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ Once you have Helm repositories connected to Codefresh, you can import one or mo
71
71
72
72
1. Click the**Variables** tab on the right sidebar, and then click the**Settings** (gear) icon.
73
73
1. Click**Import from shared configuration**, and select the Helm context or contexts to import into the pipeline:
74
-
* To import a single context,whichis thegeneral requirement, select the`CF_HELM_DEFAULT`[shared configuration]({{site.baseurl}}/docs/configure-ci-cd-pipeline/shared-configuration/).
74
+
* To import a single context,select the context. The`CF_HELM_DEFAULT`is thedefault Helm rep provided by Codefresh. See also[shared configuration]({{site.baseurl}}/docs/configure-ci-cd-pipeline/shared-configuration/).
75
75
* To import multiple contexts, select each context to import.
76
76
77
77
{% include image.html
@@ -119,12 +119,16 @@ The Helm step can operate in one of three modes:
119
119
120
120
1. install: Installs the Helm chart into a Kubernetes cluster. This is the default mode, if a mode is not explicitly set.
121
121
1. push: Packages the Helm chart and pushes it to the repository.
122
-
1. authentication only: Only setsup authentication and addsthe repoto the helm. This is useful if you want to write your own helm commands using the freestyle step's`commands` property, but you still want the step to handle authentication.
122
+
1. authentication: Setsup authentication, and addsone or more reposto the helm. This is useful if you want to write your own helm commands using the freestyle step's`commands` property, but you still want the step to handle authentication.
123
123
124
124
The operation mode is set by the `action` field, where the value can be `install`/`push`/`auth`.
125
125
126
-
If you have imported multiple Helm contexts into the same pipeline, for the `install` and `push` actions you need to define the primary Helm context to use through the `primary_helm_context` argument.
127
-
For the `auth` action, if the chart has dependencies on other repos, then to authenticate the referenced repos, you need to add `use_repos_for_auth_action:'true'`.
126
+
**Multiple Helm contexts for pipeline**
127
+
128
+
If you have imported multiple Helm contexts into the same pipeline:
129
+
* For the `install` and `push` actions, you need to define the primary Helm context to use through the `primary_helm_context` argument.
130
+
* For the `auth` action, to use the repos from the helm contexts imported into the pipeline, add `use_repos_for_auth_action: 'true'`. Otherwise, imported contexts, if any, are ignored for the `auth` action.
131
+
128
132
For a description of these and other arguments, see [Configuration](#configuration).
129
133
130
134
@@ -253,15 +257,15 @@ helm_repository_context | The name of the Helm repository integration configured
253
257
helm_version|optional|version of [cfstep-helm image](https://hub.docker.com/r/codefresh/cfstep-helm/tags)
254
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/)
255
259
namespace|optional|Target Kubernetes namespace to deploy to
256
-
primary_helm_context |requiredfor `install` and `push` actions |The Helm context to use for the Helm command when the pipeline has multiple Helm contexts. When omitted, the repo most recently added to the pipeline is used.
257
-
release_name|required for `install`|Helm release name. If the release exists, itwill beupgraded
260
+
primary_helm_context |optional |Requiredfor `install` and `push` actionswhen 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`|TheHelm release name. If the release exists, itisupgraded.
258
262
repos|optional|array of custom repositories
259
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)
262
266
timeout | optional | The maximum time, in seconds, to wait for Kubernetes commands to complete.
263
267
use_debian_image | optional | Use Debian-based `cfstep-helm` image.
264
-
use_repos_for_auth_action |optional | Requiredif thechart has dependencies on otherreposthat need to be authenticated. Set `true`.
268
+
use_repos_for_auth_action |optional | Requiredfor the`auth` action to usereposfrom attached contexts. When required, set value to `true`.
265
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.