feat/add support for hostPort in container (open-telemetry#2763)

Signed-off-by: Bruno Teixeira <[email protected]>

.chloggen/2763 - add hostPort support.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
+component: operator
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Add support for adding/extending otc-collector container ports."
+
+# One or more tracking issues related to the change
+issues: [2763]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: 

apis/v1alpha1/collector_webhook_test.go

@@ -475,15 +475,19 @@ func TestOTELColValidatingWebhook(t *testing.T) {
       thrift_http:
         endpoint: 0.0.0.0:15268
 `,
-					Ports: []v1.ServicePort{
+					Ports: []PortsSpec{
 						{
-							Name: "port1",
-							Port: 5555,
+							ServicePort: v1.ServicePort{
+								Name: "port1",
+								Port: 5555,
+							},
 						},
 						{
-							Name:     "port2",
-							Port:     5554,
-							Protocol: v1.ProtocolUDP,
+							ServicePort: v1.ServicePort{
+								Name:     "port2",
+								Port:     5554,
+								Protocol: v1.ProtocolUDP,
+							},
 						},
 					},
 					Autoscaler: &AutoscalerSpec{
@@ -533,15 +537,19 @@ func TestOTELColValidatingWebhook(t *testing.T) {
       thrift_http:
         endpoint: 0.0.0.0:15268
 `,
-					Ports: []v1.ServicePort{
+					Ports: []PortsSpec{
 						{
-							Name: "port1",
-							Port: 5555,
+							ServicePort: v1.ServicePort{
+								Name: "port1",
+								Port: 5555,
+							},
 						},
 						{
-							Name:     "port2",
-							Port:     5554,
-							Protocol: v1.ProtocolUDP,
+							ServicePort: v1.ServicePort{
+								Name:     "port2",
+								Port:     5554,
+								Protocol: v1.ProtocolUDP,
+							},
 						},
 					},
 					Autoscaler: &AutoscalerSpec{
@@ -601,15 +609,19 @@ func TestOTELColValidatingWebhook(t *testing.T) {
       thrift_http:
         endpoint: 0.0.0.0:15268
 `,
-					Ports: []v1.ServicePort{
+					Ports: []PortsSpec{
 						{
-							Name: "port1",
-							Port: 5555,
+							ServicePort: v1.ServicePort{
+								Name: "port1",
+								Port: 5555,
+							},
 						},
 						{
-							Name:     "port2",
-							Port:     5554,
-							Protocol: v1.ProtocolUDP,
+							ServicePort: v1.ServicePort{
+								Name:     "port2",
+								Port:     5554,
+								Protocol: v1.ProtocolUDP,
+							},
 						},
 					},
 					Autoscaler: &AutoscalerSpec{
@@ -687,12 +699,14 @@ func TestOTELColValidatingWebhook(t *testing.T) {
 			name: "invalid port name",
 			otelcol: OpenTelemetryCollector{
 				Spec: OpenTelemetryCollectorSpec{
-					Ports: []v1.ServicePort{
+					Ports: []PortsSpec{
 						{
-							// this port name contains a non alphanumeric character, which is invalid.
-							Name:     "-test🦄port",
-							Port:     12345,
-							Protocol: v1.ProtocolTCP,
+							ServicePort: v1.ServicePort{
+								// this port name contains a non alphanumeric character, which is invalid.
+								Name:     "-test🦄port",
+								Port:     12345,
+								Protocol: v1.ProtocolTCP,
+							},
 						},
 					},
 				},
@@ -703,10 +717,12 @@ func TestOTELColValidatingWebhook(t *testing.T) {
 			name: "invalid port name, too long",
 			otelcol: OpenTelemetryCollector{
 				Spec: OpenTelemetryCollectorSpec{
-					Ports: []v1.ServicePort{
+					Ports: []PortsSpec{
 						{
-							Name: "aaaabbbbccccdddd", // len: 16, too long
-							Port: 5555,
+							ServicePort: v1.ServicePort{
+								Name: "aaaabbbbccccdddd", // len: 16, too long
+								Port: 5555,
+							},
 						},
 					},
 				},
@@ -717,10 +733,12 @@ func TestOTELColValidatingWebhook(t *testing.T) {
 			name: "invalid port num",
 			otelcol: OpenTelemetryCollector{
 				Spec: OpenTelemetryCollectorSpec{
-					Ports: []v1.ServicePort{
+					Ports: []PortsSpec{
 						{
-							Name: "aaaabbbbccccddd", // len: 15
-							// no port set means it's 0, which is invalid
+							ServicePort: v1.ServicePort{
+								Name: "aaaabbbbccccddd", // len: 15
+								// no port set means it's 0, which is invalid
+							},
 						},
 					},
 				},

apis/v1alpha1/convert.go

@@ -20,6 +20,7 @@ import (
 
 	"gopkg.in/yaml.v3"
 	appsv1 "k8s.io/api/apps/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
@@ -96,7 +97,7 @@ func tov1beta1(in OpenTelemetryCollector) (v1beta1.OpenTelemetryCollector, error
 				Image:                         copy.Spec.Image,
 				ImagePullPolicy:               copy.Spec.ImagePullPolicy,
 				VolumeMounts:                  copy.Spec.VolumeMounts,
-				Ports:                         copy.Spec.Ports,
+				Ports:                         tov1beta1Ports(copy.Spec.Ports),
 				Env:                           copy.Spec.Env,
 				EnvFrom:                       copy.Spec.EnvFrom,
 				VolumeClaimTemplates:          copy.Spec.VolumeClaimTemplates,
@@ -144,6 +145,26 @@ func tov1beta1(in OpenTelemetryCollector) (v1beta1.OpenTelemetryCollector, error
 	}, nil
 }
 
+func tov1beta1Ports(in []PortsSpec) []v1beta1.PortsSpec {
+	var ports []v1beta1.PortsSpec
+
+	for _, p := range in {
+		ports = append(ports, v1beta1.PortsSpec{
+			ServicePort: v1.ServicePort{
+				Name:        p.Name,
+				Protocol:    p.Protocol,
+				AppProtocol: p.AppProtocol,
+				Port:        p.Port,
+				TargetPort:  p.TargetPort,
+				NodePort:    p.NodePort,
+			},
+			HostPort: p.HostPort,
+		})
+	}
+
+	return ports
+}
+
 func tov1beta1TA(in OpenTelemetryTargetAllocator) v1beta1.TargetAllocatorEmbedded {
 	return v1beta1.TargetAllocatorEmbedded{
 		Replicas:           in.Replicas,
@@ -249,6 +270,26 @@ func tov1beta1ConfigMaps(in []ConfigMapsSpec) []v1beta1.ConfigMapsSpec {
 	return mapsSpecs
 }
 
+func tov1alpha1Ports(in []v1beta1.PortsSpec) []PortsSpec {
+	var ports []PortsSpec
+
+	for _, p := range in {
+		ports = append(ports, PortsSpec{
+			ServicePort: v1.ServicePort{
+				Name:        p.Name,
+				Protocol:    p.Protocol,
+				AppProtocol: p.AppProtocol,
+				Port:        p.Port,
+				TargetPort:  p.TargetPort,
+				NodePort:    p.NodePort,
+			},
+			HostPort: p.HostPort,
+		})
+	}
+
+	return ports
+}
+
 func tov1alpha1(in v1beta1.OpenTelemetryCollector) (*OpenTelemetryCollector, error) {
 	copy := in.DeepCopy()
 	configYaml, err := copy.Spec.Config.Yaml()
@@ -287,7 +328,7 @@ func tov1alpha1(in v1beta1.OpenTelemetryCollector) (*OpenTelemetryCollector, err
 			ImagePullPolicy:      copy.Spec.ImagePullPolicy,
 			Config:               configYaml,
 			VolumeMounts:         copy.Spec.VolumeMounts,
-			Ports:                copy.Spec.Ports,
+			Ports:                tov1alpha1Ports(copy.Spec.Ports),
 			Env:                  copy.Spec.Env,
 			EnvFrom:              copy.Spec.EnvFrom,
 			VolumeClaimTemplates: copy.Spec.VolumeClaimTemplates,

apis/v1alpha1/convert_test.go

@@ -177,11 +177,12 @@ func Test_tov1beta1AndBack(t *testing.T) {
 					Name: "aaa",
 				},
 			},
-			Ports: []v1.ServicePort{
-				{
+			Ports: []PortsSpec{{
+				ServicePort: v1.ServicePort{
 					Name: "otlp",
 				},
-			},
+				HostPort: 0,
+			}},
 			Env: []v1.EnvVar{
 				{
 					Name:  "foo",

apis/v1alpha1/opentelemetrycollector_types.go

@@ -186,7 +186,7 @@ type OpenTelemetryCollectorSpec struct {
 	// used to open additional ports that can't be inferred by the operator, like for custom receivers.
 	// +optional
 	// +listType=atomic
-	Ports []v1.ServicePort `json:"ports,omitempty"`
+	Ports []PortsSpec `json:"ports,omitempty"`
 	// ENV vars to set on the OpenTelemetry Collector's Pods. These can then in certain cases be
 	// consumed in the config file for the Collector.
 	// +optional
@@ -291,6 +291,16 @@ type OpenTelemetryCollectorSpec struct {
 	DeploymentUpdateStrategy appsv1.DeploymentStrategy `json:"deploymentUpdateStrategy,omitempty"`
 }
 
+// PortsSpec defines the OpenTelemetryCollector's container/service ports additional specifications.
+type PortsSpec struct {
+	// Allows defining which port to bind to the host in the Container.
+	// +optional
+	HostPort int32 `json:"hostPort,omitempty"`
+
+	// Maintain previous fields in new struct
+	v1.ServicePort `json:",inline"`
+}
+
 // OpenTelemetryTargetAllocator defines the configurations for the Prometheus target allocator.
 type OpenTelemetryTargetAllocator struct {
 	// Replicas is the number of pod instances for the underlying TargetAllocator. This should only be set to a value

apis/v1beta1/common.go

@@ -84,6 +84,16 @@ type PodDisruptionBudgetSpec struct {
 	MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty"`
 }
 
+// PortsSpec defines the OpenTelemetryCollector's container/service ports additional specifications.
+type PortsSpec struct {
+	// Allows defining which port to bind to the host in the Container.
+	// +optional
+	HostPort int32 `json:"hostPort,omitempty"`
+
+	// Maintain previous fields in new struct
+	v1.ServicePort `json:",inline"`
+}
+
 type OpenTelemetryCommonFields struct {
 	// ManagementState defines if the CR should be managed by the operator or not.
 	// Default is managed.
@@ -151,12 +161,12 @@ type OpenTelemetryCommonFields struct {
 	// +optional
 	// +listType=atomic
 	VolumeMounts []v1.VolumeMount `json:"volumeMounts,omitempty"`
-	// Ports allows a set of ports to be exposed by the underlying v1.Service. By default, the operator
+	// Ports allows a set of ports to be exposed by the underlying v1.Service & v1.ContainerPort. By default, the operator
 	// will attempt to infer the required ports by parsing the .Spec.Config property but this property can be
 	// used to open additional ports that can't be inferred by the operator, like for custom receivers.
 	// +optional
 	// +listType=atomic
-	Ports []v1.ServicePort `json:"ports,omitempty"`
+	Ports []PortsSpec `json:"ports,omitempty"`
 	// Environment variables to set on the generated pods.
 	// +optional
 	Env []v1.EnvVar `json:"env,omitempty"`

bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml

@@ -4184,14 +4184,20 @@ spec:
                   Ports allows a set of ports to be exposed by the underlying v1.Service. By default, the operator
                   will attempt to infer the required ports by parsing the .Spec.
                 items:
-                  description: ServicePort contains information on service's port.
+                  description: PortsSpec defines the OpenTelemetryCollector's container/service
+                    ports additional specifications.
                   properties:
                     appProtocol:
                       description: |-
                         The application protocol for this port.
                         This is used as a hint for implementations to offer richer behavior for protocols that they understand.
                         This field follows standard Kubernetes label syntax.
                       type: string
+                    hostPort:
+                      description: Allows defining which port to bind to the host
+                        in the Container.
+                      format: int32
+                      type: integer
                     name:
                       description: |-
                         The name of this port within the service. This must be a DNS_LABEL.