feat(MeshService): add port names (#10287)

Signed-off-by: Mike Beaumont <mjboamail@gmail.com>
kumahq · May 21, 2024 · 612e625 · 612e625
1 parent ad2c42d
commit 612e625
Show file tree

Hide file tree

Showing 19 changed files with 243 additions and 193 deletions.
diff --git a/api/mesh/v1alpha1/dataplane.pb.go b/api/mesh/v1alpha1/dataplane.pb.go
diff --git a/api/mesh/v1alpha1/dataplane.proto b/api/mesh/v1alpha1/dataplane.proto
@@ -153,6 +153,9 @@ message Dataplane {
 
       // State describes the current state of the listener.
       State state = 9;
+
+      // Name adds another way of referencing this port, usable with MeshService
+      string name = 10;
     }
 
     // Outbound describes a service consumed by the data plane proxy.

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.defaults.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.defaults.golden.yaml
@@ -4606,8 +4606,10 @@ spec:
                       description: Protocol identifies a protocol supported by a service.
                       type: string
                     targetPort:
-                      format: int32
-                      type: integer
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      x-kubernetes-int-or-string: true
                   required:
                   - port
                   type: object

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present.yaml
@@ -4606,8 +4606,10 @@ spec:
                       description: Protocol identifies a protocol supported by a service.
                       type: string
                     targetPort:
-                      format: int32
-                      type: integer
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      x-kubernetes-int-or-string: true
                   required:
                   - port
                   type: object

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.with-helm-set.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.with-helm-set.yaml
@@ -4626,8 +4626,10 @@ spec:
                       description: Protocol identifies a protocol supported by a service.
                       type: string
                     targetPort:
-                      format: int32
-                      type: integer
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      x-kubernetes-int-or-string: true
                   required:
                   - port
                   type: object

diff --git a/app/kumactl/cmd/install/testdata/install-crds.all.golden.yaml b/app/kumactl/cmd/install/testdata/install-crds.all.golden.yaml
@@ -6030,8 +6030,10 @@ spec:
                       description: Protocol identifies a protocol supported by a service.
                       type: string
                     targetPort:
-                      format: int32
-                      type: integer
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      x-kubernetes-int-or-string: true
                   required:
                   - port
                   type: object

diff --git a/deployments/charts/kuma/crds/kuma.io_meshservices.yaml b/deployments/charts/kuma/crds/kuma.io_meshservices.yaml
@@ -51,8 +51,10 @@ spec:
                       description: Protocol identifies a protocol supported by a service.
                       type: string
                     targetPort:
-                      format: int32
-                      type: integer
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      x-kubernetes-int-or-string: true
                   required:
                   - port
                   type: object

diff --git a/docs/generated/raw/crds/kuma.io_meshservices.yaml b/docs/generated/raw/crds/kuma.io_meshservices.yaml
@@ -51,8 +51,10 @@ spec:
                       description: Protocol identifies a protocol supported by a service.
                       type: string
                     targetPort:
-                      format: int32
-                      type: integer
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      x-kubernetes-int-or-string: true
                   required:
                   - port
                   type: object

diff --git a/docs/generated/raw/protos/Dataplane.json b/docs/generated/raw/protos/Dataplane.json
@@ -155,6 +155,10 @@
                         }
                     ],
                     "title": "State"
+                },
+                "name": {
+                    "type": "string",
+                    "description": "Name adds another way of referencing this port, usable with MeshService"
                 }
             },
             "additionalProperties": true,

diff --git a/docs/generated/raw/protos/DataplaneOverview.json b/docs/generated/raw/protos/DataplaneOverview.json
@@ -171,6 +171,10 @@
                         }
                     ],
                     "title": "State"
+                },
+                "name": {
+                    "type": "string",
+                    "description": "Name adds another way of referencing this port, usable with MeshService"
                 }
             },
             "additionalProperties": true,

diff --git a/pkg/core/resources/apis/meshservice/api/v1alpha1/meshservice.go b/pkg/core/resources/apis/meshservice/api/v1alpha1/meshservice.go
@@ -2,6 +2,8 @@
 package v1alpha1
 
 import (
+	"k8s.io/apimachinery/pkg/util/intstr"
+
 	core_mesh "github.com/kumahq/kuma/pkg/core/resources/apis/mesh"
 )
 
@@ -12,8 +14,8 @@ type Selector struct {
 }
 
 type Port struct {
-	Port       uint32 `json:"port"`
-	TargetPort uint32 `json:"targetPort,omitempty"`
+	Port       uint32             `json:"port"`
+	TargetPort intstr.IntOrString `json:"targetPort,omitempty"`
 	// +kubebuilder:default=tcp
 	Protocol core_mesh.Protocol `json:"protocol,omitempty"`
 }

diff --git a/pkg/core/resources/apis/meshservice/api/v1alpha1/schema.yaml b/pkg/core/resources/apis/meshservice/api/v1alpha1/schema.yaml
@@ -26,8 +26,10 @@ properties:
               description: Protocol identifies a protocol supported by a service.
               type: string
             targetPort:
-              format: int32
-              type: integer
+              anyOf:
+                - type: integer
+                - type: string
+              x-kubernetes-int-or-string: true
           required:
             - port
           type: object

diff --git a/pkg/core/resources/apis/meshservice/api/v1alpha1/zz_generated.deepcopy.go b/pkg/core/resources/apis/meshservice/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/core/resources/apis/meshservice/k8s/crd/kuma.io_meshservices.yaml b/pkg/core/resources/apis/meshservice/k8s/crd/kuma.io_meshservices.yaml
@@ -51,8 +51,10 @@ spec:
                       description: Protocol identifies a protocol supported by a service.
                       type: string
                     targetPort:
-                      format: int32
-                      type: integer
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      x-kubernetes-int-or-string: true
                   required:
                   - port
                   type: object

diff --git a/pkg/plugins/policies/meshhttproute/plugin/v1alpha1/plugin_test.go b/pkg/plugins/policies/meshhttproute/plugin/v1alpha1/plugin_test.go
@@ -130,7 +130,7 @@ var _ = Describe("MeshHTTPRoute", func() {
 					Selector: meshservice_api.Selector{},
 					Ports: []meshservice_api.Port{{
 						Port:       80,
-						TargetPort: 8084,
+						TargetPort: intstr.FromInt(8084),
 						Protocol:   core_mesh.ProtocolHTTP,
 					}},
 				},

diff --git a/pkg/plugins/runtime/k8s/controllers/meshservice_controller.go b/pkg/plugins/runtime/k8s/controllers/meshservice_controller.go
@@ -8,7 +8,7 @@ import (
 	"github.com/pkg/errors"
 	kube_core "k8s.io/api/core/v1"
 	kube_apierrs "k8s.io/apimachinery/pkg/api/errors"
-	"k8s.io/apimachinery/pkg/apis/meta/v1"
+	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kube_runtime "k8s.io/apimachinery/pkg/runtime"
 	kube_types "k8s.io/apimachinery/pkg/types"
 	kube_ctrl "sigs.k8s.io/controller-runtime"
@@ -126,7 +126,7 @@ func (r *MeshServiceReconciler) Reconcile(ctx context.Context, req kube_ctrl.Req
 			}
 			ms.Spec.Ports = append(ms.Spec.Ports, meshservice_api.Port{
 				Port:       uint32(port.Port),
-				TargetPort: uint32(port.TargetPort.IntVal), // todo(jakubdyszkiewicz): update after API changes
+				TargetPort: port.TargetPort,
 				Protocol:   core_mesh.Protocol(pointer.DerefOr(port.AppProtocol, "tcp")),
 			})
 		}

diff --git a/pkg/test/store/store_test_template.go b/pkg/test/store/store_test_template.go
@@ -8,6 +8,7 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	"k8s.io/apimachinery/pkg/util/intstr"
 
 	"github.com/kumahq/kuma/api/mesh/v1alpha1"
 	core_mesh "github.com/kumahq/kuma/pkg/core/resources/apis/mesh"
@@ -125,7 +126,7 @@ func ExecuteStoreTests(
 						Ports: []meshservice_api.Port{
 							{
 								Port:       80,
-								TargetPort: 80,
+								TargetPort: intstr.FromInt(80),
 								Protocol:   "http",
 							},
 						},
@@ -235,7 +236,7 @@ func ExecuteStoreTests(
 						Ports: []meshservice_api.Port{
 							{
 								Port:       80,
-								TargetPort: 80,
+								TargetPort: intstr.FromInt(80),
 								Protocol:   "http",
 							},
 						},

diff --git a/pkg/xds/topology/outbound.go b/pkg/xds/topology/outbound.go
@@ -7,6 +7,7 @@ import (
 	"strconv"
 
 	"github.com/pkg/errors"
+	"k8s.io/apimachinery/pkg/util/intstr"
 
 	mesh_proto "github.com/kumahq/kuma/api/mesh/v1alpha1"
 	"github.com/kumahq/kuma/api/system/v1alpha1"
@@ -162,8 +163,15 @@ func fillLocalMeshServices(
 					continue
 				}
 				for _, port := range meshSvc.Spec.Ports {
-					if port.TargetPort != inbound.Port {
-						continue
+					switch port.TargetPort.Type {
+					case intstr.Int:
+						if uint32(port.TargetPort.IntVal) != inbound.Port {
+							continue
+						}
+					case intstr.String:
+						if port.TargetPort.StrVal != inbound.Name {
+							continue
+						}
 					}
 
 					inboundTags := maps.Clone(inbound.GetTags())

diff --git a/pkg/xds/topology/outbound_test.go b/pkg/xds/topology/outbound_test.go
@@ -5,6 +5,7 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	"k8s.io/apimachinery/pkg/util/intstr"
 
 	mesh_proto "github.com/kumahq/kuma/api/mesh/v1alpha1"
 	"github.com/kumahq/kuma/pkg/core/datasource"
@@ -1192,12 +1193,12 @@ var _ = Describe("TrafficRoute", func() {
 							Ports: []v1alpha1.Port{
 								{
 									Port:       80,
-									TargetPort: 8080,
+									TargetPort: intstr.FromInt(8080),
 									Protocol:   "http",
 								},
 								{
 									Port:       8081,
-									TargetPort: 8081,
+									TargetPort: intstr.FromInt(8081),
 									Protocol:   "http",
 								},
 							},
@@ -1217,7 +1218,7 @@ var _ = Describe("TrafficRoute", func() {
 							Ports: []v1alpha1.Port{
 								{
 									Port:       6379,
-									TargetPort: 6379,
+									TargetPort: intstr.FromInt(6379),
 								},
 							},
 						},