Merge branch 'idesai_23c_free_support_sidb_operator' into 'master'

Idesai 23c free support sidb operator

See merge request rac-docker-dev/oracle-database-operator!245

Author: yunus-qureshi

apis/database/v1alpha1/singleinstancedatabase_types.go

@@ -50,7 +50,7 @@ type SingleInstanceDatabaseSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
 
-	// +kubebuilder:validation:Enum=standard;enterprise;express
+	// +kubebuilder:validation:Enum=standard;enterprise;express;free
 	Edition string `json:"edition,omitempty"`
 
 	// SID must be alphanumeric (no special characters, only a-z, A-Z, 0-9), and no longer than 12 characters.

apis/database/v1alpha1/singleinstancedatabase_webhook.go

@@ -86,6 +86,8 @@ func (r *SingleInstanceDatabase) Default() {
 	if r.Spec.Sid == "" {
 		if r.Spec.Edition == "express" {
 			r.Spec.Sid = "XE"
+		} else if r.Spec.Edition == "free" {
+			r.Spec.Sid = "FREE"
 		} else {
 			r.Spec.Sid = "ORCLCDB"
 		}
@@ -94,12 +96,14 @@ func (r *SingleInstanceDatabase) Default() {
 	if r.Spec.Pdbname == "" {
 		if r.Spec.Edition == "express" {
 			r.Spec.Pdbname = "XEPDB1"
+		} else if r.Spec.Edition == "free" {
+			r.Spec.Pdbname = "FREEPDB1"
 		} else {
 			r.Spec.Pdbname = "ORCLPDB1"
 		}
 	}
 
-	if r.Spec.Edition == "express" {
+	if r.Spec.Edition == "express" || r.Spec.Edition == "free" {
 		if r.Status.Replicas == 1 {
 			// default the replicas for XE
 			r.Spec.Replicas = 1
@@ -147,8 +151,8 @@ func (r *SingleInstanceDatabase) ValidateCreate() error {
 	// Replica validation
 	if r.Spec.Replicas > 1 {
 		valMsg := ""
-		if r.Spec.Edition == "express" {
-			valMsg = "should be 1 for express edition"
+		if r.Spec.Edition == "express" || r.Spec.Edition == "free" {
+			valMsg = "should be 1 for " + r.Spec.Edition + " edition"
 		}
 		if r.Spec.Persistence.Size == "" {
 			valMsg = "should be 1 if no persistence is specified"
@@ -158,54 +162,69 @@ func (r *SingleInstanceDatabase) ValidateCreate() error {
 				field.Invalid(field.NewPath("spec").Child("replicas"), r.Spec.Replicas, valMsg))
 		}
 	}
-
-	if r.Spec.Edition == "express" {
+	
+	if r.Spec.Edition == "express" || r.Spec.Edition == "free" {
 		if r.Spec.CloneFrom != "" {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("cloneFrom"), r.Spec.CloneFrom,
-					"Cloning not supported for Express edition"))
+					"Cloning not supported for " + r.Spec.Edition + " edition"))
 		}
 		if r.Spec.CreateAsStandby {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("createAsStandby"), r.Spec.CreateAsStandby,
-					"Physical Standby Database creation is not supported for Express edition"))
+					"Physical Standby Database creation is not supported for " + r.Spec.Edition + " edition"))
 		}
-		if strings.ToUpper(r.Spec.Sid) != "XE" {
+		if r.Spec.Edition == "express" && strings.ToUpper(r.Spec.Sid) != "XE" {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("sid"), r.Spec.Sid,
 					"Express edition SID must only be XE"))
 		}
-		if strings.ToUpper(r.Spec.Pdbname) != "XEPDB1" {
+		if r.Spec.Edition == "free" && strings.ToUpper(r.Spec.Sid) != "FREE" {
+			allErrs = append(allErrs,
+				field.Invalid(field.NewPath("spec").Child("sid"), r.Spec.Sid,
+					"Free edition SID must only be FREE"))
+		}
+		if r.Spec.Edition == "express" && strings.ToUpper(r.Spec.Pdbname) != "XEPDB1" {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("pdbName"), r.Spec.Pdbname,
 					"Express edition PDB must be XEPDB1"))
 		}
+		if r.Spec.Edition == "free" && strings.ToUpper(r.Spec.Pdbname) != "FREEPDB1" {
+			allErrs = append(allErrs,
+				field.Invalid(field.NewPath("spec").Child("pdbName"), r.Spec.Pdbname,
+					"Free edition PDB must be FREEPDB1"))
+		}
 		if r.Spec.InitParams.CpuCount != 0 {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("initParams").Child("cpuCount"), r.Spec.InitParams.CpuCount,
-					"Express edition does not support changing init parameter cpuCount."))
+					r.Spec.Edition + " edition does not support changing init parameter cpuCount."))
 		}
 		if r.Spec.InitParams.Processes != 0 {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("initParams").Child("processes"), r.Spec.InitParams.Processes,
-					"Express edition does not support changing init parameter process."))
+					r.Spec.Edition + " edition does not support changing init parameter process."))
 		}
 		if r.Spec.InitParams.SgaTarget != 0 {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("initParams").Child("sgaTarget"), r.Spec.InitParams.SgaTarget,
-					"Express edition does not support changing init parameter sgaTarget."))
+					r.Spec.Edition + " edition does not support changing init parameter sgaTarget."))
 		}
 		if r.Spec.InitParams.PgaAggregateTarget != 0 {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("initParams").Child("pgaAggregateTarget"), r.Spec.InitParams.PgaAggregateTarget,
-					"Express edition does not support changing init parameter pgaAggregateTarget."))
+					r.Spec.Edition + " edition does not support changing init parameter pgaAggregateTarget."))
 		}
 	} else {
 		if r.Spec.Sid == "XE" {
 			allErrs = append(allErrs,
 				field.Invalid(field.NewPath("spec").Child("sid"), r.Spec.Sid,
 					"XE is reserved as the SID for Express edition of the database"))
 		}
+		if r.Spec.Sid == "FREE" {
+			allErrs = append(allErrs,
+				field.Invalid(field.NewPath("spec").Child("sid"), r.Spec.Sid,
+					"FREE is reserved as the SID for FREE edition of the database"))
+		}
 	}
 
 	if r.Spec.CloneFrom != "" {

config/samples/sidb/singleinstancedatabase_free.yaml

@@ -0,0 +1,38 @@
+#
+# Copyright (c) 2023, Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+#
+
+apiVersion: database.oracle.com/v1alpha1
+kind: SingleInstanceDatabase
+metadata:
+  name: freedb-sample
+  namespace: default
+spec:
+  
+  ## Use only alphanumeric characters for sid
+  sid: FREE
+  
+  ## DB edition
+  edition: free
+  
+  ## Secret containing SIDB password mapped to secretKey
+  adminPassword:
+    secretName: freedb-admin-secret
+
+  ## Database image details
+  image:
+    pullFrom: container-registry.oracle.com/database/free:latest
+    prebuiltDB: true
+
+  ## size is the required minimum size of the persistent volume
+  ## storageClass is specified for automatic volume provisioning
+  ## accessMode can only accept one of ReadWriteOnce, ReadWriteMany
+  persistence:
+    size: 50Gi
+    ## oci-bv applies to OCI block volumes. Use "standard" storageClass for dynamic provisioning in Minikube. Update as appropriate for other cloud service providers
+    storageClass: "oci-bv"
+    accessMode: "ReadWriteOnce"
+
+  ## Count of Database Pods. Should be 1 for express edition.
+  replicas: 1

config/samples/sidb/singleinstancedatabase_prebuiltdb.yaml

@@ -11,15 +11,15 @@ metadata:
 spec:
 
   ## DB edition
-  edition: express
+  edition: free
 
   ## Secret containing SIDB password mapped to secretKey
   adminPassword:
     secretName: prebuiltdb-admin-secret
 
   ## Database Image
   image:
-    pullFrom: container-registry.oracle.com/database/express:latest
+    pullFrom: container-registry.oracle.com/database/free:latest
     prebuiltDB: true
 
   ## Persistence is optional for prebuilt DB image

config/samples/sidb/singleinstancedatabase_secrets.yaml

@@ -39,3 +39,16 @@ type: Opaque
 stringData:
   ## Specify your DB password here
   oracle_pwd:
+
+---
+
+## Prebuilt-Database Admin password secret
+apiVersion: v1
+kind: Secret
+metadata:
+  name: freedb-admin-secret
+  namespace: default
+type: Opaque
+stringData:
+  ## Specify your DB password here
+  oracle_pwd:

controllers/database/singleinstancedatabase_controller.go

@@ -85,6 +85,8 @@ var futureRequeue ctrl.Result = requeueN
 
 const singleInstanceDatabaseFinalizer = "database.oracle.com/singleinstancedatabasefinalizer"
 
+var oemExpressUrl string
+
 //+kubebuilder:rbac:groups=database.oracle.com,resources=singleinstancedatabases,verbs=get;list;watch;create;update;patch;delete
 //+kubebuilder:rbac:groups=database.oracle.com,resources=singleinstancedatabases/status,verbs=get;update;patch
 //+kubebuilder:rbac:groups=database.oracle.com,resources=singleinstancedatabases/finalizers,verbs=update
@@ -369,9 +371,9 @@ func (r *SingleInstanceDatabaseReconciler) validate(m *dbapi.SingleInstanceDatab
 		}
 	}
 
-	//  If Express Edition, ensure Replicas=1
-	if m.Spec.Edition == "express" && m.Spec.Replicas > 1 {
-		eventMsgs = append(eventMsgs, "express edition supports only one replica")
+	//  If Express/Free Edition, ensure Replicas=1
+	if (m.Spec.Edition == "express" || m.Spec.Edition == "free") && m.Spec.Replicas > 1 {
+		eventMsgs = append(eventMsgs, m.Spec.Edition + " edition supports only one replica")
 	}
 	//  If no persistence, ensure Replicas=1
 	if m.Spec.Persistence.Size == "" && m.Spec.Replicas > 1 {
@@ -394,11 +396,11 @@ func (r *SingleInstanceDatabaseReconciler) validate(m *dbapi.SingleInstanceDatab
 			m.Status.CloneFrom != dbcommons.NoCloneRef && m.Status.CloneFrom != m.Spec.CloneFrom) {
 		eventMsgs = append(eventMsgs, "cloneFrom cannot be updated")
 	}
-	if m.Spec.Edition == "express" && m.Spec.CloneFrom != "" {
-		eventMsgs = append(eventMsgs, "cloning not supported for express edition")
+	if (m.Spec.Edition == "express" || m.Spec.Edition == "free") && m.Spec.CloneFrom != "" {
+		eventMsgs = append(eventMsgs, "cloning not supported for " + m.Spec.Edition + " edition")
 	}
-	if m.Spec.Edition == "express" && m.Spec.PrimaryDatabaseRef != "" && m.Spec.CreateAsStandby {
-		eventMsgs = append(eventMsgs, "Standby database creation is not supported for express edition")
+	if (m.Spec.Edition == "express" || m.Spec.Edition == "free") && m.Spec.PrimaryDatabaseRef != "" && m.Spec.CreateAsStandby {
+		eventMsgs = append(eventMsgs, "Standby database creation is not supported for " + m.Spec.Edition + " edition")
 	}
 	if m.Status.OrdsReference != "" && m.Status.Persistence.Size != "" && m.Status.Persistence != m.Spec.Persistence {
 		eventMsgs = append(eventMsgs, "uninstall ORDS to change Peristence")
@@ -665,8 +667,8 @@ func (r *SingleInstanceDatabaseReconciler) instantiatePodSpec(m *dbapi.SingleIns
 						})
 					}
 				}
-				/* Wallet only for non-express edition, non-prebuiltDB */
-				if m.Spec.Edition != "express" && !m.Spec.Image.PrebuiltDB {
+				/* Wallet only for edition barring express and free editions, non-prebuiltDB */
+				if (m.Spec.Edition != "express" && m.Spec.Edition != "free") && !m.Spec.Image.PrebuiltDB {
 					initContainers = append(initContainers, corev1.Container{
 						Name:  "init-wallet",
 						Image: m.Spec.Image.PullFrom,
@@ -766,7 +768,7 @@ func (r *SingleInstanceDatabaseReconciler) instantiatePodSpec(m *dbapi.SingleIns
 				}(),
 				Env: func() []corev1.EnvVar {
 					// adding XE support, useful for dev/test/CI-CD
-					if m.Spec.Edition == "express" {
+					if m.Spec.Edition == "express" || m.Spec.Edition == "free" {
 						return []corev1.EnvVar{
 							{
 								Name:  "SVC_HOST",
@@ -1481,7 +1483,7 @@ func (r *SingleInstanceDatabaseReconciler) createOrReplaceSVC(ctx context.Contex
 			}
 			m.Status.ConnectString = lbAddress + ":" + fmt.Sprint(extSvc.Spec.Ports[1].Port) + "/" + strings.ToUpper(sid)
 			m.Status.PdbConnectString = lbAddress + ":" + fmt.Sprint(extSvc.Spec.Ports[1].Port) + "/" + strings.ToUpper(pdbName)
-			m.Status.OemExpressUrl = "https://" + lbAddress + ":" + fmt.Sprint(extSvc.Spec.Ports[0].Port) + "/em"
+			oemExpressUrl = "https://" + lbAddress + ":" + fmt.Sprint(extSvc.Spec.Ports[0].Port) + "/em"
 			if m.Spec.EnableTCPS {
 				m.Status.TcpsConnectString = lbAddress + ":" + fmt.Sprint(extSvc.Spec.Ports[len(extSvc.Spec.Ports)-1].Port) + "/" + strings.ToUpper(sid)
 				m.Status.TcpsPdbConnectString = lbAddress + ":" + fmt.Sprint(extSvc.Spec.Ports[len(extSvc.Spec.Ports)-1].Port) + "/" + strings.ToUpper(pdbName)
@@ -1493,7 +1495,7 @@ func (r *SingleInstanceDatabaseReconciler) createOrReplaceSVC(ctx context.Contex
 		if nodeip != "" {
 			m.Status.ConnectString = nodeip + ":" + fmt.Sprint(extSvc.Spec.Ports[1].NodePort) + "/" + strings.ToUpper(sid)
 			m.Status.PdbConnectString = nodeip + ":" + fmt.Sprint(extSvc.Spec.Ports[1].NodePort) + "/" + strings.ToUpper(pdbName)
-			m.Status.OemExpressUrl = "https://" + nodeip + ":" + fmt.Sprint(extSvc.Spec.Ports[0].NodePort) + "/em"
+			oemExpressUrl = "https://" + nodeip + ":" + fmt.Sprint(extSvc.Spec.Ports[0].NodePort) + "/em"
 			if m.Spec.EnableTCPS {
 				m.Status.TcpsConnectString = nodeip + ":" + fmt.Sprint(extSvc.Spec.Ports[len(extSvc.Spec.Ports)-1].NodePort) + "/" + strings.ToUpper(sid)
 				m.Status.TcpsPdbConnectString = nodeip + ":" + fmt.Sprint(extSvc.Spec.Ports[len(extSvc.Spec.Ports)-1].NodePort) + "/" + strings.ToUpper(pdbName)
@@ -1701,8 +1703,8 @@ func (r *SingleInstanceDatabaseReconciler) createOrReplacePods(m *dbapi.SingleIn
 // #############################################################################
 func (r *SingleInstanceDatabaseReconciler) createWallet(m *dbapi.SingleInstanceDatabase, ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 
-	// Wallet not supported for XE Database
-	if m.Spec.Edition == "express" {
+	// Wallet not supported for Express/Free Database
+	if m.Spec.Edition == "express" || m.Spec.Edition == "free" {
 		return requeueN, nil
 	}
 
@@ -2016,6 +2018,16 @@ func (r *SingleInstanceDatabaseReconciler) validateDBReadiness(m *dbapi.SingleIn
 			m.Status.ReleaseUpdate = version
 		}
 	}
+	oemSupport, err := isOEMSupported(r,m.Status.ReleaseUpdate)
+	if err != nil {
+		r.Log.Error(err, err.Error())
+		return requeueY, readyPod, err
+	}
+	if oemSupport {
+		m.Status.OemExpressUrl = oemExpressUrl
+	} else {
+		m.Status.OemExpressUrl = dbcommons.ValueUnavailable
+	}
 
 	if strings.ToUpper(m.Status.Role) == "PRIMARY" && m.Status.DatafilesPatched != "true" {
 		eventReason := "Datapatch Pending"
@@ -2034,8 +2046,8 @@ func (r *SingleInstanceDatabaseReconciler) validateDBReadiness(m *dbapi.SingleIn
 // #############################################################################
 func (r *SingleInstanceDatabaseReconciler) deleteWallet(m *dbapi.SingleInstanceDatabase, ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 
-	// Wallet not supported for XE Database
-	if m.Spec.Edition == "express" {
+	// Wallet not supported for Express/Free Database
+	if m.Spec.Edition == "express" || m.Spec.Edition == "free" {
 		return requeueN, nil
 	}
 
@@ -2250,9 +2262,9 @@ func (r *SingleInstanceDatabaseReconciler) runDatapatch(m *dbapi.SingleInstanceD
 	readyPod corev1.Pod, ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 
 	// Datapatch not supported for XE Database
-	if m.Spec.Edition == "express" {
+	if m.Spec.Edition == "express" || m.Spec.Edition == "free" {
 		eventReason := "Datapatch Check"
-		eventMsg := "datapatch not supported for express edition"
+		eventMsg := "datapatch not supported for " + m.Spec.Edition + " edition"
 		r.Recorder.Eventf(m, corev1.EventTypeNormal, eventReason, eventMsg)
 		r.Log.Info(eventMsg)
 		return requeueN, nil
@@ -3074,3 +3086,19 @@ func SetupStandbyDatabase(r *SingleInstanceDatabaseReconciler, stdby *dbapi.Sing
 
 	return nil
 }
+
+
+func isOEMSupported (r *SingleInstanceDatabaseReconciler,version string) (bool,error) {
+	majorVersion, err := strconv.Atoi(strings.Split(version,".")[0])
+	r.Log.Info("majorVersion of database is " + strconv.Itoa(majorVersion))
+	if err != nil {
+		return false,err
+	}
+	if majorVersion > 21{
+		r.Log.Info("major Version " + strconv.Itoa(majorVersion) +  " is greater that 21 so OEM Express is not supported")
+		return false,nil
+	} else {
+		r.Log.Info("major Version " + strconv.Itoa(majorVersion) + " is lesser than equal to 21 so OEM Express is supported")
+		return true,nil
+	}
+}