fix endpoint cannot retrieve bug. (envoyproxy#1148)

Signed-off-by: qicz <[email protected]>
arkodg · Mar 16, 2023 · 73e38e0 · 73e38e0
1 parent 289c18c
commit 73e38e0
Show file tree

Hide file tree

Showing 7 changed files with 175 additions and 20 deletions.
diff --git a/internal/cmd/egctl/config.go b/internal/cmd/egctl/config.go
@@ -93,7 +93,7 @@ func allConfigCmd() *cobra.Command {
 }
 
 func runAllConfig(c *cobra.Command, args []string) error {
-	configDump, err := retrieveConfigDump(args)
+	configDump, err := retrieveConfigDump(args, true)
 	if err != nil {
 		return err
 	}
@@ -108,7 +108,6 @@ func runAllConfig(c *cobra.Command, args []string) error {
 }
 
 func bootstrapConfigCmd() *cobra.Command {
-
 	configCmd := &cobra.Command{
 		Use:     "bootstrap <pod-name>",
 		Aliases: []string{"b"},
@@ -132,7 +131,7 @@ func bootstrapConfigCmd() *cobra.Command {
 }
 
 func runBootstrapConfig(c *cobra.Command, args []string) error {
-	configDump, err := retrieveConfigDump(args)
+	configDump, err := retrieveConfigDump(args, false)
 	if err != nil {
 		return err
 	}
@@ -152,7 +151,6 @@ func runBootstrapConfig(c *cobra.Command, args []string) error {
 }
 
 func clusterConfigCmd() *cobra.Command {
-
 	configCmd := &cobra.Command{
 		Use:     "cluster <pod-name>",
 		Short:   "Retrieves cluster Envoy xDS resources from the specified pod",
@@ -176,7 +174,7 @@ func clusterConfigCmd() *cobra.Command {
 }
 
 func runClusterConfig(c *cobra.Command, args []string) error {
-	configDump, err := retrieveConfigDump(args)
+	configDump, err := retrieveConfigDump(args, false)
 	if err != nil {
 		return err
 	}
@@ -196,7 +194,6 @@ func runClusterConfig(c *cobra.Command, args []string) error {
 }
 
 func endpointConfigCmd() *cobra.Command {
-
 	configCmd := &cobra.Command{
 		Use:     "endpoint <pod-name>",
 		Short:   "Retrieves endpoint Envoy xDS resources from the specified pod",
@@ -220,7 +217,7 @@ func endpointConfigCmd() *cobra.Command {
 }
 
 func runEndpointConfig(c *cobra.Command, args []string) error {
-	configDump, err := retrieveConfigDump(args)
+	configDump, err := retrieveConfigDump(args, true)
 	if err != nil {
 		return err
 	}
@@ -240,7 +237,6 @@ func runEndpointConfig(c *cobra.Command, args []string) error {
 }
 
 func listenerConfigCmd() *cobra.Command {
-
 	configCmd := &cobra.Command{
 		Use:     "listener <pod-name>",
 		Aliases: []string{"l"},
@@ -264,7 +260,7 @@ func listenerConfigCmd() *cobra.Command {
 }
 
 func runListenerConfig(c *cobra.Command, args []string) error {
-	configDump, err := retrieveConfigDump(args)
+	configDump, err := retrieveConfigDump(args, false)
 	if err != nil {
 		return err
 	}
@@ -284,7 +280,6 @@ func runListenerConfig(c *cobra.Command, args []string) error {
 }
 
 func routeConfigCmd() *cobra.Command {
-
 	configCmd := &cobra.Command{
 		Use:     "route <pod-name>",
 		Aliases: []string{"r"},
@@ -308,7 +303,7 @@ func routeConfigCmd() *cobra.Command {
 }
 
 func runRouteConfig(c *cobra.Command, args []string) error {
-	configDump, err := retrieveConfigDump(args)
+	configDump, err := retrieveConfigDump(args, false)
 	if err != nil {
 		return err
 	}
@@ -327,7 +322,7 @@ func runRouteConfig(c *cobra.Command, args []string) error {
 	return err
 }
 
-func retrieveConfigDump(args []string) (*adminv3.ConfigDump, error) {
+func retrieveConfigDump(args []string, includeEds bool) (*adminv3.ConfigDump, error) {
 	if len(args) == 0 {
 		return nil, fmt.Errorf("pod name is required")
 	}
@@ -354,7 +349,7 @@ func retrieveConfigDump(args []string) (*adminv3.ConfigDump, error) {
 	}
 	defer fw.Stop()
 
-	configDump, err := extractConfigDump(fw)
+	configDump, err := extractConfigDump(fw, includeEds)
 	if err != nil {
 		return nil, err
 	}
@@ -385,7 +380,6 @@ func portForwarder(nn types.NamespacedName) (kube.PortForwarder, error) {
 }
 
 func marshalEnvoyProxyConfig(configDump protoreflect.ProtoMessage, output string) ([]byte, error) {
-
 	out, err := protojson.MarshalOptions{
 		Multiline: true,
 	}.Marshal(configDump)
@@ -403,8 +397,8 @@ func marshalEnvoyProxyConfig(configDump protoreflect.ProtoMessage, output string
 	return out, nil
 }
 
-func extractConfigDump(fw kube.PortForwarder) (*adminv3.ConfigDump, error) {
-	out, err := configDumpRequest(fw.Address())
+func extractConfigDump(fw kube.PortForwarder, includeEds bool) (*adminv3.ConfigDump, error) {
+	out, err := configDumpRequest(fw.Address(), includeEds)
 	if err != nil {
 		return nil, err
 	}
@@ -417,8 +411,12 @@ func extractConfigDump(fw kube.PortForwarder) (*adminv3.ConfigDump, error) {
 	return configDump, nil
 }
 
-func configDumpRequest(address string) ([]byte, error) {
-	req, err := http.NewRequest("GET", fmt.Sprintf("http://%s/config_dump", address), nil)
+func configDumpRequest(address string, includeEds bool) ([]byte, error) {
+	url := fmt.Sprintf("http://%s/config_dump", address)
+	if includeEds {
+		url = fmt.Sprintf("%s?include_eds", url)
+	}
+	req, err := http.NewRequest("GET", url, nil)
 	if err != nil {
 		return nil, err
 	}

diff --git a/internal/cmd/egctl/config_test.go b/internal/cmd/egctl/config_test.go
@@ -95,7 +95,7 @@ func TestExtractAllConfigDump(t *testing.T) {
 
 	for _, tc := range cases {
 		t.Run(tc.output, func(t *testing.T) {
-			configDump, err := extractConfigDump(fw)
+			configDump, err := extractConfigDump(fw, true)
 			assert.NoError(t, err)
 			got, err := marshalEnvoyProxyConfig(configDump, tc.output)
 			assert.NoError(t, err)
@@ -162,11 +162,21 @@ func TestExtractSubResourcesConfigDump(t *testing.T) {
 			resourceType: RouteEnvoyConfigType,
 			expected:     "out.route.yaml",
 		},
+		{
+			output:       "json",
+			resourceType: EndpointEnvoyConfigType,
+			expected:     "out.endpoints.json",
+		},
+		{
+			output:       "yaml",
+			resourceType: EndpointEnvoyConfigType,
+			expected:     "out.endpoints.yaml",
+		},
 	}
 
 	for _, tc := range cases {
 		t.Run(tc.output, func(t *testing.T) {
-			configDump, err := extractConfigDump(fw)
+			configDump, err := extractConfigDump(fw, false)
 			assert.NoError(t, err)
 			resource, err := findXDSResourceFromConfigDump(tc.resourceType, configDump)
 			assert.NoError(t, err)

diff --git a/internal/cmd/egctl/testdata/config/in/in.all.json b/internal/cmd/egctl/testdata/config/in/in.all.json
@@ -2271,6 +2271,42 @@
                     }
                 }
             ]
+        },
+        {
+            "@type":  "type.googleapis.com/envoy.admin.v3.EndpointsConfigDump",
+            "staticEndpointConfigs":  [
+                {
+                    "endpointConfig":  {
+                        "@type":  "type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment",
+                        "clusterName":  "xds_cluster",
+                        "endpoints":  [
+                            {
+                                "locality":  {},
+                                "lbEndpoints":  [
+                                    {
+                                        "endpoint":  {
+                                            "address":  {
+                                                "socketAddress":  {
+                                                    "address":  "10.106.37.54",
+                                                    "portValue":  18000
+                                                }
+                                            },
+                                            "healthCheckConfig":  {},
+                                            "hostname":  "envoy-gateway"
+                                        },
+                                        "healthStatus":  "HEALTHY",
+                                        "metadata":  {},
+                                        "loadBalancingWeight":  1
+                                    }
+                                ]
+                            }
+                        ],
+                        "policy":  {
+                            "overprovisioningFactor":  140
+                        }
+                    }
+                }
+            ]
         }
     ]
 }
diff --git a/internal/cmd/egctl/testdata/config/out/out.all.json b/internal/cmd/egctl/testdata/config/out/out.all.json
@@ -1470,5 +1470,40 @@
 				}
 			}
 		}]
+	}, {
+		"@type":  "type.googleapis.com/envoy.admin.v3.EndpointsConfigDump",
+		"staticEndpointConfigs":  [
+			{
+				"endpointConfig":  {
+					"@type":  "type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment",
+					"clusterName":  "xds_cluster",
+					"endpoints":  [
+						{
+							"locality":  {},
+							"lbEndpoints":  [
+								{
+									"endpoint":  {
+										"address":  {
+											"socketAddress":  {
+												"address":  "10.106.37.54",
+												"portValue":  18000
+											}
+										},
+										"healthCheckConfig":  {},
+										"hostname":  "envoy-gateway"
+									},
+									"healthStatus":  "HEALTHY",
+									"metadata":  {},
+									"loadBalancingWeight":  1
+								}
+							]
+						}
+					],
+					"policy":  {
+						"overprovisioningFactor":  140
+					}
+				}
+			}
+		]
 	}]
 }
diff --git a/internal/cmd/egctl/testdata/config/out/out.all.yaml b/internal/cmd/egctl/testdata/config/out/out.all.yaml
@@ -1282,3 +1282,23 @@ configs:
           sanType: DNS
         trustedCa:
           inlineBytes: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURHRENDQWdDZ0F3SUJBZ0lFSWFxd1VUQU5CZ2txaGtpRzl3MEJBUXNGQURBc01SWXdGQVlEVlFRREV3MWwKYm5admVTMW5ZWFJsZDJGNU1SSXdFQVlEVlFRRkV3azFOalE0TXpRek9EVXdIaGNOTWpNd01qRTNNRE0wTVRJNApXaGNOTWpRd01qRTRNRE0wTVRJNFdqQXNNUll3RkFZRFZRUURFdzFsYm5admVTMW5ZWFJsZDJGNU1SSXdFQVlEClZRUUZFd2sxTmpRNE16UXpPRFV3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRRDIKeFMrNkRWY2FvbHFkVVBzTHZwNUtQMEQyV0hrTkVEY0tPeml3bzZNYm9wczFLYWJnNXVYSVl5T21JRWNTTXNKNwpHbVAxMlJjK0J3V1dFWXRrTHVPU3BwQm1lSjN3aDRrUlVRVTRTemRFU1dDcU40RTNpcTJib3FFVm53SkFGQ1ZpCldldGVjZkZsODZFalliQUxxSnRCbGJCbFFQM1ZMZ1hva0VVamJ4QmFobE1wZitUWkVJNFBuam1zUWN5a21LeXIKaDJwdmM3cnZYb29HTlhTM0Q0eFc1VDY3dmxLYi94UlM3c2gwTkJEU0dtTE1jY2pxWFZXazVOR2lBWVB3dXBWSwpTWG02dnZXUFZCdEd1bkZhS0JSRGx4TlJrb0wzRUN6UkNtenoxR2ZYMGJkSm1leElOM2VIUFBRdkd0M0txeUlnCkgrYnc0OXpqdlVUb2dNcXFpTlcvQWdNQkFBR2pRakJBTUE0R0ExVWREd0VCL3dRRUF3SUNwREFQQmdOVkhSTUIKQWY4RUJUQURBUUgvTUIwR0ExVWREZ1FXQkJRVHN2L0l0Y2t0UkpZdXlqUGg5c3J3OXp5TkpqQU5CZ2txaGtpRwo5dzBCQVFzRkFBT0NBUUVBd2dvZEsxalhVWFZDVXBTSjE0cEo3S3ZobWZPT1hkaVNISmNSSzlIUzI1c2xwOWN2CkJDSndmWUZmanJ4Rmc5TnV4aVpiM01oVXk5MDBqenBPdk1QWStEeUxFWFVxTGd5ZlBMUzYveVliem8yZHdwdzMKOCtrTXlsQUFlZmtaSW9oT0VhYSsvNFFBVVVGZVp1a1B6bmF6RzZIWnZKQkNxWVdRNXBaSSt3WTI1dzhEU0VOMgpkOCswVkpzWU5IdUk4aXhneGZhUkRycW5LRHBMUGJ3Z3VaRDl6ZkV3dVFaNG1oeEd0Vk1wR0NLSndscWFhdXJ0CkF5aGhzOXBHNERndkpSY1BLeFY4bndRdzZtSm55dkIxcExxTW1aQTVqZWhxbFNvUGVpWUlBMk1neU83cTVPYmMKL040bzBNTVdvZ1piRWR6aTBnTXJRT2lpNE41Q0ZlakVrYStIMmc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+- '@type': type.googleapis.com/envoy.admin.v3.EndpointsConfigDump
+  staticEndpointConfigs:
+  - endpointConfig:
+      '@type': type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment
+      clusterName: xds_cluster
+      endpoints:
+      - lbEndpoints:
+        - endpoint:
+            address:
+              socketAddress:
+                address: 10.106.37.54
+                portValue: 18000
+            healthCheckConfig: {}
+            hostname: envoy-gateway
+          healthStatus: HEALTHY
+          loadBalancingWeight: 1
+          metadata: {}
+        locality: {}
+      policy:
+        overprovisioningFactor: 140
diff --git a/internal/cmd/egctl/testdata/config/out/out.endpoints.json b/internal/cmd/egctl/testdata/config/out/out.endpoints.json
@@ -0,0 +1,36 @@
+{
+  "@type":  "type.googleapis.com/envoy.admin.v3.EndpointsConfigDump",
+  "staticEndpointConfigs":  [
+    {
+      "endpointConfig":  {
+        "@type":  "type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment",
+        "clusterName":  "xds_cluster",
+        "endpoints":  [
+          {
+            "locality":  {},
+            "lbEndpoints":  [
+              {
+                "endpoint":  {
+                  "address":  {
+                    "socketAddress":  {
+                      "address":  "10.106.37.54",
+                      "portValue":  18000
+                    }
+                  },
+                  "healthCheckConfig":  {},
+                  "hostname":  "envoy-gateway"
+                },
+                "healthStatus":  "HEALTHY",
+                "metadata":  {},
+                "loadBalancingWeight":  1
+              }
+            ]
+          }
+        ],
+        "policy":  {
+          "overprovisioningFactor":  140
+        }
+      }
+    }
+  ]
+}
diff --git a/internal/cmd/egctl/testdata/config/out/out.endpoints.yaml b/internal/cmd/egctl/testdata/config/out/out.endpoints.yaml
@@ -0,0 +1,20 @@
+'@type': type.googleapis.com/envoy.admin.v3.EndpointsConfigDump
+staticEndpointConfigs:
+- endpointConfig:
+    '@type': type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment
+    clusterName: xds_cluster
+    endpoints:
+    - lbEndpoints:
+      - endpoint:
+          address:
+            socketAddress:
+              address: 10.106.37.54
+              portValue: 18000
+          healthCheckConfig: {}
+          hostname: envoy-gateway
+        healthStatus: HEALTHY
+        loadBalancingWeight: 1
+        metadata: {}
+      locality: {}
+    policy:
+      overprovisioningFactor: 140