Extend Operator to PSQL-HA

README.md

@@ -156,7 +156,9 @@ spec:
     size: 10
     timezone: "UTC"
     type: postgres
-
+    # isHighAvailability is an optional parameter. In case nothing is specified, it is set to false
+    isHighAvailability: false
+
     # You can specify any (or none) of these types of profiles: compute, software, network, dbParam
     # If not specified, the corresponding Out-of-Box (OOB) profile will be used wherever applicable
     # Name is case-sensitive. ID is the UUID of the profile. Profile should be in the "READY" state
@@ -214,6 +216,9 @@ spec:
     # Cluster id of the cluster where the Database has to be provisioned
     # Can be fetched from the GET /clusters endpoint
     clusterId: "Nutanix Cluster Id"
+    # isHighAvailability is an optional parameter. In case nothing is specified, it is set to false
+    isHighAvailability: false
+
     # You can specify any (or none) of these types of profiles: compute, software, network, dbParam
     # If not specified, the corresponding Out-of-Box (OOB) profile will be used wherever applicable
     # Name is case-sensitive. ID is the UUID of the profile. Profile should be in the "READY" state

api/v1alpha1/database_types.go

@@ -107,6 +107,23 @@ type Instance struct {
 	// +optional
 	// Additional database engine specific arguments
 	AdditionalArguments map[string]string `json:"additionalArguments"`
+	// +optional
+	IsHighAvailability bool `json:"isHighAvailability"`
+	// +optional
+	Nodes []*Node `json:"nodes,omitempty"`
+}
+type Node struct {
+	// +optional
+	VmName     string         `json:"vmName"`
+	Properties NodeProperties `json:"properties"`
+}
+
+type NodeProperties struct {
+	NodeType string `json:"node_type"`
+	// +optional
+	Role string `json:"role"`
+	// +optional
+	FailoverMode string `json:"failover_mode"`
 }
 
 type Clone struct {
@@ -133,6 +150,10 @@ type Clone struct {
 	// +optional
 	// Additional database engine specific arguments
 	AdditionalArguments map[string]string `json:"additionalArguments"`
+	// +optional
+	IsHighAvailability bool `json:"isHighAvailability"`
+	// +optional
+	Nodes []*Node `json:"nodes,omitempty"`
 }
 
 // Time Machine details

api/v1alpha1/webhook_suite_test.go

@@ -60,6 +60,7 @@ const (
 	CREDENTIAL_SECRET = "database-secret"
 	TIMEZONE          = "UTC"
 	SIZE              = 10
+	HA                = false
 )
 
 func TestAPIs(t *testing.T) {
@@ -615,6 +616,7 @@ func createDefaultDatabase(metadataName string) *Database {
 				Type:                common.DATABASE_TYPE_POSTGRES,
 				Profiles:            &(Profiles{}),
 				AdditionalArguments: map[string]string{},
+				IsHighAvailability:  HA,
 			},
 		},
 	}
@@ -639,6 +641,7 @@ func createDefaultClone(metadataName string) *Database {
 				SnapshotId:          DEFAULT_UUID,
 				Profiles:            &(Profiles{}),
 				AdditionalArguments: map[string]string{},
+				IsHighAvailability:  HA,
 			},
 		},
 	}

common/util/additionalArguments.go

@@ -106,7 +106,24 @@ func GetAllowedAdditionalArgumentsForDatabase(dbType string) (map[string]bool, e
 	case common.DATABASE_TYPE_POSTGRES:
 		return map[string]bool{
 			/* Has a default */
-			"listener_port": true,
+			"listener_port":           true,
+			"proxy_read_port":         true,
+			"proxy_write_port":        true,
+			"enable_synchronous_mode": true,
+			"auto_tune_staging_drive": true,
+			"backup_policy":           true,
+			"db_password":             true,
+			"database_names":          true,
+			"provision_virtual_ip":    true,
+			"deploy_haproxy":          true,
+			"failover_mode":           true,
+			"node_type":               true,
+			"allocate_pg_hugepage":    true,
+			"cluster_database":        true,
+			"archive_wal_expire_days": true,
+			"enable_peer_auth":        true,
+			"cluster_name":            true,
+			"patroni_cluster_name":    true,
 		}, nil
 	case common.DATABASE_TYPE_MYSQL:
 		return map[string]bool{

config/crd/bases/ndb.nutanix.com_databases.yaml

@@ -69,9 +69,33 @@ spec:
                   description:
                     description: Description of the clone instance
                     type: string
+                  isHighAvailability:
+                    type: boolean
                   name:
                     description: Name of the clone instance
                     type: string
+                  nodes:
+                    items:
+                      properties:
+                        failoverMode:
+                          type: string
+                        nodeType:
+                          type: string
+                        nxClusterId:
+                          type: string
+                        nxClusterName:
+                          type: string
+                        remoteArchiveDestination:
+                          type: string
+                        role:
+                          type: string
+                        vmName:
+                          type: string
+                      required:
+                      - nodeType
+                      - vmName
+                      type: object
+                    type: array
                   profiles:
                     properties:
                       compute:
@@ -155,9 +179,33 @@ spec:
                   description:
                     description: Description of the database instance
                     type: string
+                  isHighAvailability:
+                    type: boolean
                   name:
                     description: Name of the database instance
                     type: string
+                  nodes:
+                    items:
+                      properties:
+                        failoverMode:
+                          type: string
+                        nodeType:
+                          type: string
+                        nxClusterId:
+                          type: string
+                        nxClusterName:
+                          type: string
+                        remoteArchiveDestination:
+                          type: string
+                        role:
+                          type: string
+                        vmName:
+                          type: string
+                      required:
+                      - nodeType
+                      - vmName
+                      type: object
+                    type: array
                   profiles:
                     properties:
                       compute:

controller_adapters/database.go

@@ -145,6 +145,14 @@ func (d *Database) GetInstanceSize() int {
 	return d.Spec.Instance.Size
 }
 
+func (d *Database) GetInstanceIsHighAvailability() bool {
+	return d.Spec.Instance.IsHighAvailability
+}
+
+func (d *Database) GetInstanceNodes() []*v1alpha1.Node {
+	return d.Spec.Instance.Nodes
+}
+
 // Returns basic details about the Time Machine if provided in the
 // underlying database, else returns defaults like:
 // TM Name: <db_instance_name>_TM

controller_adapters/database_test.go

@@ -231,6 +231,30 @@ func TestDatabase_GetInstanceSize(t *testing.T) {
 	})
 }
 
+// Tests the GetInstanceIsHighAvailability() function retrieves Size correctly:
+func TestDatabase_GetInstanceIsHighAvailability(t *testing.T) {
+
+	name := "Contains IsHighAvailability"
+	database := Database{
+		Database: v1alpha1.Database{
+			Spec: v1alpha1.DatabaseSpec{
+				Instance: &v1alpha1.Instance{
+					IsHighAvailability: true,
+				},
+			},
+		},
+	}
+	wantIsHighAvailability := true
+
+	t.Run(name, func(t *testing.T) {
+
+		gotIsHighAvailability := database.GetInstanceIsHighAvailability()
+		if gotIsHighAvailability != wantIsHighAvailability {
+			t.Errorf("Database.GetInstanceIsHighAvailability() gotIsHighAvailability= %v, want %v", gotIsHighAvailability, wantIsHighAvailability)
+		}
+	})
+}
+
 // Tests the GetClusterId() function retrieves ClusterId correctly:
 func TestDatabase_GetClusterId(t *testing.T) {
 

ndb_api/clone_helpers.go

@@ -18,6 +18,7 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/nutanix-cloud-native/ndb-operator/api/v1alpha1"
 	"github.com/nutanix-cloud-native/ndb-operator/common"
 	"github.com/nutanix-cloud-native/ndb-operator/ndb_client"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
@@ -85,7 +86,7 @@ func GenerateCloningRequest(ctx context.Context, ndb_client ndb_client.NDBClient
 				NetworkProfileId:    profilesMap[common.PROFILE_TYPE_NETWORK].Id,
 				NewDbServerTimeZone: "",
 				NxClusterId:         database.GetClusterId(),
-				Properties:          make([]string, 0),
+				Properties:          make([]map[string]string, 0),
 			},
 		},
 		// Added by request appenders as per the engine
@@ -96,8 +97,11 @@ func GenerateCloningRequest(ctx context.Context, ndb_client ndb_client.NDBClient
 		NetworkProfileId:           profilesMap[common.PROFILE_TYPE_NETWORK].Id,
 		DatabaseParameterProfileId: profilesMap[common.PROFILE_TYPE_DATABASE_PARAMETER].Id,
 	}
+	// boolean for high availability
+	isHighAvailability := false
+
 	// Appending request body based on database type
-	appender, err := GetRequestAppender(databaseType)
+	appender, err := GetRequestAppender(databaseType, isHighAvailability)
 	if err != nil {
 		log.Error(err, "Error while getting a request appender")
 		return
@@ -210,6 +214,98 @@ func (a *PostgresRequestAppender) appendCloningRequest(req *DatabaseCloneRequest
 	return req, nil
 }
 
+func setCloneNodesParameters(req *DatabaseCloneRequest, database DatabaseInterface) {
+	// Extract values of ComputeProfileId and NetworkProfileId
+	computeProfileId := req.Nodes[0].ComputeProfileId
+	networkProfileId := req.Nodes[0].NetworkProfileId
+	serverTimeZone := req.Nodes[0].NewDbServerTimeZone
+
+	// Convert database.Instance.Nodes to the common type Nodes
+	req.Nodes = []Node{}
+	for _, node := range database.GetInstanceNodes() {
+		built := Node{}
+		if node.Properties.NodeType == "haproxy" {
+			built = buildHAProxyNode(req, node, database.GetClusterId())
+		} else {
+			built = buildDatabaseNode(req, node, computeProfileId, networkProfileId, serverTimeZone, database.GetClusterId())
+		}
+
+		req.Nodes = append(req.Nodes, built)
+	}
+}
+
+func buildHAProxyNode(req *DatabaseCloneRequest, node *v1alpha1.Node, clusterId string) Node {
+	props := make([]map[string]string, 1)
+	props[0] = map[string]string{
+		"name":  "node_type",
+		"value": node.Properties.NodeType,
+	}
+	return Node{
+		Properties:  props,
+		VmName:      node.VmName,
+		NxClusterId: clusterId,
+	}
+}
+
+func buildDatabaseNode(req *DatabaseCloneRequest, node *v1alpha1.Node, computeProfileId, networkProfileId, serverTimeZone, clusterId string) Node {
+	props := make([]map[string]string, 4)
+	props[0] = map[string]string{
+		"name":  "role",
+		"value": node.Properties.Role,
+	}
+	props[1] = map[string]string{
+		"name":  "failover_mode",
+		"value": node.Properties.FailoverMode,
+	}
+	props[2] = map[string]string{
+		"name":  "node_type",
+		"value": node.Properties.NodeType,
+	}
+	props[3] = map[string]string{
+		"name":  "remote_archive_destination",
+		"value": "",
+	}
+	return Node{
+		ComputeProfileId:    computeProfileId,
+		NetworkProfileId:    networkProfileId,
+		NewDbServerTimeZone: serverTimeZone,
+		Properties:          props,
+		VmName:              node.VmName,
+		NxClusterId:         clusterId,
+	}
+}
+
+func (a *PostgresHARequestAppender) appendCloningRequest(req *DatabaseCloneRequest, database DatabaseInterface, reqData map[string]interface{}) (*DatabaseCloneRequest, error) {
+	req.SSHPublicKey = reqData[common.NDB_PARAM_SSH_PUBLIC_KEY].(string)
+	dbPassword := reqData[common.NDB_PARAM_PASSWORD].(string)
+
+	req.NodeCount = len(database.GetInstanceNodes())
+	setCloneNodesParameters(req, database)
+
+	// Default action arguments
+	actionArguments := map[string]string{
+		/* Non-Configurable from additionalArguments*/
+		"vm_name":              database.GetName(),
+		"dbserver_description": "DB Server VM for " + database.GetName(),
+		"db_password":          dbPassword,
+	}
+
+	// Appending/overwriting database actionArguments to actionArguments
+	if err := setConfiguredActionArguments(database, actionArguments); err != nil {
+		return nil, err
+	}
+
+	// Converting action arguments map to list and appending to req.ActionArguments
+	req.ActionArguments = append(req.ActionArguments, convertMapToActionArguments(actionArguments)...)
+
+	// Appending LCMConfig Details if specified
+	if err := appendLCMConfigDetailsToRequest(req, database.GetAdditionalArguments()); err != nil {
+		return nil, err
+	}
+
+	return req, nil
+}
+
 func (a *MySqlRequestAppender) appendCloningRequest(req *DatabaseCloneRequest, database DatabaseInterface, reqData map[string]interface{}) (*DatabaseCloneRequest, error) {
 	req.SSHPublicKey = reqData[common.NDB_PARAM_SSH_PUBLIC_KEY].(string)
 	dbPassword := reqData[common.NDB_PARAM_PASSWORD].(string)

ndb_api/common_helpers.go

@@ -134,12 +134,16 @@ func GetDatabasePortByType(dbType string) int32 {
 }
 
 // Get specific implementation of the DBProvisionRequestAppender interface based on the provided databaseType
-func GetRequestAppender(databaseType string) (requestAppender RequestAppender, err error) {
+func GetRequestAppender(databaseType string, isHighAvailability bool) (requestAppender RequestAppender, err error) {
 	switch databaseType {
 	case common.DATABASE_TYPE_MYSQL:
 		requestAppender = &MySqlRequestAppender{}
 	case common.DATABASE_TYPE_POSTGRES:
-		requestAppender = &PostgresRequestAppender{}
+		if isHighAvailability {
+			requestAppender = &PostgresHARequestAppender{}
+		} else {
+			requestAppender = &PostgresRequestAppender{}
+		}
 	case common.DATABASE_TYPE_MONGODB:
 		requestAppender = &MongoDbRequestAppender{}
 	case common.DATABASE_TYPE_MSSQL:

ndb_api/common_helpers_test.go

@@ -242,7 +242,7 @@ func TestGetRequestAppender(t *testing.T) {
 	}
 
 	for _, tc := range testCases {
-		result, err := GetRequestAppender(tc.databaseType)
+		result, err := GetRequestAppender(tc.databaseType, false)
 		if tc.expectedResult {
 			assert.NotNil(t, result)
 			assert.NoError(t, err)

ndb_api/common_types.go

@@ -88,12 +88,12 @@ type ActionArgument struct {
 }
 
 type Node struct {
-	VmName              string   `json:"vmName"`
-	ComputeProfileId    string   `json:"computeProfileId,omitempty"`
-	NetworkProfileId    string   `json:"networkProfileId,omitempty"`
-	NewDbServerTimeZone string   `json:"newDbServerTimeZone,omitempty"`
-	NxClusterId         string   `json:"nxClusterId,omitempty"`
-	Properties          []string `json:"properties"`
+	VmName              string              `json:"vmName"`
+	ComputeProfileId    string              `json:"computeProfileId,omitempty"`
+	NetworkProfileId    string              `json:"networkProfileId,omitempty"`
+	NewDbServerTimeZone string              `json:"newDbServerTimeZone,omitempty"`
+	NxClusterId         string              `json:"nxClusterId,omitempty"`
+	Properties          []map[string]string `json:"properties"`
 }
 
 type Property struct {