Avoid hardcoded images

api/v1alpha1/backstage_types.go

@@ -27,12 +27,6 @@ const (
 	DeployInProgress  string = "DeployInProgress"
 )
 
-// Constants for image placeholders
-const (
-	EnvPostGresImage  string = "RELATED_IMAGE_postgresql"
-	EnvBackstageImage string = "RELATED_IMAGE_backstage"
-)
-
 // BackstageSpec defines the desired state of Backstage
 type BackstageSpec struct {
 	// Configuration for Backstage. Optional.

config/manager/default-config/db-statefulset.yaml

@@ -29,7 +29,7 @@ spec:
           envFrom:
             - secretRef:
                 name: <POSTGRESQL_SECRET>  # will be replaced with 'backstage-psql-secrets-<cr-name>'
-          image: <RELATED_IMAGE_postgresql> # will be replaced with the actual image
+          image: quay.io/fedora/postgresql-15:latest
           imagePullPolicy: IfNotPresent
           securityContext:
             runAsNonRoot: true

config/manager/default-config/deployment.yaml

@@ -36,7 +36,8 @@ spec:
           env:
             - name: NPM_CONFIG_USERCONFIG
               value: /opt/app-root/src/.npmrc.dynamic-plugins
-          image: <RELATED_IMAGE_backstage> # will be replaced with the actual image quay.io/janus-idp/backstage-showcase:next
+          #image: <RELATED_IMAGE_backstage> # will be replaced with the actual image quay.io/janus-idp/backstage-showcase:next
+          image: quay.io/janus-idp/backstage-showcase:latest
           imagePullPolicy: IfNotPresent
           name: install-dynamic-plugins
           volumeMounts:
@@ -50,7 +51,7 @@ spec:
 
       containers:
         - name: backstage-backend
-          image: <RELATED_IMAGE_backstage> # will be replaced with the actual image quay.io/janus-idp/backstage-showcase:next
+          image: quay.io/janus-idp/backstage-showcase:latest
           imagePullPolicy: IfNotPresent
           args:
             - "--config"

controllers/backstage_controller.go

@@ -41,6 +41,12 @@ const (
 	BackstageAppLabel = "janus-idp.io/app"
 )
 
+// Constants for image placeholders
+const (
+	EnvPostgresImage  string = "RELATED_IMAGE_postgresql"
+	EnvBackstageImage string = "RELATED_IMAGE_backstage"
+)
+
 // BackstageReconciler reconciles a Backstage object
 type BackstageReconciler struct {
 	client.Client
@@ -57,9 +63,9 @@ type BackstageReconciler struct {
 
 	IsOpenShift bool
 
-	PsqlImage string
-
-	BackstageImage string
+	//PsqlImage string
+	//
+	//BackstageImage string
 }
 
 //+kubebuilder:rbac:groups=janus-idp.io,resources=backstages,verbs=get;list;watch;create;update;patch;delete
@@ -295,14 +301,13 @@ func (r *BackstageReconciler) labels(meta *v1.ObjectMeta, backstage bs.Backstage
 
 // SetupWithManager sets up the controller with the Manager.
 func (r *BackstageReconciler) SetupWithManager(mgr ctrl.Manager, log logr.Logger) error {
-	if len(r.PsqlImage) == 0 {
-		r.PsqlImage = "quay.io/fedora/postgresql-15:latest"
-		log.Info("Enviroment variable is not set, default is used", bs.EnvPostGresImage, r.PsqlImage)
-	}
 
-	if len(r.BackstageImage) == 0 {
-		r.BackstageImage = "quay.io/janus-idp/backstage-showcase:next"
-		log.Info("Enviroment variable is not set, default is used", bs.EnvBackstageImage, r.BackstageImage)
+	const imageNotSet = "environment variable is not set, default will be used:"
+	if _, ok := os.LookupEnv(EnvPostgresImage); !ok {
+		log.Info(imageNotSet, "", EnvPostgresImage)
+	}
+	if _, ok := os.LookupEnv(EnvBackstageImage); !ok {
+		log.Info(imageNotSet, "", EnvBackstageImage)
 	}
 
 	builder := ctrl.NewControllerManagedBy(mgr).

controllers/backstage_controller_test.go

@@ -61,12 +61,12 @@ var _ = Describe("Backstage controller", func() {
 		Expect(err).To(Not(HaveOccurred()))
 
 		backstageReconciler = &BackstageReconciler{
-			Client:         k8sClient,
-			Scheme:         k8sClient.Scheme(),
-			Namespace:      ns,
-			OwnsRuntime:    true,
-			PsqlImage:      "test-postgresql-15:latest",
-			BackstageImage: "test-backstage-showcase:next",
+			Client:      k8sClient,
+			Scheme:      k8sClient.Scheme(),
+			Namespace:   ns,
+			OwnsRuntime: true,
+			//PsqlImage:      "test-postgresql-15:latest",
+			//BackstageImage: "test-backstage-showcase:next",
 		}
 	})
 

controllers/backstage_deployment.go

@@ -17,6 +17,7 @@ package controller
 import (
 	"context"
 	"fmt"
+	"os"
 
 	appsv1 "k8s.io/api/apps/v1"
 	v1 "k8s.io/api/core/v1"
@@ -33,103 +34,6 @@ const (
 	_containersWorkingDir              = "/opt/app-root/src"
 )
 
-//var (
-//	DefaultBackstageDeployment = fmt.Sprintf(`
-//apiVersion: apps/v1
-//kind: Deployment
-//metadata:
-// name: backstage
-//spec:
-// replicas: 1
-// selector:
-//   matchLabels:
-//     janus-idp.io/app:  # placeholder for 'backstage-<cr-name>'
-// template:
-//   metadata:
-//     labels:
-//       janus-idp.io/app:  # placeholder for 'backstage-<cr-name>'
-//   spec:
-//#      serviceAccountName: default
-//
-//     volumes:
-//       - ephemeral:
-//           volumeClaimTemplate:
-//             spec:
-//               accessModes:
-//               - ReadWriteOnce
-//               resources:
-//                 requests:
-//                   storage: 1Gi
-//         name: dynamic-plugins-root
-//       - name: dynamic-plugins-npmrc
-//         secret:
-//           defaultMode: 420
-//           optional: true
-//           secretName: dynamic-plugins-npmrc
-//
-//     initContainers:
-//       - command:
-//         - ./install-dynamic-plugins.sh
-//         - /dynamic-plugins-root
-//         env:
-//         - name: NPM_CONFIG_USERCONFIG
-//           value: %[3]s/.npmrc.dynamic-plugins
-//         image: 'quay.io/janus-idp/backstage-showcase:next'
-//         imagePullPolicy: IfNotPresent
-//         name: %[1]s
-//         volumeMounts:
-//         - mountPath: /dynamic-plugins-root
-//           name: dynamic-plugins-root
-//         - mountPath: %[3]s/.npmrc.dynamic-plugins
-//           name: dynamic-plugins-npmrc
-//           readOnly: true
-//           subPath: .npmrc
-//         workingDir: %[3]s
-//
-//     containers:
-//       - name: %[2]s
-//         image: quay.io/janus-idp/backstage-showcase:next
-//         imagePullPolicy: IfNotPresent
-//         args:
-//           - "--config"
-//           - "dynamic-plugins-root/app-config.dynamic-plugins.yaml"
-//         readinessProbe:
-//           failureThreshold: 3
-//           httpGet:
-//             path: /healthcheck
-//             port: 7007
-//             scheme: HTTP
-//           initialDelaySeconds: 30
-//           periodSeconds: 10
-//           successThreshold: 2
-//           timeoutSeconds: 2
-//         livenessProbe:
-//           failureThreshold: 3
-//           httpGet:
-//             path: /healthcheck
-//             port: 7007
-//             scheme: HTTP
-//           initialDelaySeconds: 60
-//           periodSeconds: 10
-//           successThreshold: 1
-//           timeoutSeconds: 2
-//         ports:
-//           - name: http
-//             containerPort: 7007
-//         env:
-//           - name: APP_CONFIG_backend_listen_port
-//             value: "7007"
-//         envFrom:
-//           - secretRef:
-//               name: postgres-secrets
-//#            - secretRef:
-//#                name: backstage-secrets
-//         volumeMounts:
-//           - mountPath: %[3]s/dynamic-plugins-root
-//             name: dynamic-plugins-root
-//`, _defaultBackstageInitContainerName, _defaultBackstageMainContainerName, _containersWorkingDir)
-//)
-
 // ContainerVisitor is called with each container
 type ContainerVisitor func(container *v1.Container)
 
@@ -291,9 +195,10 @@ func (r *BackstageReconciler) validateAndUpdatePsqlSecretRef(backstage bs.Backst
 }
 
 func (r *BackstageReconciler) setDefaultDeploymentImage(deployment *appsv1.Deployment) {
+
 	visitContainers(&deployment.Spec.Template, func(container *v1.Container) {
-		if len(container.Image) == 0 || container.Image == fmt.Sprintf("<%s>", bs.EnvBackstageImage) {
-			container.Image = r.BackstageImage
+		if val, ok := os.LookupEnv(EnvBackstageImage); ok {
+			container.Image = val
 		}
 	})
 }

controllers/local_db_statefulset.go

@@ -18,6 +18,7 @@ package controller
 import (
 	"context"
 	"fmt"
+	"os"
 
 	appsv1 "k8s.io/api/apps/v1"
 	v1 "k8s.io/api/core/v1"
@@ -219,9 +220,12 @@ func (r *BackstageReconciler) patchLocalDbStatefulSetObj(statefulSet *appsv1.Sta
 
 func (r *BackstageReconciler) setDefaultStatefulSetImage(statefulSet *appsv1.StatefulSet) {
 	visitContainers(&statefulSet.Spec.Template, func(container *v1.Container) {
-		if len(container.Image) == 0 || container.Image == fmt.Sprintf("<%s>", bs.EnvPostGresImage) {
-			container.Image = r.PsqlImage
+		if val, ok := os.LookupEnv(EnvPostgresImage); ok {
+			container.Image = val
 		}
+		//if len(container.Image) == 0 || container.Image == fmt.Sprintf("<%s>", bs.EnvPostgresImage) {
+		//	container.Image = r.PsqlImage
+		//}
 	})
 }
 

examples/janus-cr-with-app-configs.yaml

@@ -80,6 +80,7 @@ data:
           target: https://github.com/ododev/odo-backstage-software-template/blob/main/template.yaml
           rules:
             - allow: [Template]
+    # # catalog.providers.githubOrg.default.orgUrl
 
 ---
 apiVersion: v1
@@ -132,7 +133,7 @@ data:
             endpoints:
               /explore-backend-completed:
                 target: 'http://localhost:7017'
-
+                
 ---
 apiVersion: v1
 kind: ConfigMap

main.go

@@ -104,12 +104,10 @@ func main() {
 	}
 
 	if err = (&controller.BackstageReconciler{
-		Client:         mgr.GetClient(),
-		Scheme:         mgr.GetScheme(),
-		OwnsRuntime:    ownRuntime,
-		IsOpenShift:    isOpenShift,
-		PsqlImage:      os.Getenv(backstageiov1alpha1.EnvPostGresImage),
-		BackstageImage: os.Getenv(backstageiov1alpha1.EnvBackstageImage),
+		Client:      mgr.GetClient(),
+		Scheme:      mgr.GetScheme(),
+		OwnsRuntime: ownRuntime,
+		IsOpenShift: isOpenShift,
 	}).SetupWithManager(mgr, setupLog); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "Backstage")
 		os.Exit(1)
@@ -129,8 +127,6 @@ func main() {
 		"own-runtime", ownRuntime,
 		"env.LOCALBIN", os.Getenv("LOCALBIN"),
 		"isOpenShift", isOpenShift,
-		backstageiov1alpha1.EnvPostGresImage, os.Getenv(backstageiov1alpha1.EnvPostGresImage),
-		backstageiov1alpha1.EnvBackstageImage, os.Getenv(backstageiov1alpha1.EnvBackstageImage),
 	)
 	if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
 		setupLog.Error(err, "problem running manager")