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: stable/helm/README.md
+26-3Lines changed: 26 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Codefresh Helm Plugin
2
2
3
-
Use Codefresh [Helm](https://helm.sh) plugin to deploy a Helm chart into specified (by context) Kubernetes cluster.
3
+
Use Codefresh [Helm](https://helm.sh) plugin to deploy a Helm chart into specified (by context) Kubernetes cluster.
4
4
5
5
## Usage
6
6
@@ -25,12 +25,35 @@ steps:
25
25
26
26
-**required**`CHART_NAME` - Helm chart name
27
27
-**required**`RELEASE_NAME` - Helm release name
28
-
-**required**`KUBE_CONTEXT` - Kubernetes context to use (cluster name from Codefresh-Kubernetes integration)
28
+
-**required**`KUBE_CONTEXT` - Kubernetes context to use
29
29
-`NAMESPACE` - target Kubernetes namespace
30
30
-`CHART_VERSION` - application chart version to install
31
31
-`CHART_REPO_URL` - Helm chart repository URL
32
32
-`DRY_RUN` - do a "dry run" installation (do not install anything, useful for Debug)
33
33
-`DEBUG` - print verbose install output
34
34
-`WAIT` - block step execution till installation completed and all Kubernetes resources are ready
35
35
-`TIMEOUT` - wait timeout (5min by default)
36
-
-`custom_var_name` - override helm variables with new values. For example, if you have a variable `image.tag` to override the variable would be `custom_image_tag`.
Prefix environment variable with `custom_` (or `CUSTOM_`) and replace any `.` character with `_`.
44
+
45
+
```text
46
+
# set ENV variable in Codefresh UI
47
+
custom_myimage_pullPolicy=Always
48
+
# Codefresh Helm plugin will add option below to the 'helm update --install' command
49
+
--set myimage.pullPolicy=Always
50
+
51
+
# Another example
52
+
CUSTOM_redis_resources_requests_memory=256Mi
53
+
# translates to ...
54
+
--set redis.resources.requests.memory=256Mi
55
+
```
56
+
57
+
## Kubernetes Configuration
58
+
59
+
Add Kubernetes integration to Codefresh: `> Account Settings > Integration > Kubernetes`. From now on, you can use added Kubernetes cluster in Codefresh pipeline, addressing its context by the name you see in `Clusters` menu.
0 commit comments