Add MS SQL Ops Requests APIs (#1198)

Signed-off-by: Neaj Morshad <neaj@appscode.com>

apis/autoscaling/v1alpha1/mssqlserver_types.go

@@ -79,6 +79,9 @@ type MSSQLServerStorageAutoscalerSpec struct {
 }
 
 type MSSQLServerOpsRequestOptions struct {
+	// Specifies the Readiness Criteria
+	ReadinessCriteria *opsapi.MSSQLServerReplicaReadinessCriteria `json:"readinessCriteria,omitempty"`
+
 	// Timeout for each step of the ops request in second. If a step doesn't finish within the specified timeout, the ops request will result in failure.
 	Timeout *metav1.Duration `json:"timeout,omitempty"`
 

apis/kubedb/constants.go

@@ -373,18 +373,19 @@ const (
 	SinglestoreTLSConfigPreferred  = "preferred"
 
 	// =========================== MSSQLServer Constants ============================
-	MSSQLSAUser = "sa"
+	MSSQLSAUser    = "sa"
+	MSSQLConfigKey = "mssql.conf"
 
 	AGPrimaryReplicaReadyCondition = "AGPrimaryReplicaReady"
 
-	MSSQLDatabasePodPrimary       = "primary"
-	MSSQLDatabasePodSecondary     = "secondary"
-	MSSQLSecondaryServiceAlias    = "secondary"
-	MSSQLSecondaryServicePortName = "secondary"
+	MSSQLDatabasePodPrimary    = "primary"
+	MSSQLDatabasePodSecondary  = "secondary"
+	MSSQLSecondaryServiceAlias = "secondary"
 
 	// port related
 	MSSQLDatabasePortName              = "db"
 	MSSQLPrimaryServicePortName        = "primary"
+	MSSQLSecondaryServicePortName      = "secondary"
 	MSSQLDatabasePort                  = 1433
 	MSSQLDatabaseMirroringEndpointPort = 5022
 	MSSQLCoordinatorPort               = 2381
@@ -404,6 +405,8 @@ const (
 	// volume related
 	MSSQLVolumeNameData                        = "data"
 	MSSQLVolumeMountPathData                   = "/var/opt/mssql"
+	MSSQLVolumeNameConfig                      = "config"
+	MSSQLVolumeMountPathConfig                 = "/var/opt/mssql/mssql.conf"
 	MSSQLVolumeNameInitScript                  = "init-scripts"
 	MSSQLVolumeMountPathInitScript             = "/scripts"
 	MSSQLVolumeNameEndpointCert                = "endpoint-cert"
@@ -1494,6 +1497,17 @@ var (
 		},
 	}
 
+	// DefaultResourcesMemoryIntensiveMSSQLServer must be used for Microsoft SQL Server
+	DefaultResourcesMemoryIntensiveMSSQLServer = core.ResourceRequirements{
+		Requests: core.ResourceList{
+			core.ResourceCPU:    resource.MustParse(".500"),
+			core.ResourceMemory: resource.MustParse("1.5Gi"),
+		},
+		Limits: core.ResourceList{
+			core.ResourceMemory: resource.MustParse("4Gi"),
+		},
+	}
+
 	// DefaultResourcesCoreAndMemoryIntensive must be used for Solr
 	DefaultResourcesCoreAndMemoryIntensiveSolr = core.ResourceRequirements{
 		Requests: core.ResourceList{

apis/kubedb/v1alpha2/mssqlserver_helpers.go

@@ -474,7 +474,7 @@ func (m *MSSQLServer) assignDefaultContainerSecurityContext(mssqlVersion *catalo
 func (m *MSSQLServer) setDefaultContainerResourceLimits(podTemplate *ofst.PodTemplateSpec) {
 	dbContainer := coreutil.GetContainerByName(podTemplate.Spec.Containers, kubedb.MSSQLContainerName)
 	if dbContainer != nil && (dbContainer.Resources.Requests == nil && dbContainer.Resources.Limits == nil) {
-		apis.SetDefaultResourceLimits(&dbContainer.Resources, kubedb.DefaultResourcesMemoryIntensive)
+		apis.SetDefaultResourceLimits(&dbContainer.Resources, kubedb.DefaultResourcesMemoryIntensiveMSSQLServer)
 	}
 
 	initContainer := coreutil.GetContainerByName(podTemplate.Spec.InitContainers, kubedb.MSSQLInitContainerName)

apis/kubedb/v1alpha2/mssqlserver_types.go

@@ -90,6 +90,11 @@ type MSSQLServerSpec struct {
 	// +optional
 	AuthSecret *SecretReference `json:"authSecret,omitempty"`
 
+	// ConfigSecret is an optional field to provide custom configuration file for database (i.e mssql.conf).
+	// If specified, this file will be used as configuration file otherwise default configuration file will be used.
+	// +optional
+	ConfigSecret *core.LocalObjectReference `json:"configSecret,omitempty"`
+
 	// InternalAuth is used to authenticate endpoint
 	// +optional
 	// +nullable

apis/kubedb/v1alpha2/mssqlserver_webhook.go

@@ -192,6 +192,7 @@ func (m *MSSQLServer) ValidateCreateOrUpdate() field.ErrorList {
 // reserved volume and volumes mounts for mssql
 var mssqlReservedVolumes = []string{
 	kubedb.MSSQLVolumeNameData,
+	kubedb.MSSQLVolumeNameConfig,
 	kubedb.MSSQLVolumeNameInitScript,
 	kubedb.MSSQLVolumeNameEndpointCert,
 	kubedb.MSSQLVolumeNameCerts,
@@ -202,6 +203,7 @@ var mssqlReservedVolumes = []string{
 
 var mssqlReservedVolumesMountPaths = []string{
 	kubedb.MSSQLVolumeMountPathData,
+	kubedb.MSSQLVolumeMountPathConfig,
 	kubedb.MSSQLVolumeMountPathInitScript,
 	kubedb.MSSQLVolumeMountPathEndpointCert,
 	kubedb.MSSQLVolumeMountPathCerts,

apis/ops/v1alpha1/mssqlserver_ops_types.go

@@ -19,6 +19,7 @@ package v1alpha1
 
 import (
 	core "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -54,6 +55,18 @@ type MSSQLServerOpsRequestSpec struct {
 	DatabaseRef core.LocalObjectReference `json:"databaseRef"`
 	// Specifies the ops request type: UpdateVersion, HorizontalScaling, VerticalScaling etc.
 	Type MSSQLServerOpsRequestType `json:"type"`
+	// Specifies information necessary for upgrading MSSQL
+	UpdateVersion *MSSQLServerUpdateVersionSpec `json:"updateVersion,omitempty"`
+	// Specifies information necessary for horizontal scaling
+	HorizontalScaling *MSSQLServerHorizontalScalingSpec `json:"horizontalScaling,omitempty"`
+	// Specifies information necessary for vertical scaling
+	VerticalScaling *MSSQLServerVerticalScalingSpec `json:"verticalScaling,omitempty"`
+	// Specifies information necessary for volume expansion
+	VolumeExpansion *MSSQLServerVolumeExpansionSpec `json:"volumeExpansion,omitempty"`
+	// Specifies information necessary for custom configuration of MSSQLServer
+	Configuration *MSSQLServerCustomConfigurationSpec `json:"configuration,omitempty"`
+	// Specifies information necessary for configuring TLS
+	TLS *TLSSpec `json:"tls,omitempty"`
 	// Specifies information necessary for restarting database
 	Restart *RestartSpec `json:"restart,omitempty"`
 	// Timeout for each step of the ops request in second. If a step doesn't finish within the specified timeout, the ops request will result in failure.
@@ -63,10 +76,47 @@ type MSSQLServerOpsRequestSpec struct {
 	Apply ApplyOption `json:"apply,omitempty"`
 }
 
-// +kubebuilder:validation:Enum=Restart
-// ENUM(Restart)
+// +kubebuilder:validation:Enum=UpdateVersion;HorizontalScaling;VerticalScaling;VolumeExpansion;Restart;Reconfigure;ReconfigureTLS
+// ENUM(UpdateVersion, HorizontalScaling, VerticalScaling, VolumeExpansion, Restart, Reconfigure, ReconfigureTLS)
 type MSSQLServerOpsRequestType string
 
+// MSSQLServerReplicaReadinessCriteria is the criteria for checking readiness of a MSSQLServer pod
+// after updating, horizontal scaling etc.
+type MSSQLServerReplicaReadinessCriteria struct{}
+
+// MSSQLServerUpdateVersionSpec contains the update version information of a MSSQLServer cluster
+type MSSQLServerUpdateVersionSpec struct {
+	// Specifies the target version name from catalog
+	TargetVersion string `json:"targetVersion,omitempty"`
+}
+
+// MSSQLServerHorizontalScalingSpec contains the horizontal scaling information of a MSSQLServer cluster
+type MSSQLServerHorizontalScalingSpec struct {
+	// Number of Replicas of MSSQLServer Availability Group
+	Replicas *int32 `json:"replicas,omitempty"`
+}
+
+// MSSQLServerVerticalScalingSpec contains the vertical scaling information of a MSSQLServer cluster
+type MSSQLServerVerticalScalingSpec struct {
+	MSSQLServer *PodResources       `json:"mssqlserver,omitempty"`
+	Exporter    *ContainerResources `json:"exporter,omitempty"`
+	Coordinator *ContainerResources `json:"coordinator,omitempty"`
+}
+
+// MSSQLServerVolumeExpansionSpec is the spec for MSSQLServer volume expansion
+type MSSQLServerVolumeExpansionSpec struct {
+	// volume specification for Postgres
+	MSSQLServer *resource.Quantity  `json:"mssqlserver,omitempty"`
+	Mode        VolumeExpansionMode `json:"mode"`
+}
+
+// MSSQLServerCustomConfigurationSpec is the spec for Reconfiguring the MSSQLServer
+type MSSQLServerCustomConfigurationSpec struct {
+	ConfigSecret       *core.LocalObjectReference `json:"configSecret,omitempty"`
+	ApplyConfig        map[string]string          `json:"applyConfig,omitempty"`
+	RemoveCustomConfig bool                       `json:"removeCustomConfig,omitempty"`
+}
+
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
 // MSSQLServerOpsRequestList is a list of MSSQLServerOpsRequests