update API and code

Signed-off-by: zirain <zirain2009@gmail.com>

Author: zirain

api/v1alpha1/envoypatchpolicy_types.go

@@ -82,7 +82,9 @@ const (
 type EnvoyJSONPatchConfig struct {
 	// Type is the typed URL of the Envoy xDS Resource
 	Type EnvoyResourceType `json:"type"`
-	// Name is the name of the resource
+	// Name is the name of the resource.
+	// When omitted or set to empty string (""), the patch will be applied to all resources of the specified Type.
+	// When specified, the patch will only be applied to the resource with the matching name.
 	Name string `json:"name"`
 	// Patch defines the JSON Patch Operation
 	Operation JSONPatchOperation `json:"operation"`

charts/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_envoypatchpolicies.yaml

@@ -64,7 +64,10 @@ spec:
                     using JSONPatch semantic
                   properties:
                     name:
-                      description: Name is the name of the resource
+                      description: |-
+                        Name is the name of the resource.
+                        When omitted or set to empty string (""), the patch will be applied to all resources of the specified Type.
+                        When specified, the patch will only be applied to the resource with the matching name.
                       type: string
                     operation:
                       description: Patch defines the JSON Patch Operation

charts/gateway-helm/charts/crds/crds/generated/gateway.envoyproxy.io_envoypatchpolicies.yaml

@@ -63,7 +63,10 @@ spec:
                     using JSONPatch semantic
                   properties:
                     name:
-                      description: Name is the name of the resource
+                      description: |-
+                        Name is the name of the resource.
+                        When omitted or set to empty string (""), the patch will be applied to all resources of the specified Type.
+                        When specified, the patch will only be applied to the resource with the matching name.
                       type: string
                     operation:
                       description: Patch defines the JSON Patch Operation

internal/ir/xds.go

@@ -2671,7 +2671,8 @@ type EnvoyPatchPolicyStatus struct {
 type JSONPatchConfig struct {
 	// Type is the typed URL of the Envoy xDS Resource
 	Type string `json:"type" yaml:"type"`
-	// Name is the name of the resource
+	// Name is the name of the resource.
+	// When empty, the patch will be applied to all resources of the specified Type.
 	Name string `json:"name" yaml:"name"`
 	// Patch defines the JSON Patch Operation
 	Operation JSONPatchOperation `json:"operation" yaml:"operation"`

internal/xds/translator/jsonpatch.go

@@ -95,7 +95,7 @@ func processJSONPatches(tCtx *types.ResourceVersionTable, envoyPatchPolicies []*
 				continue
 			}
 
-			// find the resources to patch and convert it to JSON
+			// find the resources to patch and convert them to JSON
 			dests, err = findXdsResources(tCtx, p)
 			if err != nil {
 				tErrs = errors.Join(tErrs, err)
@@ -108,8 +108,8 @@ func processJSONPatches(tCtx *types.ResourceVersionTable, envoyPatchPolicies []*
 				continue
 			}
 
-			var destsError error
-			var destsPatched bool
+			var patchErrors error
+			var anyPatched bool
 			for _, dest := range dests {
 				var (
 					resourceJSON []byte
@@ -119,13 +119,13 @@ func processJSONPatches(tCtx *types.ResourceVersionTable, envoyPatchPolicies []*
 				resourceJSON, err = jsonMarshalOpts.Marshal(dest)
 				if err != nil {
 					tErr := fmt.Errorf("unable to marshal xds resource %s, err: %w", p.Type, err)
-					destsError = errors.Join(destsError, tErr)
+					patchErrors = errors.Join(patchErrors, tErr)
 					continue
 				}
 
 				modifiedJSON, err = jsonpatch.ApplyJSONPatches(resourceJSON, p.Operation)
 				if err != nil {
-					destsError = errors.Join(destsError, err)
+					patchErrors = errors.Join(patchErrors, err)
 					continue
 				}
 
@@ -134,13 +134,13 @@ func processJSONPatches(tCtx *types.ResourceVersionTable, envoyPatchPolicies []*
 				// into and validated before saving it into the xds output resource
 				temp, err := getXdsResourceType(p.Type)
 				if err != nil {
-					destsError = errors.Join(destsError, err)
+					patchErrors = errors.Join(patchErrors, err)
 					continue
 				}
 
 				if err = protojson.Unmarshal(modifiedJSON, temp); err != nil {
 					tErr := errors.New(unmarshalErrorMessage(err, string(modifiedJSON)))
-					destsError = errors.Join(destsError, tErr)
+					patchErrors = errors.Join(patchErrors, tErr)
 					continue
 				}
 
@@ -149,26 +149,26 @@ func processJSONPatches(tCtx *types.ResourceVersionTable, envoyPatchPolicies []*
 				if ok {
 					if err = validator.Validate(); err != nil {
 						tErr := fmt.Errorf("validation failed for xds resource %s, err:%s", p.Type, err.Error())
-						destsError = errors.Join(destsError, tErr)
+						patchErrors = errors.Join(patchErrors, tErr)
 						continue
 					}
 				}
 
 				if err = deepCopyPtr(temp, dest); err != nil {
 					tErr := fmt.Errorf("unable to copy xds resource %s, err: %w", p.Type, err)
-					destsError = errors.Join(destsError, tErr)
+					patchErrors = errors.Join(patchErrors, tErr)
 					continue
 				}
 
 				// Mark that at least one dest has been patched successfully,
 				// so that we can report partial success if there are multiple dests and some of them fail
-				destsPatched = true
+				anyPatched = true
 			}
 
 			// If there are multiple dests and some of them fail,
 			// consider it as successful and ignore the failures to patch other dests.
-			if !destsPatched && destsError != nil {
-				tErrs = errors.Join(tErrs, destsError)
+			if !anyPatched && patchErrors != nil {
+				tErrs = errors.Join(tErrs, patchErrors)
 			}
 		}
 
@@ -214,6 +214,9 @@ var jsonMarshalOpts = protojson.MarshalOptions{
 	UseProtoNames: true,
 }
 
+// findXdsResources returns XDS resources to patch based on the patch configuration.
+// If p.Name is empty, all resources of the specified type are returned.
+// If p.Name is specified, only resources with matching names are returned.
 func findXdsResources(tCtx *types.ResourceVersionTable, p *ir.JSONPatchConfig) ([]cachetypes.Resource, error) {
 	var resources []cachetypes.Resource
 	switch p.Type {

internal/xds/translator/translator.go

@@ -996,7 +996,9 @@ func findXdsListenerByHostPort(tCtx *types.ResourceVersionTable, address string,
 	return nil
 }
 
-// findXdsListeners finds a xds listener with the same name and returns nil if there is no match.
+// findXdsListeners finds xds listeners.
+// If name is empty, returns all listeners.
+// If name is specified, returns only listeners with matching names.
 func findXdsListeners(tCtx *types.ResourceVersionTable, name string) []cachetypes.Resource {
 	if tCtx == nil || tCtx.XdsResources == nil || tCtx.XdsResources[resourcev3.ListenerType] == nil {
 		return nil
@@ -1008,7 +1010,7 @@ func findXdsListeners(tCtx *types.ResourceVersionTable, name string) []cachetype
 		if !ok {
 			continue
 		}
-		if name == "" || (listener != nil && listener.Name == name) {
+		if name == "" || listener.Name == name {
 			result = append(result, r)
 		}
 	}
@@ -1025,7 +1027,9 @@ func findXdsRouteConfig(tCtx *types.ResourceVersionTable, name string) *routev3.
 	return nil
 }
 
-// findXdsRouteConfigs finds a xds route with the name and returns nil if there is no match.
+// findXdsRouteConfigs finds xds route configurations.
+// If name is empty, returns all route configurations.
+// If name is specified, returns only route configurations with matching names.
 func findXdsRouteConfigs(tCtx *types.ResourceVersionTable, name string) []cachetypes.Resource {
 	if tCtx == nil || tCtx.XdsResources == nil || tCtx.XdsResources[resourcev3.RouteType] == nil {
 		return nil
@@ -1037,7 +1041,7 @@ func findXdsRouteConfigs(tCtx *types.ResourceVersionTable, name string) []cachet
 		if !ok {
 			continue
 		}
-		if name == "" || (route != nil && route.Name == name) {
+		if name == "" || route.Name == name {
 			result = append(result, r)
 		}
 	}
@@ -1054,7 +1058,9 @@ func findXdsCluster(tCtx *types.ResourceVersionTable, name string) *clusterv3.Cl
 	return nil
 }
 
-// findXdsClusters finds a xds cluster with the same name, and returns nil if there is no match.
+// findXdsClusters finds xds clusters.
+// If name is empty, returns all clusters.
+// If name is specified, returns only clusters with matching names.
 func findXdsClusters(tCtx *types.ResourceVersionTable, name string) []cachetypes.Resource {
 	if tCtx == nil || tCtx.XdsResources == nil || tCtx.XdsResources[resourcev3.ClusterType] == nil {
 		return nil
@@ -1066,15 +1072,17 @@ func findXdsClusters(tCtx *types.ResourceVersionTable, name string) []cachetypes
 		if !ok {
 			continue
 		}
-		if name == "" || (cluster != nil && cluster.Name == name) {
+		if name == "" || cluster.Name == name {
 			result = append(result, r)
 		}
 	}
 
 	return result
 }
 
-// findXdsEndpoints finds a xds endpoint with the same cluster name, and returns nil if there is no match.
+// findXdsEndpoints finds xds endpoints.
+// If name is empty, returns all endpoints.
+// If name is specified, returns only endpoints with matching cluster names.
 func findXdsEndpoints(tCtx *types.ResourceVersionTable, name string) []cachetypes.Resource {
 	if tCtx == nil || tCtx.XdsResources == nil || tCtx.XdsResources[resourcev3.EndpointType] == nil {
 		return nil
@@ -1086,7 +1094,7 @@ func findXdsEndpoints(tCtx *types.ResourceVersionTable, name string) []cachetype
 		if !ok {
 			continue
 		}
-		if name == "" || (endpoint != nil && endpoint.ClusterName == name) {
+		if name == "" || endpoint.ClusterName == name {
 			result = append(result, r)
 		}
 	}
@@ -1103,7 +1111,9 @@ func findXdsSecret(tCtx *types.ResourceVersionTable, name string) *tlsv3.Secret
 	return nil
 }
 
-// findXdsSecrets finds a xds secret with the same name, and returns nil if there is no match.
+// findXdsSecrets finds xds secrets.
+// If name is empty, returns all secrets.
+// If name is specified, returns only secrets with matching names.
 func findXdsSecrets(tCtx *types.ResourceVersionTable, name string) []cachetypes.Resource {
 	if tCtx == nil || tCtx.XdsResources == nil || tCtx.XdsResources[resourcev3.SecretType] == nil {
 		return nil
@@ -1115,7 +1125,7 @@ func findXdsSecrets(tCtx *types.ResourceVersionTable, name string) []cachetypes.
 		if !ok {
 			continue
 		}
-		if name == "" || (secret != nil && secret.Name == name) {
+		if name == "" || secret.Name == name {
 			result = append(result, r)
 		}
 	}

release-notes/current.yaml

@@ -38,6 +38,7 @@ new features: |
   Added support for retry budget in BackendTrafficPolicy.
   Added support for BackendUtilization load balancing policy in BackendTrafficPolicy.
   Added support for upstrean access log.
+  Added support for patching multiple resources with empty name in EnvoyExtensionPolicy.
 
 bug fixes: |
   Rejected ClientTrafficPolicy if invalid TLS cipher suites are configured.

site/content/en/latest/api/extension_types.md

@@ -1839,7 +1839,7 @@ _Appears in:_
 | Field | Type | Required | Default | Description |
 | ---   | ---  | ---      | ---     | ---         |
 | `type` | _[EnvoyResourceType](#envoyresourcetype)_ |  true  |  | Type is the typed URL of the Envoy xDS Resource |
-| `name` | _string_ |  true  |  | Name is the name of the resource |
+| `name` | _string_ |  true  |  | Name is the name of the resource.<br />When omitted or set to empty string (""), the patch will be applied to all resources of the specified Type.<br />When specified, the patch will only be applied to the resource with the matching name. |
 | `operation` | _[JSONPatchOperation](#jsonpatchoperation)_ |  true  |  | Patch defines the JSON Patch Operation |
 
 

test/helm/gateway-crds-helm/all.out.yaml

@@ -30251,7 +30251,10 @@ spec:
                     using JSONPatch semantic
                   properties:
                     name:
-                      description: Name is the name of the resource
+                      description: |-
+                        Name is the name of the resource.
+                        When omitted or set to empty string (""), the patch will be applied to all resources of the specified Type.
+                        When specified, the patch will only be applied to the resource with the matching name.
                       type: string
                     operation:
                       description: Patch defines the JSON Patch Operation

test/helm/gateway-crds-helm/e2e.out.yaml

@@ -8224,7 +8224,10 @@ spec:
                     using JSONPatch semantic
                   properties:
                     name:
-                      description: Name is the name of the resource
+                      description: |-
+                        Name is the name of the resource.
+                        When omitted or set to empty string (""), the patch will be applied to all resources of the specified Type.
+                        When specified, the patch will only be applied to the resource with the matching name.
                       type: string
                     operation:
                       description: Patch defines the JSON Patch Operation