diff options
| author | noah <noah@hackedu.io> | 2021-05-11 20:17:38 +1200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-11 10:17:38 +0200 |
| commit | add387ecfa5c59b34119eabd8b81c1daddcdc06e (patch) | |
| tree | baa5d5c63641505ac16aa849316b85e1bf741190 /docs | |
| parent | b47f7e961649acf4c9e7c98d575284a143707ce8 (diff) | |
feat: allow write-back to actual kustomization files (#200)
* feat: allow write-back to actual kustomization files #199
* fix: was not handling default path correctly
default is the source path
* fix: sort imports
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/applications.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/configuration/applications.md b/docs/configuration/applications.md index a53cfb8..00cd442 100644 --- a/docs/configuration/applications.md +++ b/docs/configuration/applications.md @@ -257,3 +257,32 @@ In order to test a template before configuring it for use in Image Updater, you can store the template you want to use in a temporary file, and then use the `argocd-image-updater template /path/to/file` command to render the template using pre-defined data and see its outcome on the terminal. + +#### Git Write-Back Target + +By default, git write-back will create or update `.argocd-source-<appName>.yaml`. + +If you are using Kustomize and want the image updates available for normal use with `kustomize`, +you may set the `write-back-target` to `kustomization`. This method commits changes to the Kustomization +file back to git as though you ran `kustomize edit set image`. + +```yaml +argocd-image-updater.argoproj.io/write-back-method: git # all git options are supported +argocd-image-updater.argoproj.io/write-back-target: kustomization +``` + +You may also specify which kustomization to update with either a path relative to the project source path... + +```yaml +argocd-image-updater.argoproj.io/write-back-target: "kustomization:../../base" +# if the Application spec.source.path = config/overlays/foo, this would update the kustomization in config/base +``` + +...or absolute with respect to the repository: + +```yaml +# absolute paths start with / +argocd-image-updater.argoproj.io/write-back-target: "kustomization:/config/overlays/bar" +``` + +Note that the Kustomization directory needs to be specified, not a file, like when using Kustomize. |
