summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjannfis <jann@mistrust.net>2020-08-11 17:11:07 +0200
committerGitHub <noreply@github.com>2020-08-11 17:11:07 +0200
commit94f940dc10eeabf297faaf5385fceffb81f5acd7 (patch)
tree5e35e59cbdd64b5ef6163b62e189171e5ccc210b
parentb6ea6a9d639cb177b92ff1a105a06dc37490bb87 (diff)
docs: Update README for some clarifications (#36)
* docs: Update README with some clarifications * More updates
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index b5dd050..d07a1da 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,10 @@
## Introduction
Argo CD Image Updater is a tool to automatically update the container
-images of Kubernetes workloads which are managed by Argo CD.
+images of Kubernetes workloads which are managed by Argo CD. In a nutshell,
+it will track image versions specified by annotations on the Argo CD
+Application resources and update them by setting parameter overrides using
+the Argo CD API.
Currently it will only work with applications that are built using *Kustomize*
or *Helm* tooling. Applications built from plain YAML or custom tools are not
@@ -67,11 +70,13 @@ Also, if you want to contribute code, please make sure that your code
## Things that are planned (roadmap)
-The following things are on the roadmap until the `v1.0` release.
+The following things are on the roadmap until the `v1.0` release
* Extend Argo CD functionality to be able to update images for other types of
applications.
+* Extend Argo CD functionality to write back to Git
+
* Provide web hook support to trigger update check for a given image
* Use concurrency for updating multiple applications at once
@@ -91,7 +96,8 @@ No, and this feature is also not planned for any of the next releases. We think
it's close to impossible to get such a feature 100% correctly working, because
there are so many edge-cases to consider (i.e. possible merge conflicts) and
there's no easy way to find out where a certain resource lives in Git when
-manifests are rendered through a tool.
+manifests are rendered through a tool. We are thinking about how to implement
+this feature in the meanwhile, but don't expect it before the v1.0 release.
**How does it persist the changes then?**