chore: add comments to Resources

envoyproxy · Jun 7, 2024 · b1125c1 · b1125c1
1 parent c0edb05
commit b1125c1
Showing 1 changed file with 20 additions and 16 deletions.
diff --git a/internal/gatewayapi/resource.go b/internal/gatewayapi/resource.go
@@ -34,22 +34,26 @@ type (
 type Resources struct {
 	// This field is only used for marshalling/unmarshalling purposes and is not used by
 	// the translator
-	GatewayClass            *gwapiv1.GatewayClass          `json:"gatewayClass,omitempty" yaml:"gatewayClass,omitempty"`
-	Gateways                []*gwapiv1.Gateway             `json:"gateways,omitempty" yaml:"gateways,omitempty"`
-	HTTPRoutes              []*gwapiv1.HTTPRoute           `json:"httpRoutes,omitempty" yaml:"httpRoutes,omitempty"`
-	GRPCRoutes              []*gwapiv1.GRPCRoute           `json:"grpcRoutes,omitempty" yaml:"grpcRoutes,omitempty"`
-	TLSRoutes               []*gwapiv1a2.TLSRoute          `json:"tlsRoutes,omitempty" yaml:"tlsRoutes,omitempty"`
-	TCPRoutes               []*gwapiv1a2.TCPRoute          `json:"tcpRoutes,omitempty" yaml:"tcpRoutes,omitempty"`
-	UDPRoutes               []*gwapiv1a2.UDPRoute          `json:"udpRoutes,omitempty" yaml:"udpRoutes,omitempty"`
-	ReferenceGrants         []*gwapiv1b1.ReferenceGrant    `json:"referenceGrants,omitempty" yaml:"referenceGrants,omitempty"`
-	Namespaces              []*v1.Namespace                `json:"namespaces,omitempty" yaml:"namespaces,omitempty"`
-	Services                []*v1.Service                  `json:"services,omitempty" yaml:"services,omitempty"`
-	ServiceImports          []*mcsapi.ServiceImport        `json:"serviceImports,omitempty" yaml:"serviceImports,omitempty"`
-	EndpointSlices          []*discoveryv1.EndpointSlice   `json:"endpointSlices,omitempty" yaml:"endpointSlices,omitempty"`
-	Secrets                 []*v1.Secret                   `json:"secrets,omitempty" yaml:"secrets,omitempty"`
-	ConfigMaps              []*v1.ConfigMap                `json:"configMaps,omitempty" yaml:"configMaps,omitempty"`
-	ClassEnvoyProxy         *egv1a1.EnvoyProxy             `json:"classEnvoyProxy,omitempty" yaml:"classEnvoyProxy,omitempty"`
-	EnvoyProxies            []*egv1a1.EnvoyProxy           `json:"EnvoyProxies,omitempty" yaml:"EnvoyProxies,omitempty"`
+	GatewayClass    *gwapiv1.GatewayClass        `json:"gatewayClass,omitempty" yaml:"gatewayClass,omitempty"`
+	Gateways        []*gwapiv1.Gateway           `json:"gateways,omitempty" yaml:"gateways,omitempty"`
+	HTTPRoutes      []*gwapiv1.HTTPRoute         `json:"httpRoutes,omitempty" yaml:"httpRoutes,omitempty"`
+	GRPCRoutes      []*gwapiv1.GRPCRoute         `json:"grpcRoutes,omitempty" yaml:"grpcRoutes,omitempty"`
+	TLSRoutes       []*gwapiv1a2.TLSRoute        `json:"tlsRoutes,omitempty" yaml:"tlsRoutes,omitempty"`
+	TCPRoutes       []*gwapiv1a2.TCPRoute        `json:"tcpRoutes,omitempty" yaml:"tcpRoutes,omitempty"`
+	UDPRoutes       []*gwapiv1a2.UDPRoute        `json:"udpRoutes,omitempty" yaml:"udpRoutes,omitempty"`
+	ReferenceGrants []*gwapiv1b1.ReferenceGrant  `json:"referenceGrants,omitempty" yaml:"referenceGrants,omitempty"`
+	Namespaces      []*v1.Namespace              `json:"namespaces,omitempty" yaml:"namespaces,omitempty"`
+	Services        []*v1.Service                `json:"services,omitempty" yaml:"services,omitempty"`
+	ServiceImports  []*mcsapi.ServiceImport      `json:"serviceImports,omitempty" yaml:"serviceImports,omitempty"`
+	EndpointSlices  []*discoveryv1.EndpointSlice `json:"endpointSlices,omitempty" yaml:"endpointSlices,omitempty"`
+	Secrets         []*v1.Secret                 `json:"secrets,omitempty" yaml:"secrets,omitempty"`
+	ConfigMaps      []*v1.ConfigMap              `json:"configMaps,omitempty" yaml:"configMaps,omitempty"`
+
+	// ClassEnvoyProxy holds EnvoyProxy attached to GatewayClass
+	ClassEnvoyProxy *egv1a1.EnvoyProxy `json:"classEnvoyProxy,omitempty" yaml:"classEnvoyProxy,omitempty"`
+	// EnvoyProxies holds EnvoyProxies attached to Gateways
+	EnvoyProxies []*egv1a1.EnvoyProxy `json:"EnvoyProxies,omitempty" yaml:"EnvoyProxies,omitempty"`
+
 	ExtensionRefFilters     []unstructured.Unstructured    `json:"extensionRefFilters,omitempty" yaml:"extensionRefFilters,omitempty"`
 	EnvoyPatchPolicies      []*egv1a1.EnvoyPatchPolicy     `json:"envoyPatchPolicies,omitempty" yaml:"envoyPatchPolicies,omitempty"`
 	ClientTrafficPolicies   []*egv1a1.ClientTrafficPolicy  `json:"clientTrafficPolicies,omitempty" yaml:"clientTrafficPolicies,omitempty"`