feat/add support for hostPort in container

Author: Your Name

.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/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 []v1.ServicePort) []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: 0,
+		})
+	}
+
+	return ports
+}
+
 func tov1beta1TA(in OpenTelemetryTargetAllocator) v1beta1.TargetAllocatorEmbedded {
 	return v1beta1.TargetAllocatorEmbedded{
 		Replicas:           in.Replicas,
@@ -249,6 +270,16 @@ func tov1beta1ConfigMaps(in []ConfigMapsSpec) []v1beta1.ConfigMapsSpec {
 	return mapsSpecs
 }
 
+func tov1alpha1Ports(in []v1beta1.PortsSpec) []v1.ServicePort {
+	var ports []v1.ServicePort
+
+	for _, p := range in {
+		ports = append(ports, p.ServicePort)
+	}
+
+	return ports
+}
+
 func tov1alpha1(in v1beta1.OpenTelemetryCollector) (*OpenTelemetryCollector, error) {
 	copy := in.DeepCopy()
 	configYaml, err := copy.Spec.Config.Yaml()
@@ -287,7 +318,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/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"`

apis/v1beta1/zz_generated.deepcopy.go

@@ -6606,6 +6606,9 @@ spec:
                   properties:
                     appProtocol:
                       type: string
+                    hostPort:
+                      format: int32
+                      type: integer
                     name:
                       type: string
                     nodePort:

bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml

@@ -6592,6 +6592,9 @@ spec:
                   properties:
                     appProtocol:
                       type: string
+                    hostPort:
+                      format: int32
+                      type: integer
                     name:
                       type: string
                     nodePort:

config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml

@@ -2199,6 +2199,9 @@ spec:
                   properties:
                     appProtocol:
                       type: string
+                    hostPort:
+                      format: int32
+                      type: integer
                     name:
                       type: string
                     nodePort:

config/crd/bases/opentelemetry.io_targetallocators.yaml

@@ -1,2 +1,7 @@
 resources:
 - manager.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+images:
+- name: controller
+  newName: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator

config/manager/kustomization.yaml

@@ -34018,6 +34018,15 @@ Resource Types:
           <br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>hostPort</b></td>
+        <td>integer</td>
+        <td>
+          <br/>
+          <br/>
+            <i>Format</i>: int32<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>name</b></td>
         <td>string</td>

docs/api.md

@@ -25,6 +25,7 @@ import (
 	"github.com/mitchellh/mapstructure"
 	corev1 "k8s.io/api/core/v1"
 
+	"github.com/open-telemetry/opentelemetry-operator/apis/v1beta1"
 	"github.com/open-telemetry/opentelemetry-operator/internal/manifests/collector/parser"
 	exporterParser "github.com/open-telemetry/opentelemetry-operator/internal/manifests/collector/parser/exporter"
 	receiverParser "github.com/open-telemetry/opentelemetry-operator/internal/manifests/collector/parser/receiver"
@@ -43,7 +44,7 @@ func (c ComponentType) String() string {
 }
 
 // ConfigToComponentPorts converts the incoming configuration object into a set of service ports required by the exporters.
-func ConfigToComponentPorts(logger logr.Logger, cType ComponentType, config map[interface{}]interface{}) ([]corev1.ServicePort, error) {
+func ConfigToComponentPorts(logger logr.Logger, cType ComponentType, config map[interface{}]interface{}) ([]v1beta1.PortsSpec, error) {
 	// now, we gather which ports we might need to open
 	// for that, we get all the exporters and check their `endpoint` properties,
 	// extracting the port from it. The port name has to be a "DNS_LABEL", so, we try to make it follow the pattern:
@@ -119,10 +120,17 @@ func ConfigToComponentPorts(logger logr.Logger, cType ComponentType, config map[
 		return ports[i].Name < ports[j].Name
 	})
 
-	return ports, nil
+	patchedPorts := []v1beta1.PortsSpec{}
+	for _, p := range ports {
+		patchedPorts = append(patchedPorts, v1beta1.PortsSpec{
+			ServicePort: p,
+		})
+	}
+
+	return patchedPorts, nil
 }
 
-func ConfigToPorts(logger logr.Logger, config map[interface{}]interface{}) ([]corev1.ServicePort, error) {
+func ConfigToPorts(logger logr.Logger, config map[interface{}]interface{}) ([]v1beta1.PortsSpec, error) {
 	ports, err := ConfigToComponentPorts(logger, ComponentTypeReceiver, config)
 	if err != nil {
 		logger.Error(err, "there was a problem while getting the ports from the receivers")

internal/manifests/collector/adapters/config_to_ports.go

@@ -95,6 +95,11 @@ func TestExtractPortsFromConfig(t *testing.T) {
 	targetPort4317 := intstr.IntOrString{Type: 0, IntVal: 4317, StrVal: ""}
 	targetPort4318 := intstr.IntOrString{Type: 0, IntVal: 4318, StrVal: ""}
 
+	svcPorts := []corev1.ServicePort{}
+	for _, p := range ports {
+		svcPorts = append(svcPorts, p.ServicePort)
+	}
+
 	expectedPorts := []corev1.ServicePort{
 		{Name: "examplereceiver", Port: 12345},
 		{Name: "port-12346", Port: 12346},
@@ -107,7 +112,7 @@ func TestExtractPortsFromConfig(t *testing.T) {
 		{Name: "otlp-http", AppProtocol: &httpAppProtocol, Port: 4318, TargetPort: targetPort4318},
 		{Name: "zipkin", AppProtocol: &httpAppProtocol, Protocol: "TCP", Port: 9411},
 	}
-	assert.ElementsMatch(t, expectedPorts, ports)
+	assert.ElementsMatch(t, expectedPorts, svcPorts)
 }
 
 func TestNoPortsParsed(t *testing.T) {

internal/manifests/collector/adapters/config_to_ports_test.go

@@ -59,6 +59,7 @@ func Container(cfg config.Config, logger logr.Logger, otelcol v1beta1.OpenTeleme
 			Name:          p.Name,
 			ContainerPort: p.Port,
 			Protocol:      p.Protocol,
+			HostPort:      p.HostPort,
 		}
 	}