Automation layout scaffolding

README.md

@@ -158,6 +158,8 @@ spec:
       weeklySnapshotDay:   "WEDNESDAY"  # Day of the week for weekly snapshot
       monthlySnapshotDay:  24           # Day of the month for monthly snapshot
       quarterlySnapshotMonth: "Jan"     # Start month of the quarterly snapshot
+    additionalArguments:                # Optional black, can specify additional arguments that are unique to database engines.
+      listener_port: 8080
 
 ```
 
@@ -176,6 +178,37 @@ kubectl delete -f config/samples/ndb_v1alpha1_database.yaml
 ```sh
 kubectl delete -f config/samples/ndb_v1alpha1_ndbserver.yaml
 ```
+Below are the various optional addtionalArguments you can specify along with examples of their corresponding values. Arguments that have defaults will be indicated.
+
+```yaml
+# PostGres
+additionalArguments:
+  listener_port: "1111"                            # Default: "5432"
+
+# MySQL
+additionalArguments:
+  listener_port: "1111"                            # Default: "3306" 
+
+# MongoDB
+additionalArguments:
+  listener_port: "1111"                            # Default: "27017"
+  log_size: "150"                                  # Default: "100"
+  journal_size: "150"                              # Default: "100"
+
+# MSSQL
+additionalArguments:
+  sql_user_name: "mazin"                           # Defualt: "sa".
+  authentication_mode: "mixed"                     # Default: "windows". Options are "windows" or "mixed". Must specify sql_user.
+  server_collation: "<server-collation>"           # Default: "SQL_Latin1_General_CP1_CI_AS".
+  database_collation:  "<server-collation>"        # Default: "SQL_Latin1_General_CP1_CI_AS".
+  dbParameterProfileIdInstance: "<id-instance>"    # Default: Fetched from profile.
+  vm_dbserver_admin_password: "<admin-password>"   # Default: Fetched from database secret.
+  sql_user_password:         "<sq-user-password>"  # NO Default. Must specify authentication_mode as "mixed".
+  windows_domain_profile_id: <domain-profile-id>   # NO Default. Must specify vm_db_server_user.
+  vm_db_server_user: <vm-db-server-use>            # NO Default. Must specify windows_domain_profile_id.
+  vm_win_license_key: <licenseKey>                 # NO Default.
+```
+
 ## Developement
 
 ### Installation and Running the controller locally

api/v1alpha1/database_types.go

@@ -98,6 +98,9 @@ type Instance struct {
 	// +optional
 	// Information related to time machine that is to be associated with this database
 	TMInfo *DBTimeMachineInfo `json:"timeMachine"`
+	// +optional
+	// Additional database engine specific arguments
+	AdditionalArguments map[string]string `json:"additionalArguments"`
 }
 
 // Time Machine details

api/v1alpha1/database_webhook.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"reflect"
 	"regexp"
+	"strings"
 
 	"github.com/nutanix-cloud-native/ndb-operator/api"
 	"github.com/nutanix-cloud-native/ndb-operator/common"
@@ -106,6 +107,11 @@ func instanceSpecDefaulterForCreate(instance *Instance) {
 		instance.TMInfo.QuarterlySnapshotMonth = "Jan"
 	}
 
+	// additional arguments defaulting logic
+	if instance.AdditionalArguments == nil {
+		databaselog.Info("Initializing empty additional db arguments...")
+		instance.AdditionalArguments = map[string]string{}
+	}
 }
 
 // Default implements webhook.Defaulter so a webhook will be registered for the type
@@ -188,10 +194,47 @@ func instanceSpecValidatorForCreate(instance *Instance, allErrs field.ErrorList,
 		))
 	}
 
+	if err := additionalArgumentsValidationCheck(instance.Type, instance.AdditionalArguments); err != nil {
+		allErrs = append(allErrs, field.Invalid(instancePath.Child("additionalArguments"), instance.AdditionalArguments, err.Error()))
+	}
+
 	databaselog.Info("Exiting instanceSpecValidatorForCreate...")
 	return allErrs
 }
 
+/* Checks if configured additional arguments are valid or not and returns the corresponding additional arguments. If error is nil valid, else invalid */
+func additionalArgumentsValidationCheck(dbType string, specifiedAdditionalArguments map[string]string) error {
+	// Empty additionalArguments is always valid
+	if specifiedAdditionalArguments == nil {
+		return nil
+	}
+
+	allowedAdditionalArguments, err := util.GetAllowedAdditionalArgumentsForType(dbType)
+
+	// Invalid type returns error
+	if err != nil {
+		return err
+	}
+
+	// Checking if arguments are valid
+	invalidArgs := []string{}
+	for name, _ := range specifiedAdditionalArguments {
+		if _, isPresent := allowedAdditionalArguments[name]; !isPresent {
+			invalidArgs = append(invalidArgs, name)
+		}
+	}
+
+	if len(invalidArgs) == 0 {
+		return nil
+	} else {
+		return fmt.Errorf(
+			"Additional Arguments validation for database type: %s failed! The following args are invalid: %s. These are the allowed args: %s",
+			dbType,
+			strings.Join(invalidArgs, ", "),
+			reflect.ValueOf(allowedAdditionalArguments).MapKeys())
+	}
+}
+
 // ValidateCreate implements webhook.Validator so a webhook will be registered for the type
 func (r *Database) ValidateCreate() (admission.Warnings, error) {
 	databaselog.Info("Entering ValidateCreate...")