Added protocol in port configuration

docs/docs/20-usage/60-services.md

@@ -22,6 +22,20 @@ services:
     image: redis
 ```
 
+You can define a port and a protocol explicitly:
+
+```yamlservices:
+  database:
+    image: mysql
+    ports:
+      - 3306
+
+  wireguard:
+    image: wg
+    ports:
+      - 51820/udp
+```
+
 ## Configuration
 
 Service containers generally expose environment variables to customize service startup such as default usernames, passwords and ports. Please see the official image documentation to learn more.

pipeline/backend/kubernetes/service.go

@@ -17,6 +17,7 @@ package kubernetes
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	"github.com/rs/zerolog/log"
 	"go.woodpecker-ci.org/woodpecker/v2/pipeline/backend/types"
@@ -26,16 +27,12 @@ import (
 	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
-func mkService(namespace, name string, ports []uint16, selector map[string]string) (*v1.Service, error) {
+func mkService(namespace, name string, ports []types.Port, selector map[string]string) (*v1.Service, error) {
 	log.Trace().Str("name", name).Interface("selector", selector).Interface("ports", ports).Msg("Creating service")
 
 	var svcPorts []v1.ServicePort
 	for _, port := range ports {
-		svcPorts = append(svcPorts, v1.ServicePort{
-			Name:       fmt.Sprintf("port-%d", port),
-			Port:       int32(port),
-			TargetPort: intstr.IntOrString{IntVal: int32(port)},
-		})
+		svcPorts = append(svcPorts, servicePort(port))
 	}
 
 	return &v1.Service{
@@ -55,6 +52,17 @@ func serviceName(step *types.Step) (string, error) {
 	return dnsName(step.Name)
 }
 
+func servicePort(port types.Port) v1.ServicePort {
+	portNumber := int32(port.Number)
+	portProtocol := strings.ToUpper(port.Protocol)
+	return v1.ServicePort{
+		Name:       fmt.Sprintf("port-%d", portNumber),
+		Port:       portNumber,
+		Protocol:   v1.Protocol(portProtocol),
+		TargetPort: intstr.IntOrString{IntVal: portNumber},
+	}
+}
+
 func startService(ctx context.Context, engine *kube, step *types.Step) (*v1.Service, error) {
 	name, err := serviceName(step)
 	if err != nil {

pipeline/backend/kubernetes/service_test.go

@@ -52,11 +52,13 @@ func TestService(t *testing.T) {
 	      },
 	      {
 	        "name": "port-2",
+					"protocol": "TCP",
 	        "port": 2,
 	        "targetPort": 2
 	      },
 	      {
 	        "name": "port-3",
+					"protocol": "UDP",
 	        "port": 3,
 	        "targetPort": 3
 	      }
@@ -70,8 +72,12 @@ func TestService(t *testing.T) {
 	    "loadBalancer": {}
 	  }
 	}`
-
-	s, _ := mkService("foo", "bar", []uint16{1, 2, 3}, map[string]string{"step": "baz"})
+	ports := []types.Port{
+		{Number: 1},
+		{Number: 2, Protocol: "tcp"},
+		{Number: 3, Protocol: "udp"},
+	}
+	s, _ := mkService("foo", "bar", ports, map[string]string{"step": "baz"})
 	j, err := json.Marshal(s)
 	assert.NoError(t, err)
 	assert.JSONEq(t, expected, string(j))

pipeline/backend/types/network.go

@@ -18,3 +18,8 @@ package types
 type Network struct {
 	Name string `json:"name,omitempty"`
 }
+
+type Port struct {
+	Number   uint16 `json:"number,omitempty"`
+	Protocol string `json:"protocol,omitempty"`
+}

pipeline/backend/types/step.go

@@ -48,7 +48,7 @@ type Step struct {
 	NetworkMode    string            `json:"network_mode,omitempty"`
 	IpcMode        string            `json:"ipc_mode,omitempty"`
 	Sysctls        map[string]string `json:"sysctls,omitempty"`
-	Ports          []uint16          `json:"ports,omitempty"`
+	Ports          []Port            `json:"ports,omitempty"`
 	BackendOptions BackendOptions    `json:"backend_options,omitempty"`
 }
 

pipeline/frontend/yaml/compiler/convert.go

@@ -18,6 +18,7 @@
 	"fmt"
 	"maps"
 	"path"
+	"strconv"
 	"strings"
 
 	"github.com/oklog/ulid/v2"
@@ -146,9 +147,13 @@
 		cpuSet = c.reslimit.CPUSet
 	}
 
-	var ports []uint16
-	for _, port := range container.Ports {
-		ports = append(ports, uint16(port))
+	var ports []backend_types.Port
+	for _, portDef := range container.Ports {
+		port, err := convertPort(portDef)
+		if err != nil {
+			return nil, err
+		}
+		ports = append(ports, port)
 	}
 
 	// at least one constraint contain status success, or all constraints have no status set
@@ -205,6 +210,28 @@
 	return path.Join(c.base, c.path, container.Directory)
 }
 
+func convertPort(portDef string) (backend_types.Port, error) {
+	var err error
+	var port backend_types.Port
+
+	portArr := strings.Split(portDef, "/")
+
+	portNumber, err := strconv.ParseUint(portArr[0], 10, 16)
+	if err != nil {
+		return port, err
+	}
+
+	var proto string
+	if len(portArr) > 1 {
+		proto = portArr[1]
+	}
+
+	port.Number = uint16(portNumber)
+	port.Protocol = proto
+
+	return port, nil
+}
+
 func convertKubernetesBackendOptions(kubeOpt *yaml_types.KubernetesBackendOptions) backend_types.KubernetesBackendOptions {
 	resources := backend_types.Resources{
 		Limits:   kubeOpt.Resources.Limits,

pipeline/frontend/yaml/linter/schema/schema.json

@@ -771,14 +771,7 @@
           "description": "expose ports to which other steps can connect to",
           "type": "array",
           "items": {
-            "oneOf": [
-              {
-                "type": "number"
-              },
-              {
-                "type": "string"
-              }
-            ]
+            "type": "string"
           },
           "minLength": 1
         }

pipeline/frontend/yaml/types/container.go

@@ -47,7 +47,7 @@ type (
 		Settings       map[string]any     `yaml:"settings"`
 		Volumes        Volumes            `yaml:"volumes,omitempty"`
 		When           constraint.When    `yaml:"when,omitempty"`
-		Ports          []base.StringOrInt `yaml:"ports,omitempty"`
+		Ports          []string           `yaml:"ports,omitempty"`
 
 		// Docker Specific
 		Privileged bool `yaml:"privileged,omitempty"`

pipeline/frontend/yaml/types/container_test.go

@@ -70,6 +70,8 @@ settings:
   baz: false
 ports:
   - 8080
+  - 4443/tcp
+  - 51820/udp
 `)
 
 func TestUnmarshalContainer(t *testing.T) {
@@ -128,7 +130,7 @@ func TestUnmarshalContainer(t *testing.T) {
 			"foo": "bar",
 			"baz": false,
 		},
-		Ports: []base.StringOrInt{8080},
+		Ports: []string{"8080", "4443/tcp", "51820/udp"},
 	}
 	got := Container{}
 	err := yaml.Unmarshal(containerYaml, &got)