Skip to content

Commit 6020ec2

Browse files
Update docs to match master
1 parent 4b86841 commit 6020ec2

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

stable/helm/README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Codefresh Helm Plugin
22

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.
44

55
## Usage
66

@@ -25,12 +25,35 @@ steps:
2525

2626
- **required** `CHART_NAME` - Helm chart name
2727
- **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
2929
- `NAMESPACE` - target Kubernetes namespace
3030
- `CHART_VERSION` - application chart version to install
3131
- `CHART_REPO_URL` - Helm chart repository URL
3232
- `DRY_RUN` - do a "dry run" installation (do not install anything, useful for Debug)
3333
- `DEBUG` - print verbose install output
3434
- `WAIT` - block step execution till installation completed and all Kubernetes resources are ready
3535
- `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`.
36+
37+
### Overriding Helm Variables
38+
39+
Codefresh Helm plugin supports overriding Helm variables.
40+
41+
#### Naming Guide
42+
43+
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

Comments
 (0)