Add version information to resources (trustyai-explainability#215)

ruivieira · web-flow · commit 65fde44271cb · 2024-02-15T20:17:38.000Z
diff --git a/Makefile b/Makefile
@@ -3,7 +3,7 @@
 # To re-generate a bundle for another specific version without changing the standard setup, you can:
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
-VERSION ?= 0.0.1
+VERSION ?= 1.17.0
 
 BUILD_TOOL ?= podman
 
diff --git a/controllers/deployment.go b/controllers/deployment.go
@@ -36,6 +36,7 @@ type DeploymentConfig struct {
 	VolumeMountName          string
 	PVCClaimName             string
 	CustomCertificatesBundle CustomCertificatesBundle
+	Version                  string
 }
 
 // createDeploymentObject returns a Deployment for the TrustyAI Service instance
@@ -64,6 +65,7 @@ func (r *TrustyAIServiceReconciler) createDeploymentObject(ctx context.Context,
 		VolumeMountName:          volumeMountName,
 		PVCClaimName:             pvcName,
 		CustomCertificatesBundle: caBunble,
+		Version:                  Version,
 	}
 
 	var deployment *appsv1.Deployment
diff --git a/controllers/deployment_test.go b/controllers/deployment_test.go
@@ -84,7 +84,7 @@ var _ = Describe("TrustyAI operator", func() {
 			Expect(deployment.Labels["app.kubernetes.io/name"]).Should(Equal(defaultServiceName))
 			Expect(deployment.Labels["app.kubernetes.io/instance"]).Should(Equal(defaultServiceName))
 			Expect(deployment.Labels["app.kubernetes.io/part-of"]).Should(Equal(componentName))
-			Expect(deployment.Labels["app.kubernetes.io/version"]).Should(Equal("0.1.0"))
+			Expect(deployment.Labels["app.kubernetes.io/version"]).Should(Equal(Version))
 
 			Expect(len(deployment.Spec.Template.Spec.Containers)).Should(Equal(2))
 			Expect(deployment.Spec.Template.Spec.Containers[0].Image).Should(Equal("quay.io/trustyai/trustyai-service:latest"))
@@ -122,8 +122,8 @@ var _ = Describe("TrustyAI operator", func() {
 			Expect(oauthService.Labels["app"]).Should(Equal(instance.Name))
 			Expect(oauthService.Labels["app.kubernetes.io/instance"]).Should(Equal(instance.Name))
 			Expect(oauthService.Labels["app.kubernetes.io/name"]).Should(Equal(instance.Name))
-			Expect(oauthService.Labels["app.kubernetes.io/part-of"]).Should(Equal("trustyai"))
-			Expect(oauthService.Labels["app.kubernetes.io/version"]).Should(Equal("0.1.0"))
+			Expect(oauthService.Labels["app.kubernetes.io/part-of"]).Should(Equal(componentName))
+			Expect(oauthService.Labels["app.kubernetes.io/version"]).Should(Equal(Version))
 			Expect(oauthService.Labels["trustyai-service-name"]).Should(Equal(instance.Name))
 
 		})
@@ -167,7 +167,7 @@ var _ = Describe("TrustyAI operator", func() {
 			Expect(deployment.Labels["app.kubernetes.io/name"]).Should(Equal(defaultServiceName))
 			Expect(deployment.Labels["app.kubernetes.io/instance"]).Should(Equal(defaultServiceName))
 			Expect(deployment.Labels["app.kubernetes.io/part-of"]).Should(Equal(componentName))
-			Expect(deployment.Labels["app.kubernetes.io/version"]).Should(Equal("0.1.0"))
+			Expect(deployment.Labels["app.kubernetes.io/version"]).Should(Equal(Version))
 
 			Expect(len(deployment.Spec.Template.Spec.Containers)).Should(Equal(2))
 			Expect(deployment.Spec.Template.Spec.Containers[0].Image).Should(Equal(serviceImage))
@@ -205,8 +205,8 @@ var _ = Describe("TrustyAI operator", func() {
 			Expect(oauthService.Labels["app"]).Should(Equal(instance.Name))
 			Expect(oauthService.Labels["app.kubernetes.io/instance"]).Should(Equal(instance.Name))
 			Expect(oauthService.Labels["app.kubernetes.io/name"]).Should(Equal(instance.Name))
-			Expect(oauthService.Labels["app.kubernetes.io/part-of"]).Should(Equal("trustyai"))
-			Expect(oauthService.Labels["app.kubernetes.io/version"]).Should(Equal("0.1.0"))
+			Expect(oauthService.Labels["app.kubernetes.io/part-of"]).Should(Equal(componentName))
+			Expect(oauthService.Labels["app.kubernetes.io/version"]).Should(Equal(Version))
 			Expect(oauthService.Labels["trustyai-service-name"]).Should(Equal(instance.Name))
 
 		})
@@ -463,7 +463,7 @@ var _ = Describe("TrustyAI operator", func() {
 			Expect(deployment.Labels["app.kubernetes.io/name"]).Should(Equal(defaultServiceName))
 			Expect(deployment.Labels["app.kubernetes.io/instance"]).Should(Equal(defaultServiceName))
 			Expect(deployment.Labels["app.kubernetes.io/part-of"]).Should(Equal(componentName))
-			Expect(deployment.Labels["app.kubernetes.io/version"]).Should(Equal("0.1.0"))
+			Expect(deployment.Labels["app.kubernetes.io/version"]).Should(Equal(Version))
 
 			WaitFor(func() error {
 				err := reconciler.reconcileOAuthService(ctx, instance, caBundle)
@@ -482,8 +482,8 @@ var _ = Describe("TrustyAI operator", func() {
 			Expect(oauthService.Labels["app"]).Should(Equal(instance.Name))
 			Expect(oauthService.Labels["app.kubernetes.io/instance"]).Should(Equal(instance.Name))
 			Expect(oauthService.Labels["app.kubernetes.io/name"]).Should(Equal(instance.Name))
-			Expect(oauthService.Labels["app.kubernetes.io/part-of"]).Should(Equal("trustyai"))
-			Expect(oauthService.Labels["app.kubernetes.io/version"]).Should(Equal("0.1.0"))
+			Expect(oauthService.Labels["app.kubernetes.io/part-of"]).Should(Equal(componentName))
+			Expect(oauthService.Labels["app.kubernetes.io/version"]).Should(Equal(Version))
 			Expect(oauthService.Labels["trustyai-service-name"]).Should(Equal(instance.Name))
 
 		})
@@ -546,7 +546,7 @@ var _ = Describe("TrustyAI operator", func() {
 				Expect(deployment.Labels["app.kubernetes.io/name"]).Should(Equal(defaultServiceName))
 				Expect(deployment.Labels["app.kubernetes.io/instance"]).Should(Equal(defaultServiceName))
 				Expect(deployment.Labels["app.kubernetes.io/part-of"]).Should(Equal(componentName))
-				Expect(deployment.Labels["app.kubernetes.io/version"]).Should(Equal("0.1.0"))
+				Expect(deployment.Labels["app.kubernetes.io/version"]).Should(Equal(Version))
 
 				Expect(len(deployment.Spec.Template.Spec.Containers)).Should(Equal(2))
 				Expect(deployment.Spec.Template.Spec.Containers[0].Image).Should(Equal("quay.io/trustyai/trustyai-service:latest"))
@@ -569,8 +569,8 @@ var _ = Describe("TrustyAI operator", func() {
 				Expect(oauthService.Labels["app"]).Should(Equal(instance.Name))
 				Expect(oauthService.Labels["app.kubernetes.io/instance"]).Should(Equal(instance.Name))
 				Expect(oauthService.Labels["app.kubernetes.io/name"]).Should(Equal(instance.Name))
-				Expect(oauthService.Labels["app.kubernetes.io/part-of"]).Should(Equal("trustyai"))
-				Expect(oauthService.Labels["app.kubernetes.io/version"]).Should(Equal("0.1.0"))
+				Expect(oauthService.Labels["app.kubernetes.io/part-of"]).Should(Equal(componentName))
+				Expect(oauthService.Labels["app.kubernetes.io/version"]).Should(Equal(Version))
 				Expect(oauthService.Labels["trustyai-service-name"]).Should(Equal(instance.Name))
 
 			}
diff --git a/controllers/oauth.go b/controllers/oauth.go
@@ -23,6 +23,7 @@ type OAuthConfig struct {
 type ServiceTLSConfig struct {
 	Instance                 *trustyaiopendatahubiov1alpha1.TrustyAIService
 	CustomCertificatesBundle CustomCertificatesBundle
+	Version                  string
 }
 
 // generateTrustyAIOAuthService defines the desired OAuth service object
@@ -31,6 +32,7 @@ func generateTrustyAIOAuthService(ctx context.Context, instance *trustyaiopendat
 	serviceTLSConfig := ServiceTLSConfig{
 		Instance:                 instance,
 		CustomCertificatesBundle: caBundle,
+		Version:                  Version,
 	}
 
 	var serviceTLS *corev1.Service
diff --git a/controllers/service_accounts.go b/controllers/service_accounts.go
@@ -64,7 +64,7 @@ func (r *TrustyAIServiceReconciler) createServiceAccount(ctx context.Context, in
 				"app.kubernetes.io/name":     serviceAccountName,
 				"app.kubernetes.io/instance": instance.Name,
 				"app.kubernetes.io/part-of":  componentName,
-				"app.kubernetes.io/version":  "0.1.0",
+				"app.kubernetes.io/version":  Version,
 			},
 		},
 	}
diff --git a/controllers/services.go b/controllers/services.go
@@ -17,13 +17,15 @@ const (
 type ServiceConfig struct {
 	Name      string
 	Namespace string
+	Version   string
 }
 
 func (r *TrustyAIServiceReconciler) reconcileService(ctx context.Context, cr *trustyaiopendatahubiov1alpha1.TrustyAIService) (*corev1.Service, error) {
 
 	serviceConfig := ServiceConfig{
 		Name:      cr.Name,
 		Namespace: cr.Namespace,
+		Version:   Version,
 	}
 
 	var service *corev1.Service
diff --git a/controllers/templates/service/deployment.tmpl.yaml b/controllers/templates/service/deployment.tmpl.yaml
@@ -10,7 +10,7 @@ metadata:
     app.kubernetes.io/instance: {{ .Instance.Name }}
     app.kubernetes.io/name: {{ .Instance.Name }}
     app.kubernetes.io/part-of: trustyai
-    app.kubernetes.io/version: 0.1.0
+    app.kubernetes.io/version: {{ .Version }}
 spec:
   replicas: 1
   selector:
@@ -19,15 +19,15 @@ spec:
       app.kubernetes.io/instance: {{ .Instance.Name }}
       app.kubernetes.io/name: {{ .Instance.Name }}
       app.kubernetes.io/part-of: trustyai
-      app.kubernetes.io/version: 0.1.0
+      app.kubernetes.io/version: {{ .Version }}
   template:
     metadata:
       labels:
         app: {{ .Instance.Name }}
         app.kubernetes.io/instance: {{ .Instance.Name }}
         app.kubernetes.io/name: {{ .Instance.Name }}
         app.kubernetes.io/part-of: trustyai
-        app.kubernetes.io/version: 0.1.0
+        app.kubernetes.io/version: {{ .Version }}
       annotations:
         prometheus.io/path: /q/metrics
         prometheus.io/scheme: http
diff --git a/controllers/templates/service/service-internal.tmpl.yaml b/controllers/templates/service/service-internal.tmpl.yaml
@@ -12,7 +12,7 @@ metadata:
         app.kubernetes.io/instance: {{ .Name }}
         app.kubernetes.io/name: {{ .Name }}
         app.kubernetes.io/part-of: trustyai
-        app.kubernetes.io/version: 0.1.0
+        app.kubernetes.io/version: {{ .Version }}
 spec:
     ports:
         - name: http
@@ -25,4 +25,4 @@ spec:
         app.kubernetes.io/instance: {{ .Name }}
         app.kubernetes.io/name: {{ .Name }}
         app.kubernetes.io/part-of: trustyai
-        app.kubernetes.io/version: 0.1.0
+        app.kubernetes.io/version: {{ .Version }}
diff --git a/controllers/templates/service/service-tls.tmpl.yaml b/controllers/templates/service/service-tls.tmpl.yaml
@@ -12,7 +12,7 @@ metadata:
         app.kubernetes.io/instance: {{ .Instance.Name }}
         app.kubernetes.io/name: {{ .Instance.Name }}
         app.kubernetes.io/part-of: trustyai
-        app.kubernetes.io/version: 0.1.0
+        app.kubernetes.io/version: {{ .Version }}
         trustyai-service-name: {{ .Instance.Name }}
 spec:
     ports:
diff --git a/controllers/trustyaiservice_controller.go b/controllers/trustyaiservice_controller.go
@@ -68,17 +68,6 @@ type TrustyAIServiceReconciler struct {
 //+kubebuilder:rbac:groups="",resources=serviceaccounts,verbs=get;list;watch;create;update;delete
 //+kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=clusterrolebindings,verbs=get;list;watch;create;update;delete
 
-// getCommonLabels returns the service's common labels
-func getCommonLabels(serviceName string) map[string]string {
-	return map[string]string{
-		"app":                        serviceName,
-		"app.kubernetes.io/name":     serviceName,
-		"app.kubernetes.io/instance": serviceName,
-		"app.kubernetes.io/part-of":  componentName,
-		"app.kubernetes.io/version":  "0.1.0",
-	}
-}
-
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.
 func (r *TrustyAIServiceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
diff --git a/controllers/version.go b/controllers/version.go
@@ -0,0 +1,5 @@
+package controllers
+
+const (
+	Version = "1.17.0"
+)

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ type DeploymentConfig struct {`
`36`	`36`	`VolumeMountName string`
`37`	`37`	`PVCClaimName string`
`38`	`38`	`CustomCertificatesBundle CustomCertificatesBundle`
	`39`	`+ Version string`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`// createDeploymentObject returns a Deployment for the TrustyAI Service instance`
`@@ -64,6 +65,7 @@ func (r *TrustyAIServiceReconciler) createDeploymentObject(ctx context.Context,`
`64`	`65`	`VolumeMountName: volumeMountName,`
`65`	`66`	`PVCClaimName: pvcName,`
`66`	`67`	`CustomCertificatesBundle: caBunble,`
	`68`	`+ Version: Version,`
`67`	`69`	`}`
`68`	`70`
`69`	`71`	`var deployment *appsv1.Deployment`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ type OAuthConfig struct {`
`23`	`23`	`type ServiceTLSConfig struct {`
`24`	`24`	`Instance *trustyaiopendatahubiov1alpha1.TrustyAIService`
`25`	`25`	`CustomCertificatesBundle CustomCertificatesBundle`
	`26`	`+ Version string`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`// generateTrustyAIOAuthService defines the desired OAuth service object`
`@@ -31,6 +32,7 @@ func generateTrustyAIOAuthService(ctx context.Context, instance *trustyaiopendat`
`31`	`32`	`serviceTLSConfig := ServiceTLSConfig{`
`32`	`33`	`Instance: instance,`
`33`	`34`	`CustomCertificatesBundle: caBundle,`
	`35`	`+ Version: Version,`
`34`	`36`	`}`
`35`	`37`
`36`	`38`	`var serviceTLS *corev1.Service`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ func (r *TrustyAIServiceReconciler) createServiceAccount(ctx context.Context, in`
`64`	`64`	`"app.kubernetes.io/name": serviceAccountName,`
`65`	`65`	`"app.kubernetes.io/instance": instance.Name,`
`66`	`66`	`"app.kubernetes.io/part-of": componentName,`
`67`		`- "app.kubernetes.io/version": "0.1.0",`
	`67`	`+ "app.kubernetes.io/version": Version,`
`68`	`68`	`},`
`69`	`69`	`},`
`70`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,15 @@ const (`
`17`	`17`	`type ServiceConfig struct {`
`18`	`18`	`Name string`
`19`	`19`	`Namespace string`
	`20`	`+ Version string`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`func (r TrustyAIServiceReconciler) reconcileService(ctx context.Context, cr trustyaiopendatahubiov1alpha1.TrustyAIService) (*corev1.Service, error) {`
`23`	`24`
`24`	`25`	`serviceConfig := ServiceConfig{`
`25`	`26`	`Name: cr.Name,`
`26`	`27`	`Namespace: cr.Namespace,`
	`28`	`+ Version: Version,`
`27`	`29`	`}`
`28`	`30`
`29`	`31`	`var service *corev1.Service`