Add ability to override kanister-tools image in repo controller (#2261)

* Add a helper to get kanister-tools-image from env

* Add helm fields for overriding tools image

* Use env image if set for repo server pod

* Set KANISTER_TOOLS env in repo controller tests

* Reuse consts helper in other functions

* Add quotes to include

---------

Co-authored-by: kale-amruta <41624751+kale-amruta@users.noreply.github.com>

helm/kanister-operator/templates/_helpers.tpl

@@ -83,3 +83,10 @@ on the value of bpValidatingWebhook.enabled
     {{ .Values.controller.service.insecuredPort }}
 {{- end -}}
 {{- end -}}
+
+{{/*
+Define a custom kanister-tools image
+*/}}
+{{- define "kanister-tools.image" -}}
+    {{- printf "%s:%s" (.Values.kanisterToolsImage.image) (.Values.kanisterToolsImage.tag) -}}
+{{- end -}}

helm/kanister-operator/templates/deployment.yaml

@@ -58,6 +58,10 @@ spec:
           value: {{ .Values.repositoryServerController.logLevel }}
         - name: CREATEORUPDATE_CRDS
           value: {{ .Values.controller.updateCRDs | quote }}
+{{- if .Values.kanisterToolsImage.override }}
+        - name: KANISTER_TOOLS
+          value: {{ include "kanister-tools.image" . }}
+{{- end }}
 {{- if .Values.resources }}
         resources:
 {{ toYaml .Values.resources | indent 12 }}

helm/kanister-operator/values.yaml

@@ -10,6 +10,10 @@ repositoryServerControllerImage:
   name: repo-server-controller
   tag: 0.93.0
   pullPolicy: IfNotPresent
+kanisterToolsImage:
+  override: false
+  image: ghcr.io/kanisterio/kanister-tools
+  tag: 0.93.0
 rbac:
   create: true
 serviceAccount:

pkg/consts/consts.go

@@ -1,3 +1,17 @@
+// Copyright 2023 The Kanister Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package consts
 
 const (
@@ -30,3 +44,6 @@ const RepositoryServerResourceNamePlural = "repositoryservers"
 
 const LatestKanisterToolsImage = "ghcr.io/kanisterio/kanister-tools:v9.99.9-dev"
 const KanisterToolsImage = "ghcr.io/kanisterio/kanister-tools:0.93.0"
+
+// KanisterToolsImageEnvName is used to set up a custom kanister-tools image
+const KanisterToolsImageEnvName = "KANISTER_TOOLS"

pkg/consts/utils.go

@@ -0,0 +1,27 @@
+// Copyright 2023 The Kanister Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package consts
+
+import "os"
+
+// GetKanisterToolsImage returns the KanisterTools image
+// Returns the value of the KANISTER_TOOLS env if set
+// Otherwise, returns the default released version.
+func GetKanisterToolsImage() string {
+	if val, ok := os.LookupEnv(KanisterToolsImageEnvName); ok {
+		return val
+	}
+	return KanisterToolsImage
+}

pkg/controllers/repositoryserver/repositoryserver_controller_test.go

@@ -140,6 +140,8 @@ func (s *RepoServerControllerSuite) SetUpSuite(c *C) {
 		// We need to set this up since we are not creating controller in a pod
 		os.Setenv("HOSTNAME", controllerPodName)
 		os.Setenv("POD_SERVICE_ACCOUNT", defaultServiceAccount)
+		// Set KANISTER_TOOLS env to override and use dev image
+		os.Setenv(consts.KanisterToolsImageEnvName, consts.LatestKanisterToolsImage)
 		err = mgr.Start(ctx)
 		c.Assert(err, IsNil)
 	}(ctx)
@@ -447,7 +449,7 @@ func (s *RepoServerControllerSuite) waitForRepoServerInfoUpdateInCR(repoServerNa
 }
 
 func (s *RepoServerControllerSuite) waitOnRepositoryServerState(c *C, reposerverName string) (v1alpha1.RepositoryServerProgress, error) {
-	ctxTimeout := 15 * time.Minute
+	ctxTimeout := 5 * time.Minute
 	ctx, cancel := context.WithTimeout(context.Background(), ctxTimeout)
 	defer cancel()
 	var repoServerState v1alpha1.RepositoryServerProgress
@@ -517,6 +519,8 @@ func getTestKanisterToolsPod(podName string) (pod *v1.Pod) {
 }
 
 func (s *RepoServerControllerSuite) TearDownSuite(c *C) {
+	err := os.Unsetenv(consts.KanisterToolsImageEnvName)
+	c.Assert(err, IsNil)
 	if s.repoServerControllerNamespace != "" {
 		err := s.kubeCli.CoreV1().Namespaces().Delete(context.TODO(), s.repoServerControllerNamespace, metav1.DeleteOptions{})
 		c.Assert(err, IsNil)

pkg/controllers/repositoryserver/utils.go

@@ -205,7 +205,7 @@ func getPodOptions(namespace string, podOverride map[string]interface{}, svc *co
 	return &kube.PodOptions{
 		Namespace:     namespace,
 		GenerateName:  fmt.Sprintf("%s-", repoServerPod),
-		Image:         consts.KanisterToolsImage,
+		Image:         consts.GetKanisterToolsImage(),
 		ContainerName: repoServerPodContainerName,
 		Command:       []string{"bash", "-c", "tail -f /dev/null"},
 		PodOverride:   podOverride,

pkg/function/backup_data_stats.go

@@ -23,6 +23,7 @@ import (
 
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
+	"github.com/kanisterio/kanister/pkg/consts"
 	"github.com/kanisterio/kanister/pkg/format"
 	"github.com/kanisterio/kanister/pkg/kube"
 	"github.com/kanisterio/kanister/pkg/param"
@@ -65,7 +66,7 @@ func backupDataStats(ctx context.Context, cli kubernetes.Interface, tp param.Tem
 	options := &kube.PodOptions{
 		Namespace:    namespace,
 		GenerateName: jobPrefix,
-		Image:        getKanisterToolsImage(),
+		Image:        consts.GetKanisterToolsImage(),
 		Command:      []string{"sh", "-c", "tail -f /dev/null"},
 		PodOverride:  podOverride,
 	}

pkg/function/checkRepository.go

@@ -10,6 +10,7 @@ import (
 
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
+	"github.com/kanisterio/kanister/pkg/consts"
 	"github.com/kanisterio/kanister/pkg/kube"
 	"github.com/kanisterio/kanister/pkg/param"
 	"github.com/kanisterio/kanister/pkg/restic"
@@ -49,7 +50,7 @@ func CheckRepository(ctx context.Context, cli kubernetes.Interface, tp param.Tem
 	options := &kube.PodOptions{
 		Namespace:    namespace,
 		GenerateName: jobPrefix,
-		Image:        getKanisterToolsImage(),
+		Image:        consts.GetKanisterToolsImage(),
 		Command:      []string{"sh", "-c", "tail -f /dev/null"},
 		PodOverride:  podOverride,
 	}

pkg/function/copy_volume_data.go

@@ -25,6 +25,7 @@ import (
 	"k8s.io/client-go/kubernetes"
 
 	kanister "github.com/kanisterio/kanister/pkg"
+	"github.com/kanisterio/kanister/pkg/consts"
 	"github.com/kanisterio/kanister/pkg/format"
 	"github.com/kanisterio/kanister/pkg/kube"
 	"github.com/kanisterio/kanister/pkg/log"
@@ -73,7 +74,7 @@ func copyVolumeData(ctx context.Context, cli kubernetes.Interface, tp param.Temp
 	options := &kube.PodOptions{
 		Namespace:    namespace,
 		GenerateName: CopyVolumeDataJobPrefix,
-		Image:        getKanisterToolsImage(),
+		Image:        consts.GetKanisterToolsImage(),
 		Command:      []string{"sh", "-c", "tail -f /dev/null"},
 		Volumes:      map[string]string{pvc: mountPoint},
 		PodOverride:  podOverride,

pkg/function/delete_data.go

@@ -25,6 +25,7 @@ import (
 
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
+	"github.com/kanisterio/kanister/pkg/consts"
 	"github.com/kanisterio/kanister/pkg/format"
 	"github.com/kanisterio/kanister/pkg/kube"
 	"github.com/kanisterio/kanister/pkg/param"
@@ -69,7 +70,7 @@ func deleteData(ctx context.Context, cli kubernetes.Interface, tp param.Template
 	options := &kube.PodOptions{
 		Namespace:    namespace,
 		GenerateName: jobPrefix,
-		Image:        getKanisterToolsImage(),
+		Image:        consts.GetKanisterToolsImage(),
 		Command:      []string{"sh", "-c", "tail -f /dev/null"},
 		PodOverride:  podOverride,
 	}

pkg/function/describe_backups.go

@@ -24,6 +24,7 @@ import (
 
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
+	"github.com/kanisterio/kanister/pkg/consts"
 	"github.com/kanisterio/kanister/pkg/format"
 	"github.com/kanisterio/kanister/pkg/kube"
 	"github.com/kanisterio/kanister/pkg/param"
@@ -67,7 +68,7 @@ func describeBackups(ctx context.Context, cli kubernetes.Interface, tp param.Tem
 	options := &kube.PodOptions{
 		Namespace:    namespace,
 		GenerateName: jobPrefix,
-		Image:        getKanisterToolsImage(),
+		Image:        consts.GetKanisterToolsImage(),
 		Command:      []string{"sh", "-c", "tail -f /dev/null"},
 		PodOverride:  podOverride,
 	}

pkg/function/utils.go

@@ -3,7 +3,6 @@ package function
 import (
 	"bytes"
 	"context"
-	"os"
 	"path"
 	"strings"
 
@@ -27,18 +26,9 @@ import (
 
 const (
 	// FunctionOutputVersion returns version
-	FunctionOutputVersion     = "version"
-	kanisterToolsImage        = "ghcr.io/kanisterio/kanister-tools:0.93.0"
-	kanisterToolsImageEnvName = "KANISTER_TOOLS"
+	FunctionOutputVersion = "version"
 )
 
-func getKanisterToolsImage() string {
-	if val, ok := os.LookupEnv(kanisterToolsImageEnvName); ok {
-		return val
-	}
-	return kanisterToolsImage
-}
-
 // ValidateCredentials verifies if the given credentials have appropriate values set
 func ValidateCredentials(creds *param.Credential) error {
 	if creds == nil {