From 4ebc9dde0531fd0c8e0411d22da00888114457d8 Mon Sep 17 00:00:00 2001 From: Doug Goldstein Date: Fri, 12 Apr 2024 16:16:14 -0500 Subject: [PATCH] docs: document helm fileParameters / helm-set-file Added documentation for fileParameters in a helm source Application or the --helm-set-file cli option from #2751. Added a note about #13220 so users are aware. #12508 aims to remove this limitation so the warning can probably be removed with that. Signed-off-by: Doug Goldstein --- docs/user-guide/helm.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/user-guide/helm.md b/docs/user-guide/helm.md index c3b6aa0c6e8fa..12c1b1fba48f0 100644 --- a/docs/user-guide/helm.md +++ b/docs/user-guide/helm.md @@ -201,6 +201,28 @@ the result will be param1=value5 The list of parameters seen in the ui is not what is used for resources, rather it is the values/valuesObject merged with parameters (see [this issue](https://github.com/argoproj/argo-cd/issues/9213) incase it has been resolved) As a workaround using parameters instead of values/valuesObject will provide a better overview of what will be used for resources +## Helm --set-file support + +The `--set-file` argument to helm can be used with the following syntax on +the cli: + +```bash +argocd app set helm-guestbook --helm-set-file some.key=path/to/file.ext +``` + +or using the fileParameters for yaml: + +```yaml +source: + helm: + fileParameters: + - name: some.key + value: path/to/file.ext +``` + +!!! warning "Multiple sources not supported" + Please note that using a multiple sources application will not let you load the file by reference. See [argoproj/argo-cd#13220](https://github.com/argoproj/argo-cd/issues/13220) + ## Helm Release Name By default, the Helm release name is equal to the Application name to which it belongs. Sometimes, especially on a centralised Argo CD,