Skip to content

Commit

Permalink
docs: Update documentation regarding Git write-back
Browse files Browse the repository at this point in the history
  • Loading branch information
jannfis committed Mar 20, 2021
1 parent 0f64255 commit fa5e4f2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 20 deletions.
5 changes: 3 additions & 2 deletions docs/configuration/applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,9 @@ This method is the default and requires no further configuration.
### Using the Git write-back method

!!!warning "Compatibility with Argo CD"
The Git write-back method requires a feature in Argo CD that is not yet
GA and will be released with Argo CD v1.9.
The Git write-back method requires a feature in Argo CD that has been
introduced with Argo CD v2.0. Git write-back will not work with earlier
versions of Argo CD.

The `git` write-back method uses Git to permanently store its parameter
overrides along with the Application's resource manifests. This will enable
Expand Down
18 changes: 0 additions & 18 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,21 +83,3 @@ Otherwise, current known limitations are:
Image Updater is running in (or has access to). It is currently not possible
to fetch those secrets from other clusters.

## A short note about Git and write-back

In its current incarnation, Argo CD Image Updater does not write back any of
the changes to a Git repo. We are investigating ways to implement this much
requested feature, but this will still take some time. We know how important
this feature is for the community.

However, as Argo CD Image Updater leverages the Argo CD API, consider that the
changes that are made by Argo CD Image Updater only affect the Argo CD
`Application` resource. More precisely, it will update the `Application`
resource's `Spec` to modify application parameters. Whenever Argo CD renders
the application's resources' manifests, it will take the parameters in the
application's spec into the consideration and replace any container image
references to the values stored in the `Application` spec.

As long as your `Application` resource does not live in Git (i.e. you have
created the application using the Web UI or via `argocd app create ...` using
the CLI), there will be no benefit what so ever from writing to Git.

0 comments on commit fa5e4f2

Please sign in to comment.