feat: add option to disable creation of services

Fix #943 Signed-off-by: Rory Z <[email protected]>
emqx · Sep 8, 2023 · 17aaf5f · 17aaf5f
1 parent de8d31d
commit 17aaf5f
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 21 deletions.
diff --git a/apis/apps/v2beta1/emqx_types.go b/apis/apps/v2beta1/emqx_types.go
@@ -286,6 +286,9 @@ type EMQXReplicantTemplateSpec struct {
 }
 
 type ServiceTemplate struct {
+	// EMQX Operator will create a service for EMQX nodes.
+	//+kubebuilder:default:=true
+	Enabled bool `json:"enabled,omitempty"`
 	// Standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
 	metav1.ObjectMeta `json:"metadata,omitempty"`

diff --git a/config/crd/bases/apps.emqx.io_emqxes.yaml b/config/crd/bases/apps.emqx.io_emqxes.yaml
@@ -9572,6 +9572,9 @@ spec:
                 type: object
               dashboardServiceTemplate:
                 properties:
+                  enabled:
+                    default: true
+                    type: boolean
                   metadata:
                     properties:
                       annotations:
@@ -9695,6 +9698,9 @@ spec:
                 type: array
               listenersServiceTemplate:
                 properties:
+                  enabled:
+                    default: true
+                    type: boolean
                   metadata:
                     properties:
                       annotations:

diff --git a/controllers/apps/v2beta1/add_svc.go b/controllers/apps/v2beta1/add_svc.go
@@ -23,16 +23,17 @@ func (a *addSvc) reconcile(ctx context.Context, instance *appsv2beta1.EMQX, _ in
 	}
 
 	configStr := configMap.Data["emqx.conf"]
-	resources := []client.Object{
-		generateHeadlessService(instance),
-		generateDashboardService(instance, configStr),
-		generateListenerService(instance, configStr),
+	resources := []client.Object{generateHeadlessService(instance)}
+	if dashboard := generateDashboardService(instance, configStr); dashboard != nil {
+		resources = append(resources, dashboard)
+	}
+	if listeners := generateListenerService(instance, configStr); listeners != nil {
+		resources = append(resources, listeners)
 	}
 
 	if err := a.CreateOrUpdateList(instance, a.Scheme, resources); err != nil {
 		return subResult{err: emperror.Wrap(err, "failed to create or update services")}
 	}
-
 	return subResult{}
 }
 
@@ -73,6 +74,15 @@ func generateHeadlessService(instance *appsv2beta1.EMQX) *corev1.Service {
 }
 
 func generateDashboardService(instance *appsv2beta1.EMQX, configStr string) *corev1.Service {
+	svc := &corev1.Service{}
+	if instance.Spec.DashboardServiceTemplate != nil {
+		if !instance.Spec.DashboardServiceTemplate.Enabled {
+			return nil
+		}
+		svc.ObjectMeta = *instance.Spec.DashboardServiceTemplate.ObjectMeta.DeepCopy()
+		svc.Spec = *instance.Spec.DashboardServiceTemplate.Spec.DeepCopy()
+	}
+
 	port, err := appsv2beta1.GetDashboardServicePort(configStr)
 	if err != nil {
 		port = &corev1.ServicePort{
@@ -83,12 +93,6 @@ func generateDashboardService(instance *appsv2beta1.EMQX, configStr string) *cor
 		}
 	}
 
-	svc := &corev1.Service{}
-	if instance.Spec.DashboardServiceTemplate != nil {
-		svc.ObjectMeta = *instance.Spec.DashboardServiceTemplate.ObjectMeta.DeepCopy()
-		svc.Spec = *instance.Spec.DashboardServiceTemplate.Spec.DeepCopy()
-	}
-
 	svc.Spec.Ports = appsv2beta1.MergeServicePorts(
 		svc.Spec.Ports,
 		[]corev1.ServicePort{
@@ -105,14 +109,23 @@ func generateDashboardService(instance *appsv2beta1.EMQX, configStr string) *cor
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace:   instance.Namespace,
 			Name:        instance.DashboardServiceNamespacedName().Name,
-			Labels:      appsv2beta1.CloneAndMergeMap(appsv2beta1.DefaultLabels(instance), svc.Labels),
-			Annotations: svc.Annotations,
+			Labels:      appsv2beta1.CloneAndMergeMap(appsv2beta1.DefaultLabels(instance), svc.ObjectMeta.Labels),
+			Annotations: svc.ObjectMeta.Annotations,
 		},
 		Spec: svc.Spec,
 	}
 }
 
 func generateListenerService(instance *appsv2beta1.EMQX, configStr string) *corev1.Service {
+	svc := &corev1.Service{}
+	if instance.Spec.ListenersServiceTemplate != nil {
+		if !instance.Spec.ListenersServiceTemplate.Enabled {
+			return nil
+		}
+		svc.ObjectMeta = *instance.Spec.ListenersServiceTemplate.ObjectMeta.DeepCopy()
+		svc.Spec = *instance.Spec.ListenersServiceTemplate.Spec.DeepCopy()
+	}
+
 	ports, _ := appsv2beta1.GetListenersServicePorts(configStr)
 	if len(ports) == 0 {
 		ports = append(ports, []corev1.ServicePort{
@@ -143,12 +156,6 @@ func generateListenerService(instance *appsv2beta1.EMQX, configStr string) *core
 		}...)
 	}
 
-	svc := &corev1.Service{}
-	if instance.Spec.ListenersServiceTemplate != nil {
-		svc.ObjectMeta = *instance.Spec.ListenersServiceTemplate.ObjectMeta.DeepCopy()
-		svc.Spec = *instance.Spec.ListenersServiceTemplate.Spec.DeepCopy()
-	}
-
 	svc.Spec.Ports = appsv2beta1.MergeServicePorts(
 		svc.Spec.Ports,
 		ports,
@@ -165,8 +172,8 @@ func generateListenerService(instance *appsv2beta1.EMQX, configStr string) *core
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace:   instance.Namespace,
 			Name:        instance.ListenersServiceNamespacedName().Name,
-			Labels:      appsv2beta1.CloneAndMergeMap(appsv2beta1.DefaultLabels(instance), svc.Labels),
-			Annotations: svc.Annotations,
+			Labels:      appsv2beta1.CloneAndMergeMap(appsv2beta1.DefaultLabels(instance), svc.ObjectMeta.Labels),
+			Annotations: svc.ObjectMeta.Annotations,
 		},
 		Spec: svc.Spec,
 	}

diff --git a/controllers/apps/v2beta1/add_svc_test.go b/controllers/apps/v2beta1/add_svc_test.go
@@ -74,6 +74,7 @@ func TestGenerateDashboardService(t *testing.T) {
 				},
 			},
 			DashboardServiceTemplate: &appsv2beta1.ServiceTemplate{
+				Enabled: true,
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "emqx-dashboard",
 					Labels: map[string]string{

diff --git a/deploy/charts/emqx-operator/templates/crd.emqxes.apps.emqx.io.yaml b/deploy/charts/emqx-operator/templates/crd.emqxes.apps.emqx.io.yaml
@@ -9584,6 +9584,9 @@ spec:
                   type: object
                 dashboardServiceTemplate:
                   properties:
+                    enabled:
+                      default: true
+                      type: boolean
                     metadata:
                       properties:
                         annotations:
@@ -9707,6 +9710,9 @@ spec:
                   type: array
                 listenersServiceTemplate:
                   properties:
+                    enabled:
+                      default: true
+                      type: boolean
                     metadata:
                       properties:
                         annotations:

diff --git a/docs/en_US/reference/v2beta1-reference.md b/docs/en_US/reference/v2beta1-reference.md
@@ -486,6 +486,7 @@ _Appears in:_
 
 | Field | Description |
 | --- | --- |
+| `enabled` _boolean_ | EMQX Operator will create a service for EMQX nodes. |
 | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
 | `spec` _[ServiceSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#servicespec-v1-core)_ | Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
 

diff --git a/docs/zh_CN/reference/v2beta1-reference.md b/docs/zh_CN/reference/v2beta1-reference.md
@@ -486,6 +486,7 @@ _Appears in:_
 
 | Field | Description |
 | --- | --- |
+| `enabled` _boolean_ | EMQX Operator will create a service for EMQX nodes. |
 | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
 | `spec` _[ServiceSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#servicespec-v1-core)_ | Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |