Allow additional service configuration for MysqlCluster

Author: ynnt

Changelog.md

@@ -11,6 +11,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
    provisioners wich don't support fsGroup in security context (fixes #615)
  * Add `appSecretLabels`, `appSecretAnnotations`, `backupSecretLabels`, `backupSecretAnnotations` to provide 
    custom labels and annotations to created app and backup secrets
+ * Add `serviceSpec` for MysqlCLuster
 ### Changed
  * Allow setting pod security context when deploying with Helm
  * Use [distroless](https://github.com/GoogleContainerTools/distroless) as base image for orchestrator container

config/crd/bases/mysql.presslabs.org_mysqlclusters.yaml

@@ -6178,6 +6178,20 @@ spec:
                 description: Set a custom offset for Server IDs.  ServerID for each
                   node will be the index of the statefulset, plus offset
                 type: integer
+              serviceSpec:
+                description: Service extra specification
+                properties:
+                  annotations:
+                    additionalProperties:
+                      type: string
+                    description: Additional annotations to append to MysqlCluster's
+                      services
+                    type: object
+                  type:
+                    description: 'ServiceType defines a type for Services: ClusterIP,
+                      Loadbalancer, etc.'
+                    type: string
+                type: object
               tmpfsSize:
                 anyOf:
                 - type: integer

pkg/apis/mysql/v1alpha1/mysqlcluster_types.go

@@ -107,6 +107,10 @@ type MysqlClusterSpec struct {
 	// +optional
 	VolumeSpec VolumeSpec `json:"volumeSpec,omitempty"`
 
+	// Service extra specification
+	// +optional
+	ServiceSpec ServiceSpec `json:"serviceSpec,omitempty"`
+
 	// TmpfsSize if specified, mounts a tmpfs of this size into /tmp
 	// DEPRECATED: use instead PodSpec.Volumes and PodSpec.VolumeMounts
 	// +optional
@@ -241,6 +245,17 @@ type VolumeSpec struct {
 	PersistentVolumeClaim *core.PersistentVolumeClaimSpec `json:"persistentVolumeClaim,omitempty"`
 }
 
+// ServiceSpeci s the desired spec for addition configuration of MysqlCluster services
+type ServiceSpec struct {
+	// ServiceType defines a type for Services: ClusterIP, Loadbalancer, etc.
+	// +optional
+	ServiceType string `json:"type,omitempty"`
+
+	// Additional annotations to append to MysqlCluster's services
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
+}
+
 // QueryLimits represents the pt-kill parameters, more info can be found
 // here: https://www.percona.com/doc/percona-toolkit/LATEST/pt-kill.html
 type QueryLimits struct {

pkg/apis/mysql/v1alpha1/zz_generated.deepcopy.go

@@ -38,6 +38,14 @@ func NewHeadlessSVCSyncer(c client.Client, scheme *runtime.Scheme, cluster *mysq
 	}
 
 	return syncer.NewObjectSyncer("HeadlessSVC", nil, service, c, func() error {
+		// set service type
+		service.Spec.Type = cluster.Spec.ServiceSpec.ServiceType
+
+		// set annotations
+		if len(cluster.Spec.ServiceSpec.Annotations) > 0 {
+			service.ObjectMeta.Annotations = cluster.Spec.ServiceSpec.Annotations
+		}
+
 		// add general labels to this service
 		service.Labels = map[string]string{
 			"app.kubernetes.io/name":       "mysql",

pkg/controller/mysqlcluster/internal/syncer/headless_service.go

@@ -36,6 +36,14 @@ func NewHealthyReplicasSVCSyncer(c client.Client, scheme *runtime.Scheme, cluste
 	}
 
 	return syncer.NewObjectSyncer("HealthyReplicasSVC", cluster.Unwrap(), service, c, func() error {
+		// set service type
+		service.Spec.Type = cluster.Spec.ServiceSpec.ServiceType
+
+		// set annotations
+		if len(cluster.Spec.ServiceSpec.Annotations) > 0 {
+			service.ObjectMeta.Annotations = cluster.Spec.ServiceSpec.Annotations
+		}
+
 		// set service labels
 		service.Labels = cluster.GetLabels()
 		service.Labels["mysql.presslabs.org/service-type"] = "ready-replicas"

pkg/controller/mysqlcluster/internal/syncer/healthy_replicas_service.go

@@ -37,6 +37,14 @@ func NewHealthySVCSyncer(c client.Client, scheme *runtime.Scheme, cluster *mysql
 	}
 
 	return syncer.NewObjectSyncer("HealthySVC", cluster.Unwrap(), service, c, func() error {
+		// set service type
+		service.Spec.Type = cluster.Spec.ServiceSpec.ServiceType
+
+		// set annotations
+		if len(cluster.Spec.ServiceSpec.Annotations) > 0 {
+			service.ObjectMeta.Annotations = cluster.Spec.ServiceSpec.Annotations
+		}
+
 		// set service labels
 		service.Labels = cluster.GetLabels()
 		service.Labels["mysql.presslabs.org/service-type"] = "ready-nodes"

pkg/controller/mysqlcluster/internal/syncer/healthy_service.go

@@ -36,6 +36,14 @@ func NewMasterSVCSyncer(c client.Client, scheme *runtime.Scheme, cluster *mysqlc
 	}
 
 	return syncer.NewObjectSyncer("MasterSVC", cluster.Unwrap(), service, c, func() error {
+		// set service type
+		service.Spec.Type = cluster.Spec.ServiceSpec.ServiceType
+
+		// set annotations
+		if len(cluster.Spec.ServiceSpec.Annotations) > 0 {
+			service.ObjectMeta.Annotations = cluster.Spec.ServiceSpec.Annotations
+		}
+
 		// set service labels
 		service.Labels = cluster.GetLabels()
 		service.Labels["mysql.presslabs.org/service-type"] = "master"

pkg/controller/mysqlcluster/internal/syncer/master_service.go

@@ -79,6 +79,11 @@ func (cluster *MysqlCluster) SetDefaults(opt *options.Options) {
 		}
 	}
 
+	// set default service type
+	if cluster.Spec.ServiceSpec.ServiceType == "" {
+		cluster.Spec.ServiceSpec.ServiceType = "ClusterIP"
+	}
+
 	// configure mysql based on:
 	// https://www.percona.com/blog/2018/03/26/mysql-8-0-innodb_dedicated_server-variable-optimizes-innodb/
 

pkg/internal/mysqlcluster/defaults.go

@@ -75,6 +75,8 @@ var _ = Describe("Test MySQL cluster wrapper", func() {
 		Expect(cluster.Spec.MysqlConf).To(HaveKey(Equal("innodb-buffer-pool-size")))
 		Expect(cluster.Spec.MysqlConf).To(HaveKey(Equal("innodb-log-file-size")))
 		Expect(cluster.Spec.MysqlConf).NotTo(HaveKey(Equal("max-binlog-size")))
+
+		Expect(cluster.Spec.ServiceSpec.ServiceType).To(Equal("ClusterIP"))
 	})
 
 	It("should use init MySQL container", func() {