Aadd ingressClassName field to collector spec (#1269)

* adds ingressClassName field to collector spec * updates docs/api.md with ingressClassName field
open-telemetry · Nov 22, 2022 · 1eed17e · 1eed17e
1 parent 8d0c841
commit 1eed17e
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 7 deletions.
diff --git a/apis/v1alpha1/opentelemetrycollector_types.go b/apis/v1alpha1/opentelemetrycollector_types.go
@@ -41,6 +41,12 @@ type Ingress struct {
 	// TLS configuration.
 	// +optional
 	TLS []networkingv1.IngressTLS `json:"tls,omitempty"`
+
+	// IngressClassName is the name of an IngressClass cluster resource. Ingress
+	// controller implementations use this field to know whether they should be
+	// serving this Ingress resource.
+	// +optional
+	IngressClassName *string `json:"ingressClassName,omitempty"`
 }
 
 // OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.

diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go
diff --git a/bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml b/bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml
@@ -1196,6 +1196,11 @@ spec:
                   hostname:
                     description: Hostname by which the ingress proxy can be reached.
                     type: string
+                  ingressClassName:
+                    description: IngressClassName is the name of an IngressClass cluster
+                      resource. Ingress controller implementations use this field
+                      to know whether they should be serving this Ingress resource.
+                    type: string
                   tls:
                     description: TLS configuration.
                     items:

diff --git a/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml b/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml
@@ -1194,6 +1194,11 @@ spec:
                   hostname:
                     description: Hostname by which the ingress proxy can be reached.
                     type: string
+                  ingressClassName:
+                    description: IngressClassName is the name of an IngressClass cluster
+                      resource. Ingress controller implementations use this field
+                      to know whether they should be serving this Ingress resource.
+                    type: string
                   tls:
                     description: TLS configuration.
                     items:

diff --git a/docs/api.md b/docs/api.md
@@ -3827,6 +3827,13 @@ Ingress is used to specify how OpenTelemetry Collector is exposed. This function
           Hostname by which the ingress proxy can be reached.<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>ingressClassName</b></td>
+        <td>string</td>
+        <td>
+          IngressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource.<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b><a href="#opentelemetrycollectorspecingresstlsindex">tls</a></b></td>
         <td>[]object</td>

diff --git a/pkg/collector/reconcile/ingress.go b/pkg/collector/reconcile/ingress.go
@@ -118,6 +118,7 @@ func desiredIngresses(_ context.Context, params Params) *networkingv1.Ingress {
 					},
 				},
 			},
+			IngressClassName: params.Instance.Spec.Ingress.IngressClassName,
 		},
 	}
 }

diff --git a/pkg/collector/reconcile/ingress_test.go b/pkg/collector/reconcile/ingress_test.go
@@ -23,7 +23,6 @@ import (
 	"github.com/stretchr/testify/assert"
 	corev1 "k8s.io/api/core/v1"
 	networkingv1 "k8s.io/api/networking/v1"
-	v1 "k8s.io/api/networking/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 
@@ -93,8 +92,9 @@ func TestDesiredIngresses(t *testing.T) {
 
 	t.Run("should return nil unable to do something else", func(t *testing.T) {
 		var (
-			ns       = "test"
-			hostname = "example.com"
+			ns               = "test"
+			hostname         = "example.com"
+			ingressClassName = "nginx"
 		)
 
 		params, err := newParams("something:tag", test_file_ingress)
@@ -104,9 +104,10 @@ func TestDesiredIngresses(t *testing.T) {
 
 		params.Instance.Namespace = ns
 		params.Instance.Spec.Ingress = v1alpha1.Ingress{
-			Type:        v1alpha1.IngressTypeNginx,
-			Hostname:    hostname,
-			Annotations: map[string]string{"some.key": "some.value"},
+			Type:             v1alpha1.IngressTypeNginx,
+			Hostname:         hostname,
+			Annotations:      map[string]string{"some.key": "some.value"},
+			IngressClassName: &ingressClassName,
 		}
 
 		got := desiredIngresses(context.Background(), params)
@@ -124,6 +125,7 @@ func TestDesiredIngresses(t *testing.T) {
 				},
 			},
 			Spec: networkingv1.IngressSpec{
+				IngressClassName: &ingressClassName,
 				Rules: []networkingv1.IngressRule{
 					{
 						Host: hostname,
@@ -243,7 +245,7 @@ func TestDeleteIngresses(t *testing.T) {
 		}
 
 		// check
-		exists, err = populateObjectIfExists(t, &v1.Ingress{}, nns)
+		exists, err = populateObjectIfExists(t, &networkingv1.Ingress{}, nns)
 		assert.NoError(t, err)
 		assert.False(t, exists)
 	})
-Original file line number
+Diff line change
@@ Expand Up @@
     					},
     				},
     			},
+    			IngressClassName: params.Instance.Spec.Ingress.IngressClassName,
     		},
     	}
     }
@@ Expand Down @@