fix cel

Signed-off-by: zirain <zirain2009@gmail.com>
envoyproxy · Apr 2, 2024 · 0fa26c5 · 0fa26c5
1 parent cc9a69c
commit 0fa26c5
Show file tree

Hide file tree

Showing 15 changed files with 144 additions and 52 deletions.
diff --git a/api/v1alpha1/accesslogging_types.go b/api/v1alpha1/accesslogging_types.go
@@ -96,13 +96,14 @@ type FileEnvoyProxyAccessLog struct {
 
 // OpenTelemetryEnvoyProxyAccessLog defines the OpenTelemetry access log sink.
 //
-// +kubebuilder:validation:XValidation:message="BackendRef only support Service Kind.",rule="!has(self.backendRef) || !has(self.backendRef.kind) || self.backendRef.kind == 'Service'"
+// +kubebuilder:validation:XValidation:message="host or backendRef needs to be set",rule="has(self.host) || has(self.backendRef)"
+// +kubebuilder:validation:XValidation:message="backendRef only support Service Kind.",rule="!has(self.backendRef) || self.backendRef.kind == 'Service'"
 type OpenTelemetryEnvoyProxyAccessLog struct {
 	// Host define the extension service hostname.
 	// Deprecated: Use BackendRef instead.
 	//
-	// +kubebuilder:validation:MinLength=0
-	Host string `json:"host"`
+	// +optional
+	Host *string `json:"host"`
 	// Port defines the port the extension service is exposed on.
 	// Deprecated: Use BackendRef instead.
 	//

diff --git a/api/v1alpha1/envoyproxy_metric_types.go b/api/v1alpha1/envoyproxy_metric_types.go
@@ -51,13 +51,14 @@ type ProxyMetricSink struct {
 
 // ProxyOpenTelemetrySink defines the configuration for OpenTelemetry sink.
 //
-// +kubebuilder:validation:XValidation:message="BackendRef only support Service Kind.",rule="!has(self.backendRef) || !has(self.backendRef.kind) || self.backendRef.kind == 'Service'"
+// +kubebuilder:validation:XValidation:message="host or backendRef needs to be set",rule="has(self.host) || has(self.backendRef)"
+// +kubebuilder:validation:XValidation:message="backendRef only support Service Kind.",rule="!has(self.backendRef) || self.backendRef.kind == 'Service'"
 type ProxyOpenTelemetrySink struct {
 	// Host define the service hostname.
 	// Deprecated: Use BackendRef instead.
 	//
-	// +kubebuilder:validation:MinLength=0
-	Host string `json:"host"`
+	// +optional
+	Host *string `json:"host"`
 	// Port defines the port the service is exposed on.
 	// Deprecated: Use BackendRef instead.
 	//

diff --git a/api/v1alpha1/tracing_types.go b/api/v1alpha1/tracing_types.go
@@ -32,7 +32,8 @@ const (
 
 // TracingProvider defines the tracing provider configuration.
 //
-// +kubebuilder:validation:XValidation:message="BackendRef only support Service Kind.",rule="!has(self.backendRef) || !has(self.backendRef.kind) || self.backendRef.kind == 'Service'"
+// +kubebuilder:validation:XValidation:message="host or backendRef needs to be set",rule="has(self.host) || has(self.backendRef)"
+// +kubebuilder:validation:XValidation:message="backendRef only support Service Kind.",rule="!has(self.backendRef) || self.backendRef.kind == 'Service'"
 type TracingProvider struct {
 	// Type defines the tracing provider type.
 	// EG currently only supports OpenTelemetry.
@@ -42,8 +43,8 @@ type TracingProvider struct {
 	// Host define the provider service hostname.
 	// Deprecated: Use BackendRef instead.
 	//
-	// +kubebuilder:validation:MinLength=0
-	Host string `json:"host"`
+	// +optional
+	Host *string `json:"host"`
 	// Port defines the port the provider service is exposed on.
 	// Deprecated: Use BackendRef instead.
 	//

diff --git a/api/v1alpha1/validation/envoyproxy_validate_test.go b/api/v1alpha1/validation/envoyproxy_validate_test.go
@@ -438,7 +438,7 @@ func TestValidateEnvoyProxy(t *testing.T) {
 								{
 									Type: egv1a1.MetricSinkTypeOpenTelemetry,
 									OpenTelemetry: &egv1a1.ProxyOpenTelemetrySink{
-										Host: "0.0.0.0",
+										Host: ptr.To("0.0.0.0"),
 										Port: 3217,
 									},
 								},

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml
@@ -5982,7 +5982,6 @@ spec:
                                         description: |-
                                           Host define the extension service hostname.
                                           Deprecated: Use BackendRef instead.
-                                        minLength: 0
                                         type: string
                                       port:
                                         default: 4317
@@ -5999,13 +5998,13 @@ spec:
                                           Resources is a set of labels that describe the source of a log entry, including envoy node info.
                                           It's recommended to follow [semantic conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/).
                                         type: object
-                                    required:
-                                    - host
                                     type: object
                                     x-kubernetes-validations:
-                                    - message: BackendRef only support Service Kind.
-                                      rule: '!has(self.backendRef) || !has(self.backendRef.kind)
-                                        || self.backendRef.kind == ''Service'''
+                                    - message: host or backendRef needs to be set
+                                      rule: has(self.host) || has(self.backendRef)
+                                    - message: backendRef only support Service Kind.
+                                      rule: '!has(self.backendRef) || self.backendRef.kind
+                                        == ''Service'''
                                   type:
                                     description: Type defines the type of accesslog
                                       sink.
@@ -6176,7 +6175,6 @@ spec:
                                   description: |-
                                     Host define the service hostname.
                                     Deprecated: Use BackendRef instead.
-                                  minLength: 0
                                   type: string
                                 port:
                                   default: 4317
@@ -6187,13 +6185,13 @@ spec:
                                   maximum: 65535
                                   minimum: 0
                                   type: integer
-                              required:
-                              - host
                               type: object
                               x-kubernetes-validations:
-                              - message: BackendRef only support Service Kind.
-                                rule: '!has(self.backendRef) || !has(self.backendRef.kind)
-                                  || self.backendRef.kind == ''Service'''
+                              - message: host or backendRef needs to be set
+                                rule: has(self.host) || has(self.backendRef)
+                              - message: backendRef only support Service Kind.
+                                rule: '!has(self.backendRef) || self.backendRef.kind
+                                  == ''Service'''
                             type:
                               default: OpenTelemetry
                               description: |-
@@ -6367,7 +6365,6 @@ spec:
                             description: |-
                               Host define the provider service hostname.
                               Deprecated: Use BackendRef instead.
-                            minLength: 0
                             type: string
                           port:
                             default: 4317
@@ -6386,13 +6383,14 @@ spec:
                             - OpenTelemetry
                             type: string
                         required:
-                        - host
                         - type
                         type: object
                         x-kubernetes-validations:
-                        - message: BackendRef only support Service Kind.
-                          rule: '!has(self.backendRef) || !has(self.backendRef.kind)
-                            || self.backendRef.kind == ''Service'''
+                        - message: host or backendRef needs to be set
+                          rule: has(self.host) || has(self.backendRef)
+                        - message: backendRef only support Service Kind.
+                          rule: '!has(self.backendRef) || self.backendRef.kind ==
+                            ''Service'''
                       samplingRate:
                         default: 100
                         description: |-

diff --git a/internal/gatewayapi/listener.go b/internal/gatewayapi/listener.go
@@ -217,10 +217,13 @@ func processAccessLog(envoyproxy *egv1a1.EnvoyProxy) *ir.AccessLog {
 				// TODO: remove support for Host/Port in v1.2
 				al := &ir.OpenTelemetryAccessLog{
 					Port:      uint32(sink.OpenTelemetry.Port),
-					Host:      sink.OpenTelemetry.Host,
 					Resources: sink.OpenTelemetry.Resources,
 				}
 
+				if sink.OpenTelemetry.Host != nil {
+					al.Host = *sink.OpenTelemetry.Host
+				}
+
 				if sink.OpenTelemetry.BackendRef != nil {
 					al.Host, al.Port = net.BackendHostAndPort(*sink.OpenTelemetry.BackendRef, envoyproxy.Namespace)
 				}
@@ -249,7 +252,11 @@ func processTracing(gw *gwapiv1.Gateway, envoyproxy *egv1a1.EnvoyProxy) *ir.Trac
 	tracing := envoyproxy.Spec.Telemetry.Tracing
 
 	// TODO: remove support for Host/Port in v1.2
-	host, port := tracing.Provider.Host, uint32(tracing.Provider.Port)
+	var host string
+	var port uint32
+	if tracing.Provider.Host != nil {
+		host, port = *tracing.Provider.Host, uint32(tracing.Provider.Port)
+	}
 	if tracing.Provider.BackendRef != nil {
 		host, port = net.BackendHostAndPort(*tracing.Provider.BackendRef, gw.Namespace)
 	}

diff --git a/internal/gatewayapi/listener_test.go b/internal/gatewayapi/listener_test.go
@@ -6,6 +6,7 @@
 package gatewayapi
 
 import (
+	"k8s.io/utils/ptr"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -55,7 +56,7 @@ func TestProcessTracing(t *testing.T) {
 					Telemetry: &egcfgv1a1.ProxyTelemetry{
 						Tracing: &egcfgv1a1.ProxyTracing{
 							Provider: egcfgv1a1.TracingProvider{
-								Host: "fake-host",
+								Host: ptr.To("fake-host"),
 								Port: 4317,
 							},
 						},
@@ -85,7 +86,7 @@ func TestProcessTracing(t *testing.T) {
 					Telemetry: &egcfgv1a1.ProxyTelemetry{
 						Tracing: &egcfgv1a1.ProxyTracing{
 							Provider: egcfgv1a1.TracingProvider{
-								Host: "fake-host",
+								Host: ptr.To("fake-host"),
 								Port: 4317,
 								BackendRef: &gwapiv1.BackendObjectReference{
 									Name: "fake-name",

diff --git a/internal/gatewayapi/testdata/envoyproxy-accesslog-backend.out.yaml b/internal/gatewayapi/testdata/envoyproxy-accesslog-backend.out.yaml
@@ -115,7 +115,7 @@ infraIR:
                       name: otel-collector
                       namespace: monitoring
                       port: 4317
-                    host: ""
+                    host: null
                     resources:
                       k8s.cluster.name: cluster-1
                   type: OpenTelemetry

diff --git a/internal/xds/bootstrap/bootstrap.go b/internal/xds/bootstrap/bootstrap.go
@@ -83,7 +83,7 @@ type metricSink struct {
 	// Address is the address of the XDS Server that Envoy is managed by.
 	Address string
 	// Port is the port of the XDS Server that Envoy is managed by.
-	Port int32
+	Port uint32
 }
 
 type adminServerParameters struct {
@@ -142,7 +142,11 @@ func GetRenderedBootstrapConfig(proxyMetrics *egv1a1.ProxyMetrics) (string, erro
 			}
 
 			// skip duplicate sinks
-			host, port := sink.OpenTelemetry.Host, uint32(sink.OpenTelemetry.Port)
+			var host string
+			var port uint32
+			if sink.OpenTelemetry.Host == nil {
+				host, port = *sink.OpenTelemetry.Host, uint32(sink.OpenTelemetry.Port)
+			}
 			if sink.OpenTelemetry.BackendRef != nil {
 				host, port = net.BackendHostAndPort(*sink.OpenTelemetry.BackendRef, "")
 			}
@@ -153,8 +157,8 @@ func GetRenderedBootstrapConfig(proxyMetrics *egv1a1.ProxyMetrics) (string, erro
 			addresses.Insert(addr)
 
 			metricSinks = append(metricSinks, metricSink{
-				Address: sink.OpenTelemetry.Host,
-				Port:    sink.OpenTelemetry.Port,
+				Address: host,
+				Port:    port,
 			})
 		}
 

diff --git a/internal/xds/bootstrap/bootstrap_test.go b/internal/xds/bootstrap/bootstrap_test.go
@@ -48,7 +48,7 @@ func TestGetRenderedBootstrapConfig(t *testing.T) {
 					{
 						Type: egv1a1.MetricSinkTypeOpenTelemetry,
 						OpenTelemetry: &egv1a1.ProxyOpenTelemetrySink{
-							Host: "otel-collector.monitoring.svc",
+							Host: ptr.To("otel-collector.monitoring.svc"),
 							Port: 4317,
 						},
 					},
@@ -65,7 +65,7 @@ func TestGetRenderedBootstrapConfig(t *testing.T) {
 					{
 						Type: egv1a1.MetricSinkTypeOpenTelemetry,
 						OpenTelemetry: &egv1a1.ProxyOpenTelemetrySink{
-							Host: "otel-collector.monitoring.svc",
+							Host: ptr.To("otel-collector.monitoring.svc"),
 							Port: 4317,
 							BackendRef: &gwapiv1.BackendObjectReference{
 								Name:      "otel-collector",

diff --git a/internal/xds/bootstrap/testdata/render/otel-metrics.yaml b/internal/xds/bootstrap/testdata/render/otel-metrics.yaml
@@ -81,8 +81,8 @@ static_resources:
         - endpoint:
             address:
               socket_address:
-                address: otel-collector.monitoring.svc
-                port_value: 4317
+                address: 
+                port_value: 0
   - connect_timeout: 10s
     load_assignment:
       cluster_name: xds_cluster