allow image updates to be forced if container not present #181

docs/configuration/images.md

@@ -61,6 +61,21 @@ of the [Semver library](https://github.com/Masterminds/semver) we're using.
     [filtering tags](#filtering-tags)
     below.
 
+
+### Forcing Image Updates
+
+By default, Image Updater will only update an image that is actually used in your Application
+(i.e., is it exported in the Status of your ArgoCD Application.)
+
+To support custom resources and things like PodTemplates that don't actually create a container, 
+you may force an update:
+
+```yaml
+argocd-image-updater.argoproj.io/image-list: myalias=some/image
+argocd-image-updater.argoproj.io/myalias.force-update: "true"
+```
+
+
 ## Assigning aliases to images
 
 It's possible (and sometimes necessary) to assign an alias name to any given

pkg/argocd/argocd.go

@@ -172,21 +172,26 @@ func FilterApplicationsForUpdate(apps []v1alpha1.Application, patterns []string)
 			continue
 		} else {
 			log.Tracef("processing app '%s' of type '%v'", app.GetName(), app.Status.SourceType)
-			imageList := make(image.ContainerImageList, 0)
-			for _, imageName := range strings.Split(updateImage, ",") {
-				allowed := image.NewFromIdentifier(strings.TrimSpace(imageName))
-				imageList = append(imageList, allowed)
-			}
+			imageList := parseImageList(updateImage)
 			appImages := ApplicationImages{}
 			appImages.Application = app
-			appImages.Images = imageList
+			appImages.Images = *imageList
 			appsForUpdate[app.GetName()] = appImages
 		}
 	}
 
 	return appsForUpdate, nil
 }
 
+func parseImageList(updateImage string) *image.ContainerImageList {
+	splits := strings.Split(updateImage, ",")
+	results := make(image.ContainerImageList, len(splits))
+	for i, s := range splits {
+		results[i] = image.NewFromIdentifier(strings.TrimSpace(s))
+	}
+	return &results
+}
+
 // GetApplication gets the application named appName from Argo CD API
 func (client *argoCD) GetApplication(ctx context.Context, appName string) (*v1alpha1.Application, error) {
 	conn, appClient, err := client.Client.NewApplicationClient()
@@ -417,6 +422,19 @@ func GetImagesFromApplication(app *v1alpha1.Application) image.ContainerImageLis
 		images = append(images, image)
 	}
 
+	// The Application may wish to update images that don't create a container we can detect.
+	// Check the image list for images with a force-update annotation, and add them if they are not already present.
+	annotations := app.Annotations
+	if updateImage, ok := annotations[common.ImageUpdaterAnnotation]; ok {
+		for _, img := range *parseImageList(updateImage) {
+			if forceStr, force := annotations[fmt.Sprintf(common.ForceUpdateOptionAnnotation, img.ImageAlias)]; force && strings.ToLower(forceStr) == "true" {
+				if images.ContainsImage(img, false) == nil {
+					images = append(images, img)
+				}
+			}
+		}
+	}
+
 	return images
 }
 

pkg/argocd/argocd_test.go

@@ -56,6 +56,26 @@ func Test_GetImagesFromApplication(t *testing.T) {
 		imageList := GetImagesFromApplication(application)
 		assert.Empty(t, imageList)
 	})
+
+	t.Run("Get list of images from application that has force-update", func(t *testing.T) {
+		application := &v1alpha1.Application{
+			ObjectMeta: v1.ObjectMeta{
+				Name:      "test-app",
+				Namespace: "argocd",
+				Annotations: map[string]string{
+					fmt.Sprintf(common.ForceUpdateOptionAnnotation, "nginx"): "true",
+					common.ImageUpdaterAnnotation:                            "nginx=nginx",
+				},
+			},
+			Spec: v1alpha1.ApplicationSpec{},
+			Status: v1alpha1.ApplicationStatus{
+				Summary: v1alpha1.ApplicationSummary{},
+			},
+		}
+		imageList := GetImagesFromApplication(application)
+		require.Len(t, imageList, 1)
+		assert.Equal(t, "nginx", imageList[0].ImageName)
+	})
 }
 
 func Test_GetApplicationType(t *testing.T) {
@@ -702,3 +722,10 @@ func TestKubernetesClient_UpdateSpec_Conflict(t *testing.T) {
 
 	assert.Equal(t, "https://github.com/argoproj/argocd-example-apps", spec.Source.RepoURL)
 }
+
+func Test_parseImageList(t *testing.T) {
+	assert.Equal(t, []string{"foo", "bar"}, parseImageList(" foo, bar ").Originals())
+	// should whitespace inside the spec be preserved?
+	assert.Equal(t, []string{"foo", "bar", "baz = qux"}, parseImageList(" foo, bar,baz = qux ").Originals())
+	assert.Equal(t, []string{"foo", "bar", "baz=qux"}, parseImageList("foo,bar,baz=qux").Originals())
+}

pkg/common/constants.go

@@ -28,10 +28,11 @@ const (
 
 // Upgrade strategy related annotations
 const (
-	OldMatchOptionAnnotation   = ImageUpdaterAnnotationPrefix + "/%s.tag-match" // Deprecated and will be removed
-	AllowTagsOptionAnnotation  = ImageUpdaterAnnotationPrefix + "/%s.allow-tags"
-	IgnoreTagsOptionAnnotation = ImageUpdaterAnnotationPrefix + "/%s.ignore-tags"
-	UpdateStrategyAnnotation   = ImageUpdaterAnnotationPrefix + "/%s.update-strategy"
+	OldMatchOptionAnnotation    = ImageUpdaterAnnotationPrefix + "/%s.tag-match" // Deprecated and will be removed
+	AllowTagsOptionAnnotation   = ImageUpdaterAnnotationPrefix + "/%s.allow-tags"
+	IgnoreTagsOptionAnnotation  = ImageUpdaterAnnotationPrefix + "/%s.ignore-tags"
+	ForceUpdateOptionAnnotation = ImageUpdaterAnnotationPrefix + "/%s.force-update"
+	UpdateStrategyAnnotation    = ImageUpdaterAnnotationPrefix + "/%s.update-strategy"
 )
 
 // Image pull secret related annotations

pkg/image/image.go

@@ -103,6 +103,14 @@ func (list *ContainerImageList) ContainsImage(img *ContainerImage, checkVersion
 	return nil
 }
 
+func (list *ContainerImageList) Originals() []string {
+	results := make([]string, len(*list))
+	for i, img := range *list {
+		results[i] = img.Original()
+	}
+	return results
+}
+
 // String Returns the name of all images as a string, separated using comma
 func (list *ContainerImageList) String() string {
 	imgNameList := make([]string, 0)