Merge pull request #624 from hbelmiro/RHOAIENG-4252

Set ScheduledWorkflow OwnerReference
opendatahub-io · Apr 30, 2024 · ed6b13c · ed6b13c
2 parents e914f1d + 99acf3e
commit ed6b13c
Show file tree

Hide file tree

Showing 12 changed files with 77 additions and 14 deletions.
diff --git a/config/base/params.env b/config/base/params.env
@@ -24,3 +24,5 @@ MAX_CONCURRENT_RECONCILES=10
 DSPO_HEALTHCHECK_DATABASE_CONNECTIONTIMEOUT=15s
 DSPO_HEALTHCHECK_OBJECTSTORE_CONNECTIONTIMEOUT=15s
 DSPO_REQUEUE_TIME=20s
+# DSPO_APISERVER_INCLUDE_OWNERREFERENCE is intended to be used only for tests. It must always be enabled in production
+DSPO_APISERVER_INCLUDE_OWNERREFERENCE=true
diff --git a/config/internal/apiserver/default/deployment.yaml.tmpl b/config/internal/apiserver/default/deployment.yaml.tmpl
@@ -22,6 +22,16 @@ spec:
     spec:
       containers:
         - env:
+            {{ if .IncludeOwnerReference }}
+            - name: OWNER_UID
+              value: "{{.UID}}"
+            - name: OWNER_NAME
+              value: "{{.Name}}"
+            - name: OWNER_API_VERSION
+              value: "{{.APIVersion}}"
+            - name: OWNER_KIND
+              value: "{{.Kind}}"
+            {{ end }}
             - name: POD_NAMESPACE
               value: "{{.Namespace}}"
             - name: DBCONFIG_USER

diff --git a/controllers/config/defaults.go b/controllers/config/defaults.go
@@ -80,20 +80,21 @@ const (
 
 // DSPO Config File Paths
 const (
-	APIServerImagePath                  = "Images.ApiServer"
-	APIServerArtifactImagePath          = "Images.Artifact"
-	PersistenceAgentImagePath           = "Images.PersistentAgent"
-	ScheduledWorkflowImagePath          = "Images.ScheduledWorkflow"
-	APIServerCacheImagePath             = "Images.Cache"
-	APIServerMoveResultsImagePath       = "Images.MoveResultsImage"
-	MariaDBImagePath                    = "Images.MariaDB"
-	OAuthProxyImagePath                 = "Images.OAuthProxy"
-	MlmdEnvoyImagePath                  = "Images.MlmdEnvoy"
-	MlmdGRPCImagePath                   = "Images.MlmdGRPC"
-	MlmdWriterImagePath                 = "Images.MlmdWriter"
-	ObjStoreConnectionTimeoutConfigName = "DSPO.HealthCheck.ObjectStore.ConnectionTimeout"
-	DBConnectionTimeoutConfigName       = "DSPO.HealthCheck.Database.ConnectionTimeout"
-	RequeueTimeConfigName               = "DSPO.RequeueTime"
+	APIServerImagePath                       = "Images.ApiServer"
+	APIServerArtifactImagePath               = "Images.Artifact"
+	PersistenceAgentImagePath                = "Images.PersistentAgent"
+	ScheduledWorkflowImagePath               = "Images.ScheduledWorkflow"
+	APIServerCacheImagePath                  = "Images.Cache"
+	APIServerMoveResultsImagePath            = "Images.MoveResultsImage"
+	MariaDBImagePath                         = "Images.MariaDB"
+	OAuthProxyImagePath                      = "Images.OAuthProxy"
+	MlmdEnvoyImagePath                       = "Images.MlmdEnvoy"
+	MlmdGRPCImagePath                        = "Images.MlmdGRPC"
+	MlmdWriterImagePath                      = "Images.MlmdWriter"
+	ObjStoreConnectionTimeoutConfigName      = "DSPO.HealthCheck.ObjectStore.ConnectionTimeout"
+	DBConnectionTimeoutConfigName            = "DSPO.HealthCheck.Database.ConnectionTimeout"
+	RequeueTimeConfigName                    = "DSPO.RequeueTime"
+	ApiServerIncludeOwnerReferenceConfigName = "DSPO.ApiServer.IncludeOwnerReference"
 )
 
 // DSPV2-Argo Image Paths
@@ -172,6 +173,8 @@ const DefaultMaxConcurrentReconciles = 10
 
 const DefaultRequeueTime = time.Second * 20
 
+const DefaultApiServerIncludeOwnerReferenceConfigName = true
+
 func GetConfigRequiredFields() []string {
 	return requiredFields
 }
@@ -218,6 +221,13 @@ func GetDurationConfigWithDefault(configName string, value time.Duration) time.D
 	return viper.GetDuration(configName)
 }
 
+func GetBoolConfigWithDefault(configName string, value bool) bool {
+	if !viper.IsSet(configName) {
+		return value
+	}
+	return viper.GetBool(configName)
+}
+
 // GetCABundleFileMountPath provides the location in pipeline step-copy-artifact step where the
 // ca bundle is mounted for aws cli to connect to s3 store.
 // Since pipeline step-copy-artifact step uses aws cli, and there are issues surrounding

diff --git a/controllers/dspipeline_params.go b/controllers/dspipeline_params.go
@@ -42,7 +42,11 @@ import (
 )
 
 type DSPAParams struct {
+	IncludeOwnerReference                bool
+	UID                                  types.UID
 	Name                                 string
+	APIVersion                           string
+	Kind                                 string
 	Namespace                            string
 	Owner                                mf.Owner
 	DSPVersion                           string
@@ -538,6 +542,17 @@ func (p *DSPAParams) SetupMLMD(dsp *dspa.DataSciencePipelinesApplication, log lo
 	return nil
 }
 
+func (p *DSPAParams) SetupOwner(dsp *dspa.DataSciencePipelinesApplication) {
+	p.IncludeOwnerReference = config.GetBoolConfigWithDefault(config.ApiServerIncludeOwnerReferenceConfigName, config.DefaultApiServerIncludeOwnerReferenceConfigName)
+
+	if p.IncludeOwnerReference {
+		p.UID = dsp.UID
+		p.Name = dsp.Name
+		p.APIVersion = dsp.APIVersion
+		p.Kind = dsp.Kind
+	}
+}
+
 func setStringDefault(defaultValue string, value *string) {
 	if *value == "" {
 		*value = defaultValue
@@ -801,5 +816,7 @@ func (p *DSPAParams) ExtractParams(ctx context.Context, dsp *dspa.DataSciencePip
 		return err
 	}
 
+	p.SetupOwner(dsp)
+
 	return nil
 }
diff --git a/controllers/testdata/declarative/case_0/config.yaml b/controllers/testdata/declarative/case_0/config.yaml
@@ -10,3 +10,6 @@ Images:
   MariaDB: mariadb:test0
   Minio: minio:test0
   OAuthProxy: oauth-proxy:test0
+DSPO:
+  ApiServer:
+    IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_2/config.yaml b/controllers/testdata/declarative/case_2/config.yaml
@@ -8,3 +8,6 @@ Images:
   MoveResultsImage: busybox:test2
   MariaDB: mariadb:test2
   OAuthProxy: oauth-proxy:test2
+DSPO:
+  ApiServer:
+    IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_3/config.yaml b/controllers/testdata/declarative/case_3/config.yaml
@@ -8,3 +8,6 @@ Images:
   MoveResultsImage: busybox:test3
   MariaDB: mariadb:test3
   OAuthProxy: oauth-proxy:test3
+DSPO:
+  ApiServer:
+    IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_4/config.yaml b/controllers/testdata/declarative/case_4/config.yaml
@@ -8,3 +8,6 @@ Images:
   MoveResultsImage: this-busybox-image-from-config-should-not-be-used:test4
   MariaDB: this-mariadb-image-from-config-should-not-be-used:test4
   OAuthProxy: oauth-proxy:test4
+DSPO:
+  ApiServer:
+    IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_5/config.yaml b/controllers/testdata/declarative/case_5/config.yaml
@@ -13,3 +13,6 @@ Images:
   MlmdEnvoy: metadata-envoy:changeme
   MlmdGrpc: metadata-grpc:changeme
   MlmdWriter: metadata-grpc:changeme
+DSPO:
+  ApiServer:
+    IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_6/config.yaml b/controllers/testdata/declarative/case_6/config.yaml
@@ -16,3 +16,6 @@ ImagesV2:
     ArgoLauncherImage: argolauncherimage:test6
     ArgoDriverImage: argodriverimage:test6
     MlmdGRPC: quay.io/opendatahub/mlmd-grpc-server:testdsp6
+DSPO:
+  ApiServer:
+    IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_7/config.yaml b/controllers/testdata/declarative/case_7/config.yaml
@@ -10,3 +10,6 @@ Images:
   MariaDB: mariadb:test7
   Minio: minio:test7
   OAuthProxy: oauth-proxy:test7
+DSPO:
+  ApiServer:
+    IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_8/config.yaml b/controllers/testdata/declarative/case_8/config.yaml
@@ -15,3 +15,6 @@ ImagesV2:
     ApiServer: api-server:test8
     ArgoLauncherImage: argolauncherimage:test8
     ArgoDriverImage: argodriverimage:test8
+DSPO:
+  ApiServer:
+    IncludeOwnerReference: false