feat: support runtime configuration of init container image (#1586)

drivebyer · web-flow · commit 9971e8aefc00 · 2025-11-06T09:18:19.000+08:00
* feat: support runtime configuration of init container image

  This change provides better flexibility for managing operator and init
  container versions independently without breaking existing configurations.

Signed-off-by: drivebyer &lt;wuyangmuc@gmail.com&gt;

* remove comment

Signed-off-by: drivebyer &lt;wuyangmuc@gmail.com&gt;

* update

Signed-off-by: drivebyer &lt;wuyangmuc@gmail.com&gt;

---------

Signed-off-by: drivebyer &lt;wuyangmuc@gmail.com&gt;
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -260,7 +260,7 @@ jobs:
       - name: Install Redis Operator
         run: |
           make deploy IMG=redis-operator:e2e
-          kubectl set env deployment/redis-operator-redis-operator -n redis-operator-system OPERATOR_IMAGE=redis-operator:e2e FEATURE_GATES=GenerateConfigInInitContainer=true MAX_CONCURRENT_RECONCILES=10
+          kubectl set env deployment/redis-operator-redis-operator -n redis-operator-system INIT_CONTAINER_IMAGE=redis-operator:e2e FEATURE_GATES=GenerateConfigInInitContainer=true MAX_CONCURRENT_RECONCILES=10
 
       - name: Wait for Redis Operator to be ready
         run: |
diff --git a/Dockerfile b/Dockerfile
@@ -25,7 +25,7 @@ COPY internal/ internal/
 COPY mocks/ mocks/
 
 # Build
-ARG LDFLAGS="-s -w -X github.com/OT-CONTAINER-KIT/redis-operator/internal/image.operatorImage=${IMG}"
+ARG LDFLAGS="-s -w"
 ENV GOOS=$TARGETOS
 ENV GOARCH=$TARGETARCH
 ENV CGO_ENABLED=0
diff --git a/Makefile b/Makefile
@@ -21,7 +21,7 @@ CONTAINER_ENGINE ?= docker
 PLATFORMS = "linux/arm64,linux/amd64"
 
 # LDFLAGS for setting the operator image during build
-LDFLAGS ?= "-s -w -X github.com/OT-CONTAINER-KIT/redis-operator/internal/image.operatorImage=$(IMG)"
+LDFLAGS ?= "-s -w"
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
diff --git a/charts/redis-operator/README.md b/charts/redis-operator/README.md
@@ -115,6 +115,7 @@ kubectl create secret tls <webhook-server-cert> --key tls.key --cert tls.crt -n
 | redisOperator.imagePullPolicy | string | `"Always"` |  |
 | redisOperator.imagePullSecrets | list | `[]` |  |
 | redisOperator.imageTag | string | `""` |  |
+| redisOperator.initContainerImageTag | string | `"v0.22.2"` | initContainerImageTag is the init-config init container image tag. If not specified, defaults to imageTag, then falls back to chart appVersion. Typically only needs to be set when using a different version for the init container. |
 | redisOperator.metrics.bindAddress | string | `":8080"` |  |
 | redisOperator.metrics.enabled | bool | `true` |  |
 | redisOperator.name | string | `"redis-operator"` |  |
diff --git a/charts/redis-operator/templates/operator-deployment.yaml b/charts/redis-operator/templates/operator-deployment.yaml
@@ -86,8 +86,8 @@ spec:
           readOnly: true
       {{- end }}
         env:
-        - name: OPERATOR_IMAGE
-          value: {{ .Values.redisOperator.imageName }}:{{ .Values.redisOperator.imageTag | default (printf "v%s" .Chart.AppVersion) }}
+        - name: INIT_CONTAINER_IMAGE
+          value: {{ .Values.redisOperator.imageName }}:{{ .Values.redisOperator.initContainerImageTag | default .Values.redisOperator.imageTag | default (printf "v%s" .Chart.AppVersion) }}
         - name: ENABLE_WEBHOOKS
           value: {{ .Values.redisOperator.webhook | quote }}
         {{- if .Values.redisOperator.watchNamespace }}
diff --git a/charts/redis-operator/values.yaml b/charts/redis-operator/values.yaml
@@ -4,6 +4,10 @@ redisOperator:
   imageName: quay.io/opstree/redis-operator
   # Overrides the image tag whose default is the chart appVersion.
   imageTag: ""
+  # -- initContainerImageTag is the init-config init container image tag.
+  # If not specified, defaults to imageTag, then falls back to chart appVersion.
+  # Typically only needs to be set when using a different version for the init container.
+  initContainerImageTag: "v0.22.2"
   imagePullPolicy: Always
   imagePullSecrets: []
 
diff --git a/internal/cmd/manager/cmd.go b/internal/cmd/manager/cmd.go
@@ -32,7 +32,7 @@ import (
 	redisreplicationcontroller "github.com/OT-CONTAINER-KIT/redis-operator/internal/controller/redisreplication"
 	redissentinelcontroller "github.com/OT-CONTAINER-KIT/redis-operator/internal/controller/redissentinel"
 	intctrlutil "github.com/OT-CONTAINER-KIT/redis-operator/internal/controllerutil"
-	internalenv "github.com/OT-CONTAINER-KIT/redis-operator/internal/env"
+	"github.com/OT-CONTAINER-KIT/redis-operator/internal/envs"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/features"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/k8sutils"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/monitoring"
@@ -95,9 +95,9 @@ func addFlags(cmd *cobra.Command, opts *managerOptions) {
 	cmd.Flags().StringVar(&opts.probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
 	cmd.Flags().StringVar(&opts.pprofAddr, "pprof-bind-address", "", "The address the pprof endpoint binds to. If empty, pprof is disabled. Example: ':6060'")
 	cmd.Flags().BoolVar(&opts.enableLeaderElection, "leader-elect", false, "Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager.")
-	cmd.Flags().BoolVar(&opts.enableWebhooks, "enable-webhooks", internalenv.IsWebhookEnabled(), "Enable webhooks")
+	cmd.Flags().BoolVar(&opts.enableWebhooks, "enable-webhooks", envs.IsWebhookEnabled(), "Enable webhooks")
 	cmd.Flags().IntVar(&opts.maxConcurrentReconciles, "max-concurrent-reconciles", 1, "Max concurrent reconciles")
-	cmd.Flags().StringVar(&opts.featureGatesString, "feature-gates", internalenv.GetFeatureGates(), "A set of key=value pairs that describe feature gates for alpha/experimental features. "+
+	cmd.Flags().StringVar(&opts.featureGatesString, "feature-gates", envs.GetFeatureGates(), "A set of key=value pairs that describe feature gates for alpha/experimental features. "+
 		"Options are:\n  GenerateConfigInInitContainer=true|false: enables using init container for config generation")
 	cmd.Flags().Duration(
 		operator.KubeClientTimeoutMGRFlag,
@@ -200,7 +200,7 @@ func createControllerOptions(opts *managerOptions) ctrl.Options {
 		options.PprofBindAddress = opts.pprofAddr
 	}
 
-	watchNamespaces := internalenv.GetWatchNamespaces()
+	watchNamespaces := envs.GetWatchNamespaces()
 	if len(watchNamespaces) > 0 {
 		options.Cache.DefaultNamespaces = map[string]cache.Config{}
 		for _, ns := range watchNamespaces {
@@ -227,7 +227,7 @@ func createK8sClient() (kubernetes.Interface, error) {
 // setupControllers sets up all controllers
 func setupControllers(mgr ctrl.Manager, k8sClient kubernetes.Interface, maxConcurrentReconciles int) error {
 	// Get max concurrent reconciles from environment
-	maxConcurrentReconciles = internalenv.GetMaxConcurrentReconciles(maxConcurrentReconciles)
+	maxConcurrentReconciles = envs.GetMaxConcurrentReconciles(maxConcurrentReconciles)
 
 	healer := redis.NewHealer(k8sClient)
 
diff --git a/internal/controller/common/redis/heal.go b/internal/controller/common/redis/heal.go
@@ -10,7 +10,7 @@ import (
 	commonapi "github.com/OT-CONTAINER-KIT/redis-operator/api/common/v1beta2"
 	rsvb2 "github.com/OT-CONTAINER-KIT/redis-operator/api/redissentinel/v1beta2"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/controller/common"
-	"github.com/OT-CONTAINER-KIT/redis-operator/internal/env"
+	"github.com/OT-CONTAINER-KIT/redis-operator/internal/envs"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/service/redis"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/util/cryptutil"
 	v1 "k8s.io/api/core/v1"
@@ -255,7 +255,7 @@ func createConnectionInfo(ctx context.Context, pod v1.Pod, password string, tlsC
 	// Configure TLS if enabled
 	if tlsConfig != nil && tlsConfig.Secret.SecretName != "" {
 		serviceName := common.GetHeadlessServiceNameFromPodName(pod.Name)
-		connInfo.Host = fmt.Sprintf("%s.%s.%s.svc.%s", pod.Name, serviceName, namespace, env.GetServiceDNSDomain())
+		connInfo.Host = fmt.Sprintf("%s.%s.%s.svc.%s", pod.Name, serviceName, namespace, envs.GetServiceDNSDomain())
 		// Get TLS configuration
 		tlsCfg := getRedisTLSConfig(ctx, k8sClient, namespace, tlsConfig.Secret.SecretName)
 		connInfo.TLSConfig = tlsCfg
diff --git a/internal/controller/redissentinel/redissentinel_controller.go b/internal/controller/redissentinel/redissentinel_controller.go
@@ -10,7 +10,7 @@ import (
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/controller/common"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/controller/common/redis"
 	intctrlutil "github.com/OT-CONTAINER-KIT/redis-operator/internal/controllerutil"
-	"github.com/OT-CONTAINER-KIT/redis-operator/internal/env"
+	"github.com/OT-CONTAINER-KIT/redis-operator/internal/envs"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/k8sutils"
 	appsv1 "k8s.io/api/apps/v1"
 	"k8s.io/apimachinery/pkg/types"
@@ -133,7 +133,7 @@ func (r *RedisSentinelReconciler) reconcileSentinel(ctx context.Context, instanc
 		return intctrlutil.RequeueE(ctx, err, "")
 	} else {
 		if instance.Spec.RedisSentinelConfig.ResolveHostnames == "yes" {
-			monitorAddr = fmt.Sprintf("%s.%s.%s.svc.%s", master.Name, common.GetHeadlessServiceNameFromPodName(master.Name), rr.Namespace, env.GetServiceDNSDomain())
+			monitorAddr = fmt.Sprintf("%s.%s.%s.svc.%s", master.Name, common.GetHeadlessServiceNameFromPodName(master.Name), rr.Namespace, envs.GetServiceDNSDomain())
 		} else {
 			monitorAddr = master.Status.PodIP
 		}
diff --git a/internal/envs/envs.go b/internal/envs/envs.go
@@ -14,12 +14,13 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package env
+package envs
 
 import (
 	"os"
 	"strconv"
 	"strings"
+	"sync"
 
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/util"
 )
@@ -38,19 +39,30 @@ const (
 	// FeatureGatesEnv defines feature gates for alpha/experimental features
 	FeatureGatesEnv = "FEATURE_GATES"
 
-	// OperatorImageEnv defines the image of the operator
-	OperatorImageEnv = "OPERATOR_IMAGE"
+	// InitContainerImageEnv defines the image used for init containers
+	InitContainerImageEnv = "INIT_CONTAINER_IMAGE"
 
+	// ServiceDNSDomain defines the DNS domain suffix for Kubernetes services
 	ServiceDNSDomain = "SERVICE_DNS_DOMAIN"
 )
 
-func GetServiceDNSDomain() string {
-	return util.Coalesce(os.Getenv(ServiceDNSDomain), "cluster.local")
+var (
+	initContainerImage     string
+	initContainerImageOnce sync.Once
+)
+
+// GetInitContainerImage returns the image to use for init containers.
+func GetInitContainerImage() string {
+	initContainerImageOnce.Do(func() {
+		val := os.Getenv(InitContainerImageEnv)
+		initContainerImage = util.Coalesce(val, "quay.io/opstree/redis-operator:latest")
+	})
+	return initContainerImage
 }
 
-// GetOperatorImage returns the image of the operator
-func GetOperatorImage() string {
-	return os.Getenv(OperatorImageEnv)
+// GetServiceDNSDomain returns the Kubernetes service DNS domain suffix.
+func GetServiceDNSDomain() string {
+	return util.Coalesce(os.Getenv(ServiceDNSDomain), "cluster.local")
 }
 
 // GetWatchNamespaces returns a list of namespaces that the operator should watch
diff --git a/internal/envs/envs_test.go b/internal/envs/envs_test.go
@@ -1,4 +1,4 @@
-package env
+package envs
 
 import (
 	"os"
diff --git a/internal/image/operator_image.go b/internal/image/operator_image.go
diff --git a/internal/k8sutils/redis.go b/internal/k8sutils/redis.go
@@ -15,7 +15,7 @@ import (
 	rcvb2 "github.com/OT-CONTAINER-KIT/redis-operator/api/rediscluster/v1beta2"
 	rrvb2 "github.com/OT-CONTAINER-KIT/redis-operator/api/redisreplication/v1beta2"
 	common "github.com/OT-CONTAINER-KIT/redis-operator/internal/controller/common"
-	"github.com/OT-CONTAINER-KIT/redis-operator/internal/env"
+	"github.com/OT-CONTAINER-KIT/redis-operator/internal/envs"
 	retry "github.com/avast/retry-go"
 	redis "github.com/redis/go-redis/v9"
 	"github.com/samber/lo"
@@ -34,7 +34,7 @@ type RedisDetails struct {
 }
 
 func (rd *RedisDetails) FQDN() string {
-	return fmt.Sprintf("%s.%s.%s.svc.%s", rd.PodName, common.GetHeadlessServiceNameFromPodName(rd.PodName), rd.Namespace, env.GetServiceDNSDomain())
+	return fmt.Sprintf("%s.%s.%s.svc.%s", rd.PodName, common.GetHeadlessServiceNameFromPodName(rd.PodName), rd.Namespace, envs.GetServiceDNSDomain())
 }
 
 func (rd *RedisDetails) String() string {
@@ -693,7 +693,7 @@ func configureRedisReplicationClient(ctx context.Context, client kubernetes.Inte
 }
 
 func getRedisReplicationHostname(redisInfo RedisDetails, cr *rrvb2.RedisReplication) string {
-	return fmt.Sprintf("%s.%s-headless.%s.svc.%s", redisInfo.PodName, cr.Name, cr.Namespace, env.GetServiceDNSDomain())
+	return fmt.Sprintf("%s.%s-headless.%s.svc.%s", redisInfo.PodName, cr.Name, cr.Namespace, envs.GetServiceDNSDomain())
 }
 
 // Get Redis nodes by it's role i.e. master, slave and sentinel
diff --git a/internal/k8sutils/statefulset.go b/internal/k8sutils/statefulset.go
@@ -11,9 +11,8 @@ import (
 	commonapi "github.com/OT-CONTAINER-KIT/redis-operator/api/common/v1beta2"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/consts"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/controller/common"
-	internalenv "github.com/OT-CONTAINER-KIT/redis-operator/internal/env"
+	"github.com/OT-CONTAINER-KIT/redis-operator/internal/envs"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/features"
-	"github.com/OT-CONTAINER-KIT/redis-operator/internal/image"
 	"github.com/OT-CONTAINER-KIT/redis-operator/internal/util"
 	"github.com/banzaicloud/k8s-objectmatcher/patch"
 	"github.com/pkg/errors"
@@ -22,7 +21,6 @@ import (
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes"
-	"k8s.io/utils/env"
 	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
@@ -326,7 +324,7 @@ func generateStatefulSetsDef(stsMeta metav1.ObjectMeta, params statefulSetParame
 		statefulset.Spec.VolumeClaimTemplates = append(statefulset.Spec.VolumeClaimTemplates, createPVCTemplate("node-conf", stsMeta, params.NodeConfPersistentVolumeClaim))
 	}
 	if containerParams.PersistenceEnabled != nil && *containerParams.PersistenceEnabled {
-		pvcTplName := env.GetString(common.EnvOperatorSTSPVCTemplateName, stsMeta.GetName())
+		pvcTplName := util.CoalesceEnv1(common.EnvOperatorSTSPVCTemplateName, stsMeta.GetName())
 		statefulset.Spec.VolumeClaimTemplates = append(statefulset.Spec.VolumeClaimTemplates, createPVCTemplate(pvcTplName, stsMeta, params.PersistentVolumeClaim))
 	}
 	if params.ExternalConfig != nil {
@@ -575,7 +573,6 @@ func generateInitContainerDef(role, name string, initcontainerParams initContain
 	containers := []corev1.Container{}
 
 	if features.Enabled(features.GenerateConfigInInitContainer) {
-		image, _ := util.CoalesceEnv(internalenv.OperatorImageEnv, image.GetOperatorImage())
 		// give all container env vars to init container
 		envVars := append(
 			ptr.Deref(containerParams.EnvVars, []corev1.EnvVar{}),
@@ -601,7 +598,7 @@ func generateInitContainerDef(role, name string, initcontainerParams initContain
 
 		container := corev1.Container{
 			Name:            "init-config",
-			Image:           image,
+			Image:           envs.GetInitContainerImage(),
 			ImagePullPolicy: corev1.PullIfNotPresent,
 			Command:         []string{"/operator", "agent"},
 			SecurityContext: initcontainerParams.SecurityContext,
@@ -783,7 +780,7 @@ func getVolumeMount(name string, persistenceEnabled *bool, clusterMode bool, nod
 
 	if persistenceEnabled != nil && *persistenceEnabled {
 		VolumeMounts = append(VolumeMounts, corev1.VolumeMount{
-			Name:      env.GetString(common.EnvOperatorSTSPVCTemplateName, name),
+			Name:      util.CoalesceEnv1(common.EnvOperatorSTSPVCTemplateName, name),
 			MountPath: "/data",
 		})
 	}
diff --git a/internal/util/coalesce.go b/internal/util/coalesce.go
@@ -17,3 +17,11 @@ func CoalesceEnv(key, defaultVal string) (string, bool) {
 	}
 	return val, true
 }
+
+func CoalesceEnv1(key, defaultVal string) string {
+	val := os.Getenv(key)
+	if val == "" {
+		return defaultVal
+	}
+	return val
+}
