New stuff

PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: oracle.com
 layout:
 - go.kubebuilder.io/v2
@@ -67,6 +71,10 @@ resources:
   kind: ShardingDatabase
   path: github.com/oracle/oracle-database-operator/apis/database/v1alpha1
   version: v1alpha1
+  webhooks:
+    defaulting: true
+    validation: true
+    webhookVersion: v1beta1
 - api:
     crdVersion: v1
     namespaced: true

apis/database/v1alpha1/shardingdatabase_webhook.go

@@ -0,0 +1,155 @@
+/*
+** Copyright (c) 2022 Oracle and/or its affiliates.
+**
+** The Universal Permissive License (UPL), Version 1.0
+**
+** Subject to the condition set forth below, permission is hereby granted to any
+** person obtaining a copy of this software, associated documentation and/or data
+** (collectively the "Software"), free of charge and under any and all copyright
+** rights in the Software, and any and all patent rights owned or freely
+** licensable by each licensor hereunder covering either (i) the unmodified
+** Software as contributed to or provided by such licensor, or (ii) the Larger
+** Works (as defined below), to deal in both
+**
+** (a) the Software, and
+** (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+** one is included with the Software (each a "Larger Work" to which the Software
+** is contributed by such licensors),
+**
+** without restriction, including without limitation the rights to copy, create
+** derivative works of, display, perform, and distribute the Software and make,
+** use, sell, offer for sale, import, export, have made, and have sold the
+** Software and the Larger Work(s), and to sublicense the foregoing rights on
+** either these or other terms.
+**
+** This license is subject to the following condition:
+** The above copyright notice and either this complete permission notice or at
+** a minimum a reference to the UPL must be included in all copies or
+** substantial portions of the Software.
+**
+** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+** OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+** SOFTWARE.
+ */
+
+package v1alpha1
+
+import (
+	"strings"
+
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/util/validation/field"
+	ctrl "sigs.k8s.io/controller-runtime"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/webhook"
+	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
+)
+
+// log is for logging in this package.
+var shardingdatabaselog = logf.Log.WithName("shardingdatabase-resource")
+
+func (r *ShardingDatabase) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	return ctrl.NewWebhookManagedBy(mgr).
+		For(r).
+		Complete()
+}
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+
+//+kubebuilder:webhook:path=/mutate-database-oracle-com-v1alpha1-shardingdatabase,mutating=true,failurePolicy=fail,groups=database.oracle.com,resources=shardingdatabases,verbs=create;update,versions=v1alpha1,name=mshardingdatabase.kb.io
+
+var _ webhook.Defaulter = &ShardingDatabase{}
+
+// Default implements webhook.Defaulter so a webhook will be registered for the type
+func (r *ShardingDatabase) Default() {
+	shardingdatabaselog.Info("default", "name", r.Name)
+
+	// TODO(user): fill in your defaulting logic.
+	if r.Spec.GsmDevMode != "" {
+		r.Spec.GsmDevMode = "dev"
+	}
+}
+
+// TODO(user): change verbs to "verbs=create;update;delete" if you want to enable deletion validation.
+//+kubebuilder:webhook:verbs=create;update,path=/validate-database-oracle-com-v1alpha1-shardingdatabase,mutating=false,failurePolicy=fail,groups=database.oracle.com,resources=shardingdatabases,versions=v1alpha1,name=vshardingdatabase.kb.io,admissionReviewVersions={v1,v1beta1}
+
+var _ webhook.Validator = &ShardingDatabase{}
+
+// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
+func (r *ShardingDatabase) ValidateCreate() (admission.Warnings, error) {
+	shardingdatabaselog.Info("validate create", "name", r.Name)
+
+	// TODO(user): fill in your validation logic upon object creation.
+	// Check Secret configuration
+	var validationErr field.ErrorList
+
+	//namespaces := db.GetWatchNamespaces()
+	//_, containsNamespace := namespaces[r.Namespace]
+	// Check if the allowed namespaces maps contains the required namespace
+	//	if len(namespaces) != 0 && !containsNamespace {
+	//	validationErr = append(validationErr,
+	//		field.Invalid(field.NewPath("metadata").Child("namespace"), r.Namespace,
+	//			"Oracle database operator doesn't watch over this namespace"))
+	//}
+
+	if r.Spec.DbSecret == nil {
+		validationErr = append(validationErr,
+			field.Invalid(field.NewPath("spec").Child("DbSecret"), r.Spec.DbSecret,
+				"DbSecret cannot be set to nil"))
+	} else {
+		if len(r.Spec.DbSecret.Name) == 0 {
+			validationErr = append(validationErr,
+				field.Invalid(field.NewPath("spec").Child("DbSecret").Child("Name"), r.Spec.DbSecret.Name,
+					"Secret name cannot be set empty"))
+		}
+		if len(r.Spec.DbSecret.PwdFileName) == 0 {
+			validationErr = append(validationErr,
+				field.Invalid(field.NewPath("spec").Child("DbSecret").Child("PwdFileName"), r.Spec.DbSecret.PwdFileName,
+					"Password file name cannot be set empty"))
+		}
+		if strings.ToLower(r.Spec.DbSecret.EncryptionType) != "base64" {
+			if strings.ToLower(r.Spec.DbSecret.KeyFileName) == "" {
+				validationErr = append(validationErr,
+					field.Invalid(field.NewPath("spec").Child("DbSecret").Child("KeyFileName"), r.Spec.DbSecret.KeyFileName,
+						"Key file name cannot be empty"))
+			}
+		}
+		if len(r.Spec.DbSecret.PwdFileMountLocation) == 0 {
+			validationErr = append(validationErr,
+				field.Invalid(field.NewPath("spec").Child("DbSecret").Child("PwdFileMountLocation"), r.Spec.DbSecret.PwdFileMountLocation,
+					"Password file mount location cannot be empty"))
+		}
+
+		if len(r.Spec.DbSecret.KeyFileMountLocation) == 0 {
+			validationErr = append(validationErr,
+				field.Invalid(field.NewPath("spec").Child("DbSecret").Child("KeyFileMountLocation"), r.Spec.DbSecret.KeyFileMountLocation,
+					"KeyFileMountLocation file mount location cannot be empty"))
+		}
+	}
+
+	return nil, apierrors.NewInvalid(
+		schema.GroupKind{Group: "database.oracle.com", Kind: "ShardingDatabase"},
+		r.Name, validationErr)
+}
+
+// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
+func (r *ShardingDatabase) ValidateUpdate(old runtime.Object) (admission.Warnings, error) {
+	shardingdatabaselog.Info("validate update", "name", r.Name)
+
+	// TODO(user): fill in your validation logic upon object update.
+	return nil, nil
+}
+
+// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
+func (r *ShardingDatabase) ValidateDelete() (admission.Warnings, error) {
+	shardingdatabaselog.Info("validate delete", "name", r.Name)
+
+	// TODO(user): fill in your validation logic upon object deletion.
+	return nil, nil
+}

commons/sharding/catalog.go

@@ -43,9 +43,8 @@ import (
 	"reflect"
 	"strconv"
 
-	databasev1alpha1 "github.com/oracle/oracle-database-operator/apis/database/v1alpha1"
-
 	"github.com/go-logr/logr"
+	databasev1alpha1 "github.com/oracle/oracle-database-operator/apis/database/v1alpha1"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"

config/samples/kustomization.yaml

@@ -18,4 +18,5 @@ resources:
   - dbcs/database_v1alpha1_dbcssystem.yaml
   - database_v1alpha1_dataguardbroker.yaml
   - observability/databaseobserver.yaml
+- database_v1alpha1_shardingdatabase.yaml
   # +kubebuilder:scaffold:manifestskustomizesamples

controllers/database/shardingdatabase_controller.go

@@ -902,32 +902,6 @@ func (r *ShardingDatabaseReconciler) validateSpex(instance *databasev1alpha1.Sha
 			}
 		}
 
-		// Check Secret configuration
-		if instance.Spec.DbSecret == nil {
-			return fmt.Errorf("Secret specification cannot be null, you need to set secret details")
-		} else {
-			if len(instance.Spec.DbSecret.Name) == 0 {
-				return fmt.Errorf("instance.Spec.DbSecret.Name cannot be empty")
-			}
-			if len(instance.Spec.DbSecret.PwdFileName) == 0 {
-				return fmt.Errorf("instance.Spec.DbSecret.PwdFileName cannot be empty")
-			}
-			if strings.ToLower(instance.Spec.DbSecret.EncryptionType) != "base64" {
-				if strings.ToLower(instance.Spec.DbSecret.KeyFileName) == "" {
-					return fmt.Errorf("instance.Spec.DbSecret.KeyFileName cannot be empty")
-				}
-			}
-			if len(instance.Spec.DbSecret.PwdFileMountLocation) == 0 {
-				msg := "instance.Spec.DbSecret.PwdFileMountLocation is not set. Setting it to default " + shardingv1.GetSecretMount()
-				shardingv1.LogMessages("INFO", msg, nil, instance, r.Log)
-			}
-
-			if len(instance.Spec.DbSecret.KeyFileMountLocation) == 0 {
-				msg := "instance.Spec.DbSecret.KeyFileMountLocation is not set. Setting it to default " + shardingv1.GetSecretMount()
-				shardingv1.LogMessages("INFO", msg, nil, instance, r.Log)
-			}
-		}
-
 		// Once the initial Spec is been validated then update the last Sucessful Spec
 		err = instance.UpdateLastSuccessfulSpec(r.Client)
 		if err != nil {

docs/sharding/README.md

@@ -127,6 +127,23 @@ In this example, the deployment uses the YAML file based on `OCI OKE` cluster. T
 [6. Scale Out - Add Shards to an existing Oracle Sharded Database provisioned earlier with User Defined Sharding](./provisioning/user-defined-sharding/udsharding_scale_out_add_shards.md)  
 [7. Scale In - Delete an existing Shard from a working Oracle Sharded Database provisioned earlier with User Defined Sharding](./provisioning/user-defined-sharding/udsharding_scale_in_delete_an_existing_shard.md)
 
+
+## Provisioning Sharding Topology with System Sharding with SNR RAFT enabled in a Cloud-Based Kubernetes Cluster
+
+Deploy Oracle Database Sharding Topology with `System Sharding with SNR RAFT enabled` on your Cloud based Kubernetes cluster. 
+
+**NOTE: SNR RAFT Feature is available only for Oracle 23c RDBMS and Oracle 23c GSM version.**
+
+In this example, the deployment uses the YAML file based on `OCI OKE` cluster. There are multiple use case possible for deploying the Oracle Database Sharding Topology covered by below examples:
+
+[1. Provisioning Oracle Sharded Database with System Sharding with SNR RAFT enabled without Database Gold Image](./provisioning/snr_system_sharding/snr_ssharding_provisioning_without_db_gold_image.md)  
+[2. Provisioning Oracle Sharded Database with System Sharding with SNR RAFT enabled with additional control on resources like Memory and CPU allocated to Pods](./provisioning/snr_system_sharding/snr_ssharding_provisioning_with_control_on_resources.md)  
+[3. Provisioning Oracle Sharded Database with System Sharding with SNR RAFT enabled by cloning database from your own Database Gold Image in the same Availability Domain(AD)](./provisioning/snr_system_sharding/snr_ssharding_provisioning_by_cloning_db_gold_image_in_same_ad.md)  
+[4. Provisioning Oracle Sharded Database with System Sharding with SNR RAFT enabled by cloning database from your own Database Gold Image across Availability Domains(ADs)](./provisioning/snr_system_sharding/snr_ssharding_provisioning_by_cloning_db_from_gold_image_across_ads.md)  
+[5. Provisioning Oracle Sharded Database with System Sharding with SNR RAFT enabled and send Notification using OCI Notification Service](./provisioning/snr_system_sharding/snr_ssharding_provisioning_with_notification_using_oci_notification.md)  
+[6. Scale Out - Add Shards to an existing Oracle Sharded Database provisioned earlier with System Sharding with SNR RAFT enabled](./provisioning/snr_system_sharding/snr_ssharding_scale_out_add_shards.md)  
+[7. Scale In - Delete an existing Shard from a working Oracle Sharded Database provisioned earlier with System Sharding with SNR RAFT enabled](./provisioning/snr_system_sharding/snr_ssharding_scale_in_delete_an_existing_shard.md)
+
 ## Connecting to Shard Databases
 
 After the Oracle Database Sharding Topology has been provisioned using the Sharding Controller in Oracle Database Kubernetes Operator, you can follow the steps in this document to connect to the Sharded Database or to the individual Shards: [Database Connectivity](./provisioning/database_connection.md)

docs/sharding/provisioning/snr_system_sharding/snr_ssharding_provisioning_by_cloning_db_from_gold_image_across_ads.md

@@ -0,0 +1,55 @@
+# Provisioning Oracle Sharded Database with System Sharding with SNR RAFT enabled by cloning database from your own Database Gold Image across Availability Domains(ADs)
+
+**NOTE: SNR RAFT Feature is available only for Oracle 23c RDBMS and Oracle 23c GSM version.**
+
+**IMPORTANT:** Make sure you have completed the steps for [Prerequsites for Running Oracle Sharding Database Controller](../../README.md#prerequsites-for-running-oracle-sharding-database-controller) before using Oracle Sharding Controller.
+
+In this test case, you provision the Oracle Database sharding topology with System Sharding with SNR RAFT enabled while provisioning the Catalog and Shard Databases by cloning from an existing Oracle Database Gold Image created earlier.
+
+This use case applies when you want to provision the database Pods on a Kubernetes Node in any availability domain (AD), which can also be different from the availability domain (AD) of the Block Volume that has the Oracle Database Gold Image provisioned earlier.
+
+Choosing this option takes substantially less time during the Oracle Database Sharding Topology setup across ADs.
+
+NOTE:
+
+* Cloning from Block Volume Backup in OCI enables the new Persistent Volumes to be created in other ADs.
+* To specify the AD where you want to provision the database Pod, use the tag `nodeSelector` and the POD will be provisioned in a node running in that AD.
+* To specify GSM containers, you can also use the tag `nodeSelector` to specify the AD.
+* Before you can provision with the Gold Image, you need the OCID of the Persistent Volume that has the Oracle Database Gold Image.
+
+1. Check the OCID of the Persistent Volume provisioned for the Oracle Database Gold Image:
+    ```sh
+    kubectl get pv -n shns
+    ```
+2. Create a Block Volume Backup for this Block Volume, and use the OCID of the Block Volume Backup in the next step. This example uses `snr_ssharding_shard_prov_clone_across_ads.yaml` to provision an Oracle Database sharding topology using Oracle Sharding controller with:
+
+* Primary GSM Pods `gsm1` and standby GSM Pod `gsm2`
+* Three sharding Pods: `shard1`, `shard2` and `shard3`
+* One Catalog Pod: `catalog`
+* Namespace: `shns`
+* Database Cloning from the `BLOCK VOLUME FULL BACKUP` of the Persistent Volume which had the Gold Image.
+* OCID of the Block Volume Backup: `ocid1.volumebackup.oc1.phx.abyhqljrxtv7tu5swqb3lzc7vpzwbwzdktd2y4k2vjjy2srmgu2w7bqdftjq`
+* `SNR RAFT` enabled
+
+NOTE: In this case, the Persistent Volume with DB Gold Image was provisioned in the Availability Domain `PHX-AD-1`. The Shards and Catalog will be provisioned across multiple Availability Domains by cloning the database.
+
+In this example, we are using pre-built Oracle Database and Global Data Services container images available on [Oracle Container Registry](https://container-registry.oracle.com/)
+  * To pull the above images from Oracle Container Registry, create a Kubernetes secret named `ocr-reg-cred` using your credentials with type set to `kubernetes.io/dockerconfigjson` in the namespace `shns`.
+  * If you plan to use images built by you, you need to change `dbImage` and `gsmImage` tag with the images you have built in your enviornment in file `snr_ssharding_shard_prov_clone_across_ads.yaml`.
+  * The `dbImage` used during provisioning the Persistent Volume with Database Gold Image and the `dbImage` used for deploying the Shard or Catalog Database by cloning should be same.
+  * To understand the Pre-requisite of Database and Global Data Services docker images, refer [Oracle Database and Global Data Services Docker Images](../../README.md#3-oracle-database-and-global-data-services-docker-images)
+
+Use the file: [snr_ssharding_shard_prov_clone_across_ads.yaml](./snr_ssharding_shard_prov_clone_across_ads.yaml) for this use case as below:
+
+1. Deploy the `snr_ssharding_shard_prov_clone_across_ads.yaml` file:
+    ```sh
+    kubectl apply -f snr_ssharding_shard_prov_clone_across_ads.yaml
+    ```
+2. Check the status of the deployment:
+    ```sh
+    # Check the status of the Kubernetes Pods:
+    kubectl get all -n shns
+
+    # Check the logs of a particular pod. For example, to check status of pod "shard1-0":
+    kubectl logs -f pod/shard1-0 -n shns
+