Add support for image params for disconnected (#375)

VaishnaviHire · web-flow · commit 385f72a5e480 · 2023-07-26T21:02:55.000+02:00
diff --git a/components/component.go b/components/component.go
@@ -16,4 +16,5 @@ type ComponentInterface interface {
 	ReconcileComponent(owner metav1.Object, client client.Client, scheme *runtime.Scheme,
 		enabled bool, namespace string) error
 	GetComponentName() string
+	SetImageParamsMap(imageMap map[string]string) map[string]string
 }
diff --git a/components/dashboard/dashboard.go b/components/dashboard/dashboard.go
@@ -19,10 +19,19 @@ const (
 	PathISVAddOn  = deploy.DefaultManifestPath + "/" + ComponentName + "/overlays/apps-addon"
 )
 
+var imageParamMap = map[string]string{
+	"odh-dashboard-image": "RELATED_IMAGE_ODH_DASHBOARD_IMAGE",
+}
+
 type Dashboard struct {
 	components.Component `json:""`
 }
 
+func (d *Dashboard) SetImageParamsMap(imageMap map[string]string) map[string]string {
+	imageParamMap = imageMap
+	return imageParamMap
+}
+
 func (d *Dashboard) GetComponentName() string {
 	return ComponentName
 }
@@ -50,6 +59,11 @@ func (d *Dashboard) ReconcileComponent(owner metav1.Object, cli client.Client, s
 		}
 	}
 
+	// Update image parameters
+	if err := deploy.ApplyImageParams(Path, imageParamMap); err != nil {
+		return err
+	}
+
 	err = deploy.DeployManifestsFromPath(owner, cli, ComponentName,
 		Path,
 		namespace,
diff --git a/components/datasciencepipelines/datasciencepipelines.go b/components/datasciencepipelines/datasciencepipelines.go
@@ -13,10 +13,24 @@ const (
 	Path          = deploy.DefaultManifestPath + "/" + ComponentName + "/base"
 )
 
+var imageParamMap = map[string]string{
+	"IMAGES_APISERVER":         "RELATED_IMAGE_ODH_ML_PIPELINES_API_SERVER_IMAGE",
+	"IMAGES_ARTIFACT":          "RELATED_IMAGE_ODH_ML_PIPELINES_ARTIFACT_MANAGER_IMAGE",
+	"IMAGES_PERSISTENTAGENT":   "RELATED_IMAGE_ODH_ML_PIPELINES_PERSISTENCEAGENT_IMAGE",
+	"IMAGES_SCHEDULEDWORKFLOW": "RELATED_IMAGE_ODH_ML_PIPELINES_SCHEDULEDWORKFLOW_IMAGE",
+	"IMAGES_CACHE":             "RELATED_IMAGE_ODH_ML_PIPELINES_CACHE_IMAGE",
+	"IMAGES_DSPO":              "RELATED_IMAGE_ODH_DATA_SCIENCE_PIPELINES_OPERATOR_CONTROLLER_IMAGE",
+}
+
 type DataSciencePipelines struct {
 	components.Component `json:""`
 }
 
+func (d *DataSciencePipelines) SetImageParamsMap(imageMap map[string]string) map[string]string {
+	imageParamMap = imageMap
+	return imageParamMap
+}
+
 func (d *DataSciencePipelines) GetComponentName() string {
 	return ComponentName
 }
@@ -34,6 +48,11 @@ func (d *DataSciencePipelines) SetEnabled(enabled bool) {
 
 func (d *DataSciencePipelines) ReconcileComponent(owner metav1.Object, client client.Client, scheme *runtime.Scheme, enabled bool, namespace string) error {
 
+	// Update image parameters
+	if err := deploy.ApplyImageParams(Path, imageParamMap); err != nil {
+		return err
+	}
+
 	err := deploy.DeployManifestsFromPath(owner, client, ComponentName,
 		Path,
 		namespace,
diff --git a/components/distributedworkloads/distributedworkloads.go b/components/distributedworkloads/distributedworkloads.go
@@ -14,10 +14,17 @@ const (
 	RayPath       = deploy.DefaultManifestPath + "/" + "ray/operator" + "/base"
 )
 
+var imageParamMap = map[string]string{}
+
 type DistributedWorkloads struct {
 	components.Component `json:""`
 }
 
+func (d *DistributedWorkloads) SetImageParamsMap(imageMap map[string]string) map[string]string {
+	imageParamMap = imageMap
+	return imageParamMap
+}
+
 func (d *DistributedWorkloads) GetComponentName() string {
 	return ComponentName
 }
@@ -27,6 +34,11 @@ var _ components.ComponentInterface = (*DistributedWorkloads)(nil)
 
 func (d *DistributedWorkloads) ReconcileComponent(owner metav1.Object, client client.Client, scheme *runtime.Scheme, enabled bool, namespace string) error {
 
+	// Update image parameters
+	if err := deploy.ApplyImageParams(CodeflarePath, imageParamMap); err != nil {
+		return err
+	}
+
 	// Deploy Codeflare
 	err := deploy.DeployManifestsFromPath(owner, client, ComponentName,
 		CodeflarePath,
@@ -37,6 +49,10 @@ func (d *DistributedWorkloads) ReconcileComponent(owner metav1.Object, client cl
 		return err
 	}
 
+	// Update image parameters
+	if err := deploy.ApplyImageParams(RayPath, imageParamMap); err != nil {
+		return err
+	}
 	// Deploy Ray Operator
 	err = deploy.DeployManifestsFromPath(owner, client, ComponentName,
 		RayPath,
diff --git a/components/kserve/kserve.go b/components/kserve/kserve.go
@@ -15,10 +15,17 @@ const (
 	Path          = deploy.DefaultManifestPath + "/" + ComponentName + "/base"
 )
 
+var imageParamMap = map[string]string{}
+
 type Kserve struct {
 	components.Component `json:""`
 }
 
+func (d *Kserve) SetImageParamsMap(imageMap map[string]string) map[string]string {
+	imageParamMap = imageMap
+	return imageParamMap
+}
+
 func (d *Kserve) GetComponentName() string {
 	return ComponentName
 }
@@ -41,6 +48,12 @@ func (d *Kserve) ReconcileComponent(owner metav1.Object, cli client.Client, sche
 	if err != nil {
 		return err
 	}
+
+	// Update image parameters
+	if err := deploy.ApplyImageParams(Path, imageParamMap); err != nil {
+		return err
+	}
+
 	err = deploy.DeployManifestsFromPath(owner, cli, ComponentName,
 		Path,
 		namespace,
diff --git a/components/modelmeshserving/modelmeshserving.go b/components/modelmeshserving/modelmeshserving.go
@@ -15,6 +15,14 @@ const (
 	monitoringPath = deploy.DefaultManifestPath + "/" + "modelmesh-monitoring/base"
 )
 
+var imageParamMap = map[string]string{
+	"odh-mm-rest-proxy":             "RELATED_IMAGE_ODH_MM_REST_PROXY_IMAGE",
+	"odh-modelmesh-runtime-adapter": "RELATED_IMAGE_ODH_MODELMESH_RUNTIME_ADAPTER_IMAGE",
+	"odh-modelmesh":                 "RELATED_IMAGE_ODH_MODELMESH_IMAGE",
+	"odh-modelmesh-controller":      "RELATED_IMAGE_ODH_MODELMESH_CONTROLLER_IMAGE",
+	"odh-model-controller":          "RELATED_IMAGE_ODH_MODEL_CONTROLLER_IMAGE",
+}
+
 type ModelMeshServing struct {
 	components.Component `json:""`
 }
@@ -23,6 +31,11 @@ func (m *ModelMeshServing) GetComponentName() string {
 	return ComponentName
 }
 
+func (m *ModelMeshServing) SetImageParamsMap(imageMap map[string]string) map[string]string {
+	imageParamMap = imageMap
+	return imageParamMap
+}
+
 // Verifies that Dashboard implements ComponentInterface
 var _ components.ComponentInterface = (*ModelMeshServing)(nil)
 
@@ -41,6 +54,12 @@ func (m *ModelMeshServing) ReconcileComponent(owner metav1.Object, cli client.Cl
 	if err != nil {
 		return err
 	}
+
+	// Update image parameters
+	if err := deploy.ApplyImageParams(Path, imageParamMap); err != nil {
+		return err
+	}
+
 	err = deploy.DeployManifestsFromPath(owner, cli, ComponentName,
 		Path,
 		namespace,
diff --git a/components/workbenches/workbenches.go b/components/workbenches/workbenches.go
@@ -15,6 +15,11 @@ const (
 	notebookImagesPath     = deploy.DefaultManifestPath + "/notebook-images/overlays/additional"
 )
 
+var imageParamMap = map[string]string{
+	"odh-notebook-controller-image":    "RELATED_IMAGE_ODH_NOTEBOOK_CONTROLLER_IMAGE",
+	"odh-kf-notebook-controller-image": "RELATED_IMAGE_ODH_KF_NOTEBOOK_CONTROLLER_IMAGE",
+}
+
 type Workbenches struct {
 	components.Component `json:""`
 }
@@ -23,6 +28,11 @@ func (w *Workbenches) GetComponentName() string {
 	return ComponentName
 }
 
+func (w *Workbenches) SetImageParamsMap(imageMap map[string]string) map[string]string {
+	imageParamMap = imageMap
+	return imageParamMap
+}
+
 // Verifies that Dashboard implements ComponentInterface
 var _ components.ComponentInterface = (*Workbenches)(nil)
 
@@ -41,13 +51,23 @@ func (w *Workbenches) ReconcileComponent(owner metav1.Object, cli client.Client,
 		return err
 	}
 
+	// Update image parameters
+	if err := deploy.ApplyImageParams(notebookControllerPath, imageParamMap); err != nil {
+		return err
+	}
+
 	err = deploy.DeployManifestsFromPath(owner, cli, ComponentName,
 		notebookControllerPath,
 		namespace,
 		scheme, enabled)
 	if err != nil {
 		return err
 	}
+
+	// Update image parameters
+	if err := deploy.ApplyImageParams(notebookImagesPath, imageParamMap); err != nil {
+		return err
+	}
 	err = deploy.DeployManifestsFromPath(owner, cli, ComponentName,
 		notebookImagesPath,
 		namespace,
diff --git a/pkg/deploy/deploy.go b/pkg/deploy/deploy.go
@@ -2,6 +2,7 @@ package deploy
 
 import (
 	"archive/tar"
+	"bufio"
 	"compress/gzip"
 	"context"
 	"encoding/json"
@@ -224,4 +225,74 @@ func manageResource(owner metav1.Object, ctx context.Context, cli client.Client,
 	return cli.Patch(ctx, found, client.RawPatch(types.ApplyPatchType, data), client.ForceOwnership, client.FieldOwner(owner.GetName()))
 }
 
+func ApplyImageParams(componentPath string, imageParamsMap map[string]string) error {
+	envFilePath := componentPath + "/params.env"
+	// Require params.env at the root folder
+	file, err := os.Open(envFilePath)
+	if err != nil {
+		if os.IsNotExist(err) {
+			// params.env doesn't exist, do not apply any changes
+			return nil
+		}
+		return err
+	}
+	backupPath := envFilePath + ".bak"
+	defer file.Close()
+
+	envMap := make(map[string]string)
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+		line := scanner.Text()
+		parts := strings.SplitN(line, "=", 2)
+		if len(parts) == 2 {
+			envMap[parts[0]] = parts[1]
+		}
+	}
+
+	if err := scanner.Err(); err != nil {
+		return err
+	}
+
+	// Update images with env variables
+	for key, _ := range envMap {
+		relatedImageValue := os.Getenv(imageParamsMap[key])
+		if relatedImageValue != "" {
+			envMap[key] = relatedImageValue
+		}
+	}
+
+	// Move the existing file to a backup file
+	os.Rename(envFilePath, backupPath)
+
+	// Now, write the map back to the file
+	file, err = os.Create(envFilePath)
+	if err != nil {
+		// If create fails, restore the backup file
+		os.Rename(backupPath, envFilePath)
+		return err
+	}
+	defer file.Close()
+
+	writer := bufio.NewWriter(file)
+	for key, value := range envMap {
+		fmt.Fprintf(writer, "%s=%s\n", key, value)
+	}
+	if err := writer.Flush(); err != nil {
+		if removeErr := os.Remove(envFilePath); removeErr != nil {
+			fmt.Printf("Failed to remove file: %v", removeErr)
+		}
+		if renameErr := os.Rename(backupPath, envFilePath); renameErr != nil {
+			fmt.Printf("Failed to restore file from backup: %v", renameErr)
+		}
+		fmt.Printf("Failed to write to file: %v", err)
+		return err
+	}
+
+	if err := os.Remove(backupPath); err != nil {
+		fmt.Printf("Failed to remove backup file: %v", err)
+		return err
+	}
+	return nil
+}
+
 // TODO : Add function to cleanup code created as part of pre install and post intall task of a component

Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,5 @@ type ComponentInterface interface {`
`16`	`16`	`ReconcileComponent(owner metav1.Object, client client.Client, scheme *runtime.Scheme,`
`17`	`17`	`enabled bool, namespace string) error`
`18`	`18`	`GetComponentName() string`
	`19`	`+ SetImageParamsMap(imageMap map[string]string) map[string]string`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,19 @@ const (`
`19`	`19`	`PathISVAddOn = deploy.DefaultManifestPath + "/" + ComponentName + "/overlays/apps-addon"`
`20`	`20`	`)`
`21`	`21`
	`22`	`+var imageParamMap = map[string]string{`
	`23`	`+ "odh-dashboard-image": "RELATED_IMAGE_ODH_DASHBOARD_IMAGE",`
	`24`	`+}`
	`25`	`+`
`22`	`26`	`type Dashboard struct {`
`23`	`27`	components.Component `json:""`
`24`	`28`	`}`
`25`	`29`
	`30`	`+func (d *Dashboard) SetImageParamsMap(imageMap map[string]string) map[string]string {`
	`31`	`+ imageParamMap = imageMap`
	`32`	`+ return imageParamMap`
	`33`	`+}`
	`34`	`+`
`26`	`35`	`func (d *Dashboard) GetComponentName() string {`
`27`	`36`	`return ComponentName`
`28`	`37`	`}`
`@@ -50,6 +59,11 @@ func (d *Dashboard) ReconcileComponent(owner metav1.Object, cli client.Client, s`
`50`	`59`	`}`
`51`	`60`	`}`
`52`	`61`
	`62`	`+ // Update image parameters`
	`63`	`+ if err := deploy.ApplyImageParams(Path, imageParamMap); err != nil {`
	`64`	`+ return err`
	`65`	`+ }`
	`66`	`+`
`53`	`67`	`err = deploy.DeployManifestsFromPath(owner, cli, ComponentName,`
`54`	`68`	`Path,`
`55`	`69`	`namespace,`