Adding extra annotations to service (#150)

Author: matthewkrupnik

Diff for: api/v1alpha1/nginxingresscontroller_types.go

@@ -297,6 +297,9 @@ type Service struct {
 	// Specifies extra labels of the service.
 	// +kubebuilder:validation:Optional
 	ExtraLabels map[string]string `json:"extraLabels,omitempty"`
+	// Specifies extra annotations of the service.
+	// +kubebuilder:validation:Optional
+	ExtraAnnotations map[string]string `json:"extraAnnotations,omitempty"`
 }
 
 func init() {

Diff for: api/v1alpha1/zz_generated.deepcopy.go

@@ -246,6 +246,11 @@ spec:
                       type: string
                     description: Specifies extra labels of the service.
                     type: object
+                  extraAnnotations:
+                    additionalProperties:
+                      type: string
+                    description: Specifies extra annotations of the service.
+                    type: object
                 type: object
               serviceType:
                 description: 'The type of the Service for the Ingress Controller.

Diff for: bundle/manifests/k8s.nginx.org_nginxingresscontrollers.yaml

@@ -270,6 +270,11 @@ spec:
                 description: The service of the Ingress controller.
                 nullable: true
                 properties:
+                  extraAnnotations:
+                    additionalProperties:
+                      type: string
+                    description: Specifies extra annotations of the service.
+                    type: object
                   extraLabels:
                     additionalProperties:
                       type: string

Diff for: config/crd/bases/k8s.nginx.org_nginxingresscontrollers.yaml

@@ -223,10 +223,12 @@ func (r *NginxIngressControllerReconciler) Reconcile(ctx context.Context, req ct
 		return ctrl.Result{}, err
 	}
 	var extraLabels map[string]string
+	var extraAnnotations map[string]string
 	if instance.Spec.Service != nil {
 		extraLabels = instance.Spec.Service.ExtraLabels
+		extraAnnotations = instance.Spec.Service.ExtraAnnotations
 	}
-	res, err := controllerutil.CreateOrUpdate(ctx, r.Client, svc, serviceMutateFn(svc, instance.Spec.ServiceType, extraLabels))
+	res, err := controllerutil.CreateOrUpdate(ctx, r.Client, svc, serviceMutateFn(svc, instance.Spec.ServiceType, extraLabels, extraAnnotations))
 	log.V(1).Info(fmt.Sprintf("Service %s %s", svc.Name, res))
 	if err != nil {
 		return ctrl.Result{}, err

Diff for: controllers/nginxingresscontroller_controller.go

@@ -12,15 +12,18 @@ import (
 
 func serviceForNginxIngressController(instance *k8sv1alpha1.NginxIngressController, scheme *runtime.Scheme) (*corev1.Service, error) {
 	extraLabels := map[string]string{}
+	extraAnnotations := map[string]string{}
 	if instance.Spec.Service != nil {
 		extraLabels = instance.Spec.Service.ExtraLabels
+		extraAnnotations = instance.Spec.Service.ExtraAnnotations
 	}
 
 	svc := &corev1.Service{
 		ObjectMeta: v1.ObjectMeta{
-			Name:      instance.Name,
-			Namespace: instance.Namespace,
-			Labels:    extraLabels,
+			Name:        instance.Name,
+			Namespace:   instance.Namespace,
+			Labels:      extraLabels,
+			Annotations: extraAnnotations,
 		},
 		Spec: corev1.ServiceSpec{
 			Ports: []corev1.ServicePort{
@@ -55,10 +58,11 @@ func serviceForNginxIngressController(instance *k8sv1alpha1.NginxIngressControll
 	return svc, nil
 }
 
-func serviceMutateFn(svc *corev1.Service, serviceType string, labels map[string]string) controllerutil.MutateFn {
+func serviceMutateFn(svc *corev1.Service, serviceType string, labels map[string]string, annotations map[string]string) controllerutil.MutateFn {
 	return func() error {
 		svc.Spec.Type = corev1.ServiceType(serviceType)
 		svc.Labels = labels
+		svc.Annotations = annotations
 		return nil
 	}
 }

Diff for: controllers/service.go

@@ -21,25 +21,29 @@ func TestServiceForNginxIngressController(t *testing.T) {
 	name := "my-service"
 	namespace := "my-nginx-ingress"
 	extraLabels := map[string]string{"app": "my-nginx-ingress"}
+	extraAnnotations := map[string]string{"app": "my-nginx-ingress"}
 
 	instance := &k8sv1alpha1.NginxIngressController{
 		ObjectMeta: v1.ObjectMeta{
-			Name:      name,
-			Namespace: namespace,
-			Labels:    extraLabels,
+			Name:        name,
+			Namespace:   namespace,
+			Labels:      extraLabels,
+			Annotations: extraAnnotations,
 		},
 		Spec: k8sv1alpha1.NginxIngressControllerSpec{
 			ServiceType: string(corev1.ServiceTypeLoadBalancer),
 			Service: &k8sv1alpha1.Service{
-				ExtraLabels: extraLabels,
+				ExtraLabels:      extraLabels,
+				ExtraAnnotations: extraAnnotations,
 			},
 		},
 	}
 	expected := &corev1.Service{
 		ObjectMeta: v1.ObjectMeta{
-			Name:      name,
-			Namespace: namespace,
-			Labels:    extraLabels,
+			Name:        name,
+			Namespace:   namespace,
+			Labels:      extraLabels,
+			Annotations: extraAnnotations,
 			OwnerReferences: []v1.OwnerReference{
 				{
 					APIVersion:         "k8s.nginx.org/v1alpha1",

Diff for: controllers/service_test.go

@@ -132,6 +132,7 @@ spec:
 | Field | Type | Description | Required |
 | --- | --- | --- | --- |
 | `extraLabels` | `map[string]string` | Specifies extra labels of the service. | No |
+| `extraAnnotations` | `map[string]string` | Specifies extra annotations of the service. | No |
 
 ## NginxIngressController.ReportIngressStatus