feat(meshservice): proxies stats and state (#10970)

Signed-off-by: Jakub Dyszkiewicz <jakub.dyszkiewicz@gmail.com>
kumahq · Jul 25, 2024 · 11aa52a · 11aa52a
1 parent f48c8d2
commit 11aa52a
Show file tree

Hide file tree

Showing 29 changed files with 488 additions and 17 deletions.
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
@@ -5714,6 +5714,14 @@ spec:
                       type: string
                     type: object
                 type: object
+              state:
+                description: |-
+                  State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable.
+                  It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService.
+                enum:
+                - Available
+                - Unavailable
+                type: string
             type: object
           status:
             description: Status is the current status of the Kuma MeshService resource.
@@ -5734,6 +5742,21 @@ spec:
                       type: string
                   type: object
                 type: array
+              dataplaneProxies:
+                description: Data plane proxies statistics selected by this MeshService.
+                properties:
+                  connected:
+                    description: Number of data plane proxies connected to the zone
+                      control plane
+                    type: integer
+                  healthy:
+                    description: Number of data plane proxies with all healthy inbounds
+                      selected by this MeshService.
+                    type: integer
+                  total:
+                    description: Total number of data plane proxies.
+                    type: integer
+                type: object
               hostnameGenerators:
                 items:
                   properties:

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
@@ -5714,6 +5714,14 @@ spec:
                       type: string
                     type: object
                 type: object
+              state:
+                description: |-
+                  State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable.
+                  It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService.
+                enum:
+                - Available
+                - Unavailable
+                type: string
             type: object
           status:
             description: Status is the current status of the Kuma MeshService resource.
@@ -5734,6 +5742,21 @@ spec:
                       type: string
                   type: object
                 type: array
+              dataplaneProxies:
+                description: Data plane proxies statistics selected by this MeshService.
+                properties:
+                  connected:
+                    description: Number of data plane proxies connected to the zone
+                      control plane
+                    type: integer
+                  healthy:
+                    description: Number of data plane proxies with all healthy inbounds
+                      selected by this MeshService.
+                    type: integer
+                  total:
+                    description: Total number of data plane proxies.
+                    type: integer
+                type: object
               hostnameGenerators:
                 items:
                   properties:

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
@@ -5734,6 +5734,14 @@ spec:
                       type: string
                     type: object
                 type: object
+              state:
+                description: |-
+                  State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable.
+                  It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService.
+                enum:
+                - Available
+                - Unavailable
+                type: string
             type: object
           status:
             description: Status is the current status of the Kuma MeshService resource.
@@ -5754,6 +5762,21 @@ spec:
                       type: string
                   type: object
                 type: array
+              dataplaneProxies:
+                description: Data plane proxies statistics selected by this MeshService.
+                properties:
+                  connected:
+                    description: Number of data plane proxies connected to the zone
+                      control plane
+                    type: integer
+                  healthy:
+                    description: Number of data plane proxies with all healthy inbounds
+                      selected by this MeshService.
+                    type: integer
+                  total:
+                    description: Total number of data plane proxies.
+                    type: integer
+                type: object
               hostnameGenerators:
                 items:
                   properties:

diff --git a/app/kumactl/cmd/install/testdata/install-crds.all.golden.yaml b/app/kumactl/cmd/install/testdata/install-crds.all.golden.yaml
@@ -7268,6 +7268,14 @@ spec:
                       type: string
                     type: object
                 type: object
+              state:
+                description: |-
+                  State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable.
+                  It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService.
+                enum:
+                - Available
+                - Unavailable
+                type: string
             type: object
           status:
             description: Status is the current status of the Kuma MeshService resource.
@@ -7288,6 +7296,21 @@ spec:
                       type: string
                   type: object
                 type: array
+              dataplaneProxies:
+                description: Data plane proxies statistics selected by this MeshService.
+                properties:
+                  connected:
+                    description: Number of data plane proxies connected to the zone
+                      control plane
+                    type: integer
+                  healthy:
+                    description: Number of data plane proxies with all healthy inbounds
+                      selected by this MeshService.
+                    type: integer
+                  total:
+                    description: Total number of data plane proxies.
+                    type: integer
+                type: object
               hostnameGenerators:
                 items:
                   properties:

diff --git a/deployments/charts/kuma/crds/kuma.io_meshservices.yaml b/deployments/charts/kuma/crds/kuma.io_meshservices.yaml
@@ -91,6 +91,14 @@ spec:
                       type: string
                     type: object
                 type: object
+              state:
+                description: |-
+                  State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable.
+                  It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService.
+                enum:
+                - Available
+                - Unavailable
+                type: string
             type: object
           status:
             description: Status is the current status of the Kuma MeshService resource.
@@ -111,6 +119,21 @@ spec:
                       type: string
                   type: object
                 type: array
+              dataplaneProxies:
+                description: Data plane proxies statistics selected by this MeshService.
+                properties:
+                  connected:
+                    description: Number of data plane proxies connected to the zone
+                      control plane
+                    type: integer
+                  healthy:
+                    description: Number of data plane proxies with all healthy inbounds
+                      selected by this MeshService.
+                    type: integer
+                  total:
+                    description: Total number of data plane proxies.
+                    type: integer
+                type: object
               hostnameGenerators:
                 items:
                   properties:

diff --git a/docs/generated/openapi.yaml b/docs/generated/openapi.yaml
@@ -11370,6 +11370,18 @@ components:
                     type: string
                   type: object
               type: object
+            state:
+              description: >-
+                State of MeshService. Available if there is at least one healthy
+                endpoint. Otherwise, Unavailable.
+
+                It's used for cross zone communication to check if we should
+                send traffic to it, when MeshService is aggregated into
+                MeshMultiZoneService.
+              enum:
+                - Available
+                - Unavailable
+              type: string
           type: object
         status:
           description: Status is the current status of the Kuma MeshService resource.
@@ -11390,6 +11402,23 @@ components:
                     type: string
                 type: object
               type: array
+            dataplaneProxies:
+              description: Data plane proxies statistics selected by this MeshService.
+              properties:
+                connected:
+                  description: >-
+                    Number of data plane proxies connected to the zone control
+                    plane
+                  type: integer
+                healthy:
+                  description: >-
+                    Number of data plane proxies with all healthy inbounds
+                    selected by this MeshService.
+                  type: integer
+                total:
+                  description: Total number of data plane proxies.
+                  type: integer
+              type: object
             hostnameGenerators:
               items:
                 properties:

diff --git a/docs/generated/raw/crds/kuma.io_meshservices.yaml b/docs/generated/raw/crds/kuma.io_meshservices.yaml
@@ -91,6 +91,14 @@ spec:
                       type: string
                     type: object
                 type: object
+              state:
+                description: |-
+                  State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable.
+                  It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService.
+                enum:
+                - Available
+                - Unavailable
+                type: string
             type: object
           status:
             description: Status is the current status of the Kuma MeshService resource.
@@ -111,6 +119,21 @@ spec:
                       type: string
                   type: object
                 type: array
+              dataplaneProxies:
+                description: Data plane proxies statistics selected by this MeshService.
+                properties:
+                  connected:
+                    description: Number of data plane proxies connected to the zone
+                      control plane
+                    type: integer
+                  healthy:
+                    description: Number of data plane proxies with all healthy inbounds
+                      selected by this MeshService.
+                    type: integer
+                  total:
+                    description: Total number of data plane proxies.
+                    type: integer
+                type: object
               hostnameGenerators:
                 items:
                   properties:

diff --git a/pkg/api-server/testdata/resources/crud/list_meshservices.golden.json b/pkg/api-server/testdata/resources/crud/list_meshservices.golden.json
@@ -27,7 +27,8 @@
       "ip": "10.0.0.1"
      }
     ],
-    "tls": {}
+    "tls": {},
+    "dataplaneProxies": {}
    }
   },
   {
@@ -56,7 +57,8 @@
       "ip": "10.0.0.2"
      }
     ],
-    "tls": {}
+    "tls": {},
+    "dataplaneProxies": {}
    }
   }
  ],

diff --git a/pkg/api-server/testdata/resources/crud/put_meshservice_01.golden.json b/pkg/api-server/testdata/resources/crud/put_meshservice_01.golden.json
@@ -9,6 +9,7 @@
   "kuma.io/zone": "default"
  },
  "spec": {
+  "state": "Unavailable",
   "selector": {
    "dataplaneTags": {
     "app": "redis"
@@ -27,6 +28,7 @@
     "ip": "10.0.0.1"
    }
   ],
-  "tls": {}
+  "tls": {},
+  "dataplaneProxies": {}
  }
 }
diff --git a/pkg/core/resources/apis/meshservice/api/v1alpha1/helpers.go b/pkg/core/resources/apis/meshservice/api/v1alpha1/helpers.go
@@ -70,3 +70,10 @@ func (t *MeshServiceResource) SNIName(systemNamespace string) string {
 	}
 	return t.GetMeta().GetName()
 }
+
+func (t *MeshServiceResource) Default() error {
+	if t.Spec.State == "" {
+		t.Spec.State = StateUnavailable
+	}
+	return nil
+}
diff --git a/pkg/core/resources/apis/meshservice/api/v1alpha1/meshservice.go b/pkg/core/resources/apis/meshservice/api/v1alpha1/meshservice.go
@@ -34,6 +34,9 @@ const maxNameLength = 63
 // +kuma:policy:has_status=true
 // +kuma:policy:kds_flags=model.ZoneToGlobalFlag | model.GlobalToAllButOriginalZoneFlag
 type MeshService struct {
+	// State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable.
+	// It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService.
+	State    State    `json:"state,omitempty"`
 	Selector Selector `json:"selector,omitempty"`
 	// +patchMergeKey=port
 	// +patchStrategy=merge
@@ -48,6 +51,14 @@ type VIP struct {
 	IP string `json:"ip,omitempty"`
 }
 
+// +kubebuilder:validation:Enum=Available;Unavailable
+type State string
+
+const (
+	StateAvailable   State = "Available"
+	StateUnavailable State = "Unavailable"
+)
+
 // +kubebuilder:validation:Enum=Ready;NotReady
 type TLSStatus string
 
@@ -65,6 +76,8 @@ type MeshServiceStatus struct {
 	VIPs               []VIP                                           `json:"vips,omitempty"`
 	TLS                TLS                                             `json:"tls,omitempty"`
 	HostnameGenerators []hostnamegenerator_api.HostnameGeneratorStatus `json:"hostnameGenerators,omitempty"`
+	// Data plane proxies statistics selected by this MeshService.
+	DataplaneProxies DataplaneProxies `json:"dataplaneProxies,omitempty"`
 }
 
 // +kubebuilder:validation:Enum=ServiceTag
@@ -78,3 +91,12 @@ type MeshServiceIdentity struct {
 	Type  MeshServiceIdentityType `json:"type"`
 	Value string                  `json:"value"`
 }
+
+type DataplaneProxies struct {
+	// Number of data plane proxies connected to the zone control plane
+	Connected int `json:"connected,omitempty"`
+	// Number of data plane proxies with all healthy inbounds selected by this MeshService.
+	Healthy int `json:"healthy,omitempty"`
+	// Total number of data plane proxies.
+	Total int `json:"total,omitempty"`
+}
diff --git a/pkg/core/resources/apis/meshservice/api/v1alpha1/schema.yaml b/pkg/core/resources/apis/meshservice/api/v1alpha1/schema.yaml
@@ -72,6 +72,14 @@ properties:
               type: string
             type: object
         type: object
+      state:
+        description: |-
+          State of MeshService. Available if there is at least one healthy endpoint. Otherwise, Unavailable.
+          It's used for cross zone communication to check if we should send traffic to it, when MeshService is aggregated into MeshMultiZoneService.
+        enum:
+          - Available
+          - Unavailable
+        type: string
     type: object
   status:
     description: Status is the current status of the Kuma MeshService resource.
@@ -92,6 +100,19 @@ properties:
               type: string
           type: object
         type: array
+      dataplaneProxies:
+        description: Data plane proxies statistics selected by this MeshService.
+        properties:
+          connected:
+            description: Number of data plane proxies connected to the zone control plane
+            type: integer
+          healthy:
+            description: Number of data plane proxies with all healthy inbounds selected by this MeshService.
+            type: integer
+          total:
+            description: Total number of data plane proxies.
+            type: integer
+        type: object
       hostnameGenerators:
         items:
           properties: